MapInfo Spatial Server Architecture - Documentation - MapInfo

MapInfo Spatial Server 

Version 1.0 

User's Guide

© 2011 Pitney Bowes Software Inc. All rights reserved. MapInfo and Group 1 Software are trademarks of Pitney 

Bowes Software Inc. All other marks and trademarks are property of their respective holders. 

Pitney Bowes Inc. holds a non-exclusive license to publish and sell ZIP + 4 ® databases on optical and magnetic 

media. The following trademarks are owned by the United States Postal Service: CASS, CASS Certified, DPV, 

eLOT, FASTforward, First-Class Mail, Intelligent Mail, LACS Link , NCOA Link , PAVE, PLANET Code, Postal 

Service, POSTNET, Post Office, RDI, Suite Link , United States Postal Service, Standard Mail, United States 

Post Office, USPS, ZIP Code, and ZIP + 4. This list is not exhaustive of the trademarks belonging to the Postal 

Service. 

Pitney Bowes Inc. is a non-exclusive licensee of USPS ® for NCOA Link ® processing. 

Prices for Pitney Bowes Software's products, options, and services are not established, controlled, or approved 

by USPS ® or United States Government. When utilizing RDI data to determine parcel-shipping costs, the 

business decision on which parcel delivery company to use is not made by the USPS ® or United States Government. 

Centrus Data Products contained on this media and used within Centrus applications are protected by various 

trademarks and by one or more of the following copyrights: 

© Copyright United States Postal Service. All rights reserved. 

© 2007 Tele Atlas North America, Inc. All rights reserved. This material is proprietary and the subject of copyright 

protection and other intellectual property rights owned by or licensed to Tele Atlas North America, Inc. The use 

of this material is subject to the terms of a license agreement. You will be held liable for any unauthorized 

copying or disclosure of this material. 

© Copyright NAVTEQ. All rights reserved 

© Copyright United States Census Bureau 

© Copyright Nova Marketing Group, Inc. 

Portions of this program are © Copyright 1993-2007 by Nova Marketing Group Inc. All Rights Reserved 

© Copyright Canada Post Corporation 

This CD-ROM contains data from a compilation in which Canada Post Corporation is the copyright owner. 

© 2007 Claritas, Inc. 

Pitney Bowes Business Insight 

Documentation Team 

pbbidocs@pb.com 

September 13, 2011

Contents 

Part I:Introduction..........................................................................7 

Chapter 1:Introduction to MapInfo Spatial Server..............................................9 

What Is MapInfo Spatial Server?...................................................................................10 

MapInfo Spatial Server Architecture..............................................................................10 

Chapter 2:MapInfo Spatial Server Clients..........................................................15 

Connecting to the Managment Console.........................................................................16 

Introduction to Management Console............................................................................17 

Introduction to Enterprise Designer...............................................................................19 

Introduction to Interactive Driver....................................................................................26 

Part II:Designing Dataflows........................................................29 

Chapter 3:Jobs.....................................................................................................31 

What is a Job?...............................................................................................................32 

Sources..........................................................................................................................32 

Control Stages...............................................................................................................39 

Primary Stages...............................................................................................................79 

Sinks..............................................................................................................................80 

Runtime Options............................................................................................................87 

Reports...........................................................................................................................88 

Running a Job................................................................................................................90 

Chapter 4:Services...............................................................................................97 

What is a Service?.........................................................................................................98

4 

Sources..........................................................................................................................98 

Control Stages.............................................................................................................102 

Primary Stages.............................................................................................................142 

Sinks............................................................................................................................142 

Setting Web Service Options.......................................................................................151 

Runtime Options..........................................................................................................152 

Validating Services.......................................................................................................154 

Chapter 5:Subflows............................................................................................155 

What is a Subflow?......................................................................................................156 

Sources........................................................................................................................156 

Control Stages.............................................................................................................164 

Primary Stages.............................................................................................................205 

Sinks............................................................................................................................205 

Runtime Options..........................................................................................................214 

Validating a Dataflow....................................................................................................215 

Using Subflows............................................................................................................215 

Chapter 6:Process Flows..................................................................................219 

What is a Process Flow?.............................................................................................220 

Activities.......................................................................................................................220 

Creating Process Flow Variables.................................................................................222 

Using Transition Options..............................................................................................223 

Running a Process Flow..............................................................................................224 

Deleting Process Flows...............................................................................................227 

Chapter 7:Tools..................................................................................................229 

Importing and Exporting Dataflows..............................................................................230 

Inspecting Dataflows....................................................................................................230 

Process List..................................................................................................................234 

Changing Field Names and Data Types......................................................................235 

Routing Processing to Another Server.........................................................................235 

Using Multiple Runtime Instances................................................................................237 

Data Types in MapInfo Spatial Server.........................................................................237 

Part III:Administration...............................................................243 

MapInfo Spatial Server 1.0

User's Guide 

Chapter 8:Configuring Database Resources...................................................245 

Introduction to Database Resources............................................................................246 

Adding a Database Resource......................................................................................246 

Renaming a Database Resource.................................................................................254 

Deleting a Database Resource....................................................................................254 

Chapter 9:Configuring External Resources....................................................255 

Introduction to External Resources..............................................................................256 

Connecting to Databases.............................................................................................256 

Connecting to File Servers...........................................................................................258 

Accessing External Web Services...............................................................................259 

Chapter 10:Managing Execution......................................................................263 

Services.......................................................................................................................264 

Jobs and Process Flows..............................................................................................266 

Transaction History......................................................................................................271 

Remote Servers...........................................................................................................272 

Sort Performance.........................................................................................................276 

Chapter 11:Monitoring Your System................................................................277 

Event Log.....................................................................................................................278 

Custom Logs................................................................................................................279 

E-mail Notification........................................................................................................280 

Configuring License Expiration Notification.................................................................281 

Viewing Version Information.........................................................................................281 

Viewing and Exporting License Information.................................................................282 

Chapter 12:Managing User Accounts..............................................................283 

User Accounts .............................................................................................................284 

Enabling User Permissions..........................................................................................284 

Adding a New User......................................................................................................284 

Modifying a User..........................................................................................................284 

Deleting a User............................................................................................................285 

5

6 

Part IV:Modules..........................................................................287 

Chapter 13:Enterprise Geocoding Module......................................................289 

What is the Enterprise Geocoding Module?................................................................290 

Geocode Address [Country Code] (Deprecated).........................................................300 

Geocode Address Global.............................................................................................360 

Geocode Address World..............................................................................................425 

Geocode US Address..................................................................................................447 

GNAF PID Location Search.........................................................................................496 

Reverse APN Lookup..................................................................................................506 

Reverse Geocode Address Global..............................................................................519 

Reverse Geocode US Location...................................................................................531 

Geocode US Address Auxiliary Files...........................................................................548 

Location Codes for U.S. Geocoding............................................................................554 

Match Codes for U.S. Geocoding................................................................................571 

Result Codes for International Geocoding...................................................................577 

Custom Databases for International Geocoding..........................................................582 

Encountering False Positives.......................................................................................588 

Chapter 14:Enterprise Mapping Module..........................................................593 

What is the Enterprise Mapping Module?....................................................................594 

Where to find information on the Enterprise Mapping Module?...................................594 

Getting started with the Enterprise Mapping Module...................................................594 

Appendices.................................................................................597 

Appendix A:Module Matrix................................................................................599 

Modules, Components, and Databases.......................................................................600 

Appendix B:Country Codes..............................................................................601 

Country Names and ISO Codes..................................................................................602 


Part I: Introduction 

In this section: 

• Introduction to MapInfo Spatial Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9 

• MapInfo Spatial Server Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Introduction to MapInfo 

Spatial Server 


• What Is MapInfo Spatial Server? . . . . . . . . . . . . . . . . . . . .10 

• MapInfo Spatial Server Architecture . . . . . . . . . . . . . . . . .10 

1

What Is MapInfo Spatial Server? 

What Is MapInfo Spatial Server? 

Pitney Bowes MapInfo Spatial Server is an enterprise platform designed to provide you with a suite of 

broadly applicable location capabilities, solving a wide variety of business problems. It helps to centrally 

manage your GIS and data and expose these through standard interfaces which can be consumed by 

virtually any client. The standard interfaces help easy integration to core GIS functionality and keep those 

costs down. 

MapInfo Spatial Server aids in the design and implementation of business applications using location 

capabilities by providing: 

Geocoding 

Geocoding is the process of taking an address and determining its geographic coordinates (latitude and 

longitude). Geocoding can be used for map generation, but that is only one application. The underlying 

location data can help drive business decisions. Reversing the process, you can enter a geocode (a 

point represented by a latitude and longitude coordinate) and receive address information about the 

geocode. 

For more information, see What is the Enterprise Geocoding Module? on page 290. 

Enterprise Mapping 

Mapping provides the ability to generate maps, and also the ability to create new information about your 

data by assessing, evaluating, analyzing and modeling geographic relationships. Using the enterprise 

mapping module allows you to process and transform your information into valuable business intelligence. 

Enterprise Mapping provides a suite of broadly applicable location capabilites through services and access 

via REST and SOAP APIs. These location capabilites include mapping, tiling, feature seraching, geometry 

calculations, WMS (web map), WFS (web feature), and CSW (catalog service). 

For more information on Enterprise Mapping SOAP and REST APIs, see the Enterprise Mapping Module 

documentation at: http://reference.mapinfo.com/software/spatial_server/english/1_0/index.html. 

MapInfo Spatial Server Architecture 

10 

MapInfo Spatial Server software from Pitney Bowes Business Insight includes a server that supports a 

number of modules. These modules provide different functions, such as geocoding, and enterprise 

mapping. The following diagram illustrates the MapInfo Spatial Server architecture. 


This architecture consists of: 

• Server on page 11 

• Modules on page 11 

• Management Console on page 12 

• Enterprise Designer on page 13 

Server 

The foundation of the MapInfo Spatial Server is the server. The server handles data processing, synchronizes 

repository data, and manages communication between the client and the transformation 

modules via TCP/IP. It provides job management and security features. 

Modules 

Modules are sets of features that perform a specific function. You can license just one module or multiple 

modules, depending on your specific needs. Most modules consist of "components" and databases. 

User's Guide 

Chapter 1:Introduction to MapInfo Spatial Server 

11


12 

Components 

A component is a basic building block in a customer data quality process. Each component performs a 

specific function. For example, the Enterprise Geocoding module's Geocode US Address component 

takes an address and returns the latitude and longitude coordinates for that address; the Universal Addressing 

module's Get City State Province takes a postal code and returns the city and state/province 

where that postal code is located. 

Some components must first be combined with other components into a job, service, or subflow before 

they can be executed. Use Enterprise Designer to create jobs, services, subflows, and process flows. 

For more information, see Enterprise Designer on page 13. 

The components that you have available on your system depend on which MapInfo Spatial Server 

modules you have licensed from Pitney Bowes Business Insight. 

Databases 

Modules often include databases that contain the data needed by the components in the module. For 

example, the Universal Addressing module needs to have access to USPS data in order to verify and 

standardize addresses. So, the Universal Addressing module comes with the U.S. Postal Database, 

which you must load into a location that is accessible by your MapInfo Spatial Server system. 

Modules have both required and optional databases. Optional databases provide data needed for certain 

features that can greatly enhance your MapInfo Spatial Server process. 

Management Console 

The Management Console is a Windows-based tool for administering MapInfo Spatial Server. You can 

use the Management Console to: 

• Specify a server access address 

• Select component access method (local or hosted) 

• Specify the default settings for MapInfo Spatial Server components 

• Manage user accounts, including permissions and passwords 

• Set up logging, tracking, and reporting. 


Enterprise Designer 

Enterprise Designer is a Windows-based tool for creating MapInfo Spatial Server jobs, services, subflows, 

and process flows. It utilizes an easy drag-and-drop interface to allow you to graphically create complex 

dataflows. 

User's Guide 

Chapter 1:Introduction to MapInfo Spatial Server 

13


14 


MapInfo Spatial Server 

Clients 


• Connecting to the Managment Console . . . . . . . . . . . . . .16 

• Introduction to Management Console . . . . . . . . . . . . . . .17 

• Introduction to Enterprise Designer . . . . . . . . . . . . . . . . .19 

• Introduction to Interactive Driver . . . . . . . . . . . . . . . . . . .26 

2

Connecting to the Managment Console 

Connecting to the Managment Console 

16 

Start MapInfo Spatial Server clients by selecting Start > Programs > Pitney Bowes > MapInfo Spatial 

Server > Client Tools from your desktop. From there, select the client you wish to launch (Management 

Console, Enterprise Designer, or Interactive Driver). You will see a screen that resembles the following: 

Figure 1: Connecting to the Server 

To connect to the MapInfo Spatial Server server: 

1. Type in the server name or select it from the drop-down list. 

Note: If you have multiple instances of the Management Console accessing the same MapInfo 

Spatial Server server, it is possible for one user to overwrite another user's changes. Therefore, 

it is recommended that you do not run multiple instances of the Management Console against 

the same server. 

2. If necessary, enter your user name, password, and the port number. 

Note: 

This will be required only if security has been enabled on the server. 

3. Click Login. If this is your first time connecting, the user will default to "guest" and you can connect 

with no password. 

Note: 

The default port number is 8080 for HTTP connections. Use the port number appropriate for 

your environment. Once you have successfully connected, this value will default for the next 

connection attempt. 

4. Click Login.Click the Use secure connection box if you want communication between the client and 

the server to take place over an HTTPS connection. 


Introduction to Management Console 

The Management Console is used to configure MapInfo Spatial Server. Using this console, you can 

specify options for: 

• Default options for services 

• Database resources 

• Data sources 

• User account management 

• Logging, tracking, and reporting 

For details on the options associated with specific services, see the Component Reference part of this 

guide. 

The Management Console Primary Window 

The figure below represents the Management Console. 

Figure 2: Management Console Primary Window 

The console view area displays information based on the selected component in the console explorer. 

On the left pane, you see the "nodes" that contain the server management functions: 

• Use the Modules node to configure your services. 

• Use the Execution node to monitor and view results of batch jobs running on MapInfo Spatial Server 

and to set report options. 

• Use the Resources node to manage connections, file servers, and JDBC drivers. 

• Use the System node to enable a hosted server, view license information, establish notifications, 

manage server groups, and view software/database version information. 

User's Guide 

Chapter 2:MapInfo Spatial Server Clients 

17

Introduction to Management Console 

• Use the Event Log node to set logging options for the overall system and for individual services. 

• Use the Security node to manage security, permissions, and authorizations. 

• Use the Transaction History node to set history tracking and select and view reports on Service usage. 

• Use the Custom Logging node to create user-defined logs using your own database tables. 

The Management Console Menus 

18 

The Management Console menus consist of these options: File, Edit, View, Tools, and Help. The following 

information describes these options in greater detail. 

• File—The File menu contains two options: Save and Exit. The Save option allows you to save the 

current settings. The Exit option closes the Management Console. 

• Edit—The Edit menu contains one option: Revert. The Revert option causes the current screen to 

revert to default settings. 

• View—The View menu contains one option: Refresh. The Refresh option updates the current screen 

to include setting changes. 

• Tools—The Tools menu contains one option: Options. The Options option has two tabs: Run Service 

Settings and Execution. The Run Service Settings dialog box is shown below. 

The Run Service Settings tab contains three fields. Complete them as follows: 

1. Enter the highest number of records you want MapInfo Spatial Server to process in the Maximum 

number of records to process field. 

2. Enter the appropriate character in the File field separator field. 

3. If your file includes a different field separator than those listed, click the ellipsis button to access the 

Manage field separators dialog box. 

4. Click Add to access the Add Separator dialog box. 

5. Enter the character that your files uses as a separator in the Character field. If you prefer, you may 

enter the character by clicking the Character Map button and selecting from the lists provided. 

6. After you enter or select a character press Tab. The Unicode field will automatically be completed. 

Alternatively, you may enter the unicode value and the Character field will automatically be completed. 

7. If you wish, enter a description of the character in the Description field. In this example, the character 

is "&" and the description entered is "ampersand." If you don't enter a description, the character will 

appear by itself in the list of available characters. 

8. Click OK twice. 

9. Enter the number of seconds after wish you with MapInfo Spatial Server to time out a job, service, 

or subflow in the Time-out in seconds field. 

The Execution tab contains one field. Enter the number of seconds at which you would like Management 

Console to refresh the view. 

Note: 

The auto-refresh interval applies only to the Execution History view. 

• Help—The Help menu contains two options: General Help and About Management Console. The 

General Help option provides an online help system. The About Management Console option tells 

you what version of Management Console you're running. 


The Management Console Toolbar 

The table below describes the Management Console toolbar. 

Table 1: Management Console Toolbar 

Icon 

Note: 

Description 

Saves the current job. 

Causes the current screen to revert to default settings. 

Refreshes the view. 

Brings up the Options dialog box. 

Tells you what version of Management Console you're running. 

If you need help at any time, go to the Help menu. 

Introduction to Enterprise Designer 

The Enterprise Designer is used to build and run dataflows on MapInfo Spatial Server. Using this client, 

you can specify options for: 

• Create jobs 

• Create services 

• Create subflows 

• Create process flows 

• Inspect data 

• Generate reports 

For details on the options associated with specific services, see the Component Reference part of this 

guide. 

User's Guide 


19


Enterprise Designer Primary Window 

20 

The major elements of the Enterprise Designer primary window are illustrated below in Figure 3: Enterprise 

Designer Window on page 20 and described in Table 2: Enterprise Designer Primary Window 

Elements on page 20. 

Note: 

The Task Window, Palette, and Reports Window are dockable windows that can be moved and 

repositioned to your preference. 

Figure 3: Enterprise Designer Window 

Table 2: Enterprise Designer Primary Window Elements 

Element 

Task Window 

Description 

Shows all open dataflows and allows you to create a new job, service, subflow, 

and process flow. 


Element 

Server Explorer 

Palette 

Reports Window 

Dataflow Name Tab 

Canvas 

Description 

Shows all defined services; services can be used as part of other services. Includes 

the "Folders" feature of Enterprise Designer. 

Contains all the stages and reports you can add to your dataflow. 

Note: The stages available in the Palette depend on the options you have licensed. 

Shows reports that have been generated for the current job you are viewing 

(does not apply to services or subflows). 

Shows the name of each open dataflow. The dataflow in which you are currently 

working will be bold. 

The work area onto which you drag stages and channels to make dataflows. 

You can have several dataflow canvases (or jobs) open at once. 

In Figure 3: Enterprise Designer Window on page 20, the Task Window shows all available dataflows. 

You could start a new dataflow by clicking File > New > Dataflow and selecting Service, Subflow, Job 

or From Template or by pressing the New button and selecting New Service, New Subflow, New Job or 

New Dataflow From Template. The Palette shows all of the Sources, Sinks, Control Stages, and Primary 

Stages available for this job. In the Dataflow Name Tab area, "MP LS 5-30 (Job)" is bold, identifying the 

name of the job with which we are working. The Canvas shows three elements of the current job: an input 

source (Read from File), a Deployed Stage (ValidateAddress), and an output sink (Write to File). 

The Server Explorer section of the Enterprise Designer Window, shown in Figure 3: Enterprise Designer 

Window on page 20, gives you the ability to develop your own hierarchical organization of the dataflows 

you create, which will be reflected in the list of services in the Management Console and in the Dataflow 

Components window. 

User's Guide 


21


• To create a folder, right-click the server name and select New > Folder. 

• To organize the files within Server Explorer drag a folder or a dataflow and then drop it on its prospective 

parent. Press Refresh to see this reorganization reflected in the Dataflow Components window. You 

will also see this new organization in the Management Console. 

The Enterprise Designer Menus 

The Enterprise Designer menus consist of these options: File, Edit, View, Run, Tools, Window, and Help. 

The following information describes these options in greater detail. 

• File—The File menu allows you to manage jobs and workflows and contains 11 options: New, Open, 

Close, Save, Save All, Save As, Expose/Unexpose, Import, Export, Manage, and Exit. 

• Edit—The Edit menu allows you to change dataflow options, view dataflow properties, view job options, 

and change the type of dataflow; it contains the following options: Dataflow Options, Job Options, Type 

Conversion Options, Web Service Options, Notifications, Dataflow Type, Properties, Copy, Paste, 

Paste as Sink, and Paste as Source. 

• View—The View menu allows you to determine what parts of the Enterprise Designer window are 

visible and contains five options: Task Pane, Server Explorer, Palette, Execution History, and Refresh. 

• Run—The Run menu allows you to test individual dataflows, view data of all dataflows, and inspect 

and run jobs; it contains three options: Validate, Run Current Flow, Inspect Current Flow. 

• Tools—The Tools menu allows you to see dataflows that use the current subflow and set Enterprise 

Designer options; it contains two options: Used by and Options. 

• Window—The Window menu allows you to determine which job, of all open jobs, you want to view 

or close your jobs; it contains one option: Close All Windows. 

• Help—The Help menu provides an online help system and tells you what version of Enterprise Designer 

you are running; it contains two options: MapInfo Spatial Server Help and About Enterprise 

Designer. 

The Enterprise Designer Toolbar 

22 

The table below describes the Enterprise Designer toolbar. 

Table 3: Enterprise Designer Toolbar 

Icon 

Description 

Creates a new service, subflow, job, or process flow for editing. 

Opens an existing service, subflow, job, or process flow. 


Icon 

Note: 

Description 

Saves the current job. 

Refreshes the view. 

Runs the current dataflow. 

Invokes the Data Inspection tool. 

Brings up the Dataflow Options dialog box. 

Toggles off and on the expose option, which allows you to make services 

and subflows available to other users. 

If you need help at any time, go to the Help menu. 

Elements of a Dataflow 

A dataflow is a collection of stages. Dataflows may be either jobs, services, or subflows. 

Table 4: Elements of a Dataflow 

Element 

Tasks 

New 

User's Guide 

Description 

Job 

Service 


A dataflow containing at minimum a source and a sink. May 

also include stages. 

Either a licensed service from Pitney Bowes Business Insight 

or a custom, published service that someone has created. 

Services can be used in other dataflows and consist of a 

23


24 

Element 

Palette 

Sources 

Sinks 

Control Stages 

Description 

Subflow 

Process Flow 

Read from DB 

Read from File 

Execute Program 

Terminate Job 

Write to DB 

Write to File 

Write to Log 

Write to Null 

Broadcaster 

Conditional Router 

Group Statistics 

single input and output, which are interfaces that allow other 

jobs, services, or subflows to use the service. 

A predefined flow that can be used as single stages in other 

dataflows. Subflows have at least one input or output, may 

include sources and sinks. 

A string of activities, such as exposed jobs and external applications, 

to be automatically executed in a particular order. 

A database source. 

A file source. 

A sink that allows the execution of user-configurable system 

commands. 

A stage that terminates a job when it receives its first record 

from a router that defines certain criteria. 

A database sink. 

A file sink. 

A log sink. 

A null sink. 

Sends every record from the input to all stages connected to 

the output. For example, a record can be sent to a name 

parser and an address parser. 

Sends a record to different stages depending on user-specified 

criteria. For example, successful matches are sent to 

one output file and failed matches are sent to another output 

file. 

Note: 

This stage uses Groovy scripting. For more information, 

go to http://groovy.codehaus.org. 

Allows you to run statistical operations across multiple data 

rows broken down into groups that you want to analyze. 


Element 

Primary Stages 

Description 

Math 

Query DB 

Record Combiner 

Sorter 

Stream Combiner 

Transformer 

Handles mathematical calculations on a single data row and 

allows you to conduct a variety of math functions using one 

or more expressions. 

Allows you to use fields as parameters into a database query. 

Takes two or more records from multiple stages and combines 

them into a single record. For example, the parsed name 

from a name parser is joined with a parsed address from an 

address parser to make a single parsed name and address 

record. 

This stage uses Groovy scripting. For more information, go 

to http://groovy.codehaus.org. 

Sorts the output from a stage based on fields you specify. 

Concatenates, or joins, two or more lists of records from 

multiple stages. For example, two input files are joined to 

produce one large input file. 

Allows you to use the transforms function. Includes the following: 

copy transforms, case transforms, pad transforms, trim 

transforms, truncate transforms, substring transforms, and 

mask transforms. 

Stages related to the services/components you have purchased. Also known as deployed 

stages. 

Deployed stages The available components, which depend on the products for which you are licensed 

and are running in Enterprise Designer. For instance, Universal Coder provides a 

component called "ValidateAddress." See the Components section for descriptions 

of each service. Also known as primary stages. 

User-Defined 

Stages 

Ports 

Channels 

Rename 

User's Guide 


The stages created not by Enterprise Designer but by users of the system. 

The methods by which channels connect components to each other. Mandatory ports 

are black, dynamic ports are gray, and optional ports are white. 

The connections between two components within a dataflow; channels are where 

renaming is performed. 

Allow you to modify elements of your data, such as change casing, truncate characters, 

and so on. You will notice that channels have a white filled circle; if a transform stage 

is present underneath, the circle is filled black. 

25

Introduction to Interactive Driver 


Interactive Driver offers a "preview" function in which you can run a service/component, view the results, 

and make changes to your configuration settings if needed. Using Interactive Driver, you can do the 

following: 

• Enter input data manually or import a data file 

• View the input data in the input grid 

• Run the service 

• View the output data in the output grid 

• View summary metrics such as number of successes, failures, and errors 

• View field-level metrics such as number of fields modified, number of blank input fields, and so on. 

You can also change your views of the data by switching from "horizontal" to "vertical" view, or by 

widening or narrowing columns. 

The Options Tab 

In the Options tab, you can configure your services/components. 

1. Select a service. The Options tab containing options for that service will appear. In the following example, 

we've selected ValidateAddress. 

2. Click a node on the left and select your options on the right. These settings will act as the default 

settings for dataflows created in Enterprise Designer. 

The Preview Tab 

26 

Under the Preview tab, you can preview input and output. You can type your input data directly into the 

grid. Column headings, or field labels, that correspond to the input will appear automatically. These vary 

by product and service. 


Note: 

See the Components section of this guide for a detailed description of all the input fields. 

1. Begin typing in the first row. A second column will appear automatically. to move to the next 

row. 

2. Continue typing your input record until you've finished the last column entry. 

3. Continue typing all your input data. 

4. The default view is vertical. If you wish to change your view to horizontal, click the View button and 

select Horizontal. 

5. Click the Run Preview button if you wish to preview the output of the address(es). 

Note: 

Importing Data 

Not every row/column must contain data. You can leave rows/columns blank as necessary. 

You can import an existing file into the input grid, up to 100 records, as long as it's in the correct format. 

1. Click the Options button on the toolbar. 

2. Enter (or select) the maximum number of records to process. The maximum entry is 100. 

3. Select the File field separator from the drop-down list (space, tab, comma, period, semicolon, pipe). 

If your file includes a different field separator than those listed, 

a) Click the ellipsis button to access the Manage field separators dialog box. 

b) Click Add. 

c) Enter the character that your files uses as a separator in the Character field. If you prefer, you 

may enter the character by pressing the Character Map button and selecting from the lists 

provided. 

d) After you enter or select a character press Tab. The Unicode field will automatically be completed. 

Alternatively, you may enter the unicode value and the Character field will automatically be 

completed. 

e) If you wish, enter a description of the character in the Description field. For example, the character 

could be "&" and the description could be "ampersand." If you do not enter a description, 

the character will appear by itself in the list of available characters. 

f) Click OK twice. 

4. Enter (or select) the maximum number of seconds you want the job to run before it should time out. 

5. Click OK. 

6. Click Import Data. 

7. Navigate to the directory containing your data file and select it. 

8. Click Open. The data will appear in the input grid. 

User's Guide 


27


28 

9. If you wish to change your view to vertical, click View and select Vertical. 

10. Click Run Preview to see the result. 

Preview Output 

After you input your data (by whatever method), you can now run the service and view the results. 

1. Click the Run Preview button. After a minute or so (depending on your network's speed), data will 

appear in the output grid. 

2. Review your output data, making sure the results are what you intended to get from the service. 

3. Make changes to the service's settings if necessary. Then click Run Preview again. (You do not 

need to input the data again.) 

4. Click the Run Preview button if you wish to view more information in the Preview Information section. 


Part II: Designing Dataflows 


• Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31 

• Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97 

• Subflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155 

• Process Flows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .219 

• Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .229

Jobs 


• What is a Job? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32 

• Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32 

• Control Stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39 

• Primary Stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79 

• Sinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80 

• Runtime Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87 

• Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88 

• Running a Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .90 

3

What is a Job? 

What is a Job? 

A MapInfo Spatial Server job is a dataflow that performs batch processing. A jobs reads data from one 

or more files or databases, processes that data, and writes the output to one or more files or databases. 

Jobs can be executed manually in Enterprise Designer or can be run from a command line using the job 

executor. 

The following dataflow is a job. Note that it uses the Read from File stage for input and two Write to File 

stages as output. 

Sources 

A source is the first stage in a job. It defines the input data you want to process. In a job, input data can 

come from a file or a database. There are two source stages available for jobs: 

• Read From File on page 32 

• Read From DB on page 35 

Note: When designing a job, it is a good idea to account for the possibility of malformed input records. 

A malformed record is one that cannot be parsed using one of the parser classes provided by 

MapInfo Spatial Server. For information on handling malformed input records, see Managing 

Malformed Input Records on page 38. 

Read From File 

32 

The Read from File stage specifies an input file for a dataflow. 

Define the Input File 

1. Double-click the Read from File icon on the canvas. The Read from File Options dialog box opens. 

2. Click the ellipsis button next to the File Name field. 

3. Navigate to your file and click Open. Your file will be displayed in the File Name field. 

Note: 

File names and paths are case sensitive. 


4. Complete the remaining fields as follows. 

Field Name 

Record type 

Character encoding 

Field separator 

Text qualifier 

User's Guide 

Record separator 

Description 

The format of the records 

The encoding method of the characters 

The type of field delimiter, if applicable. 

The qualifier character, if applicable. 

If your file includes a different field separator than those listed, do the 

following: 

a. Click the ellipsis button to access the Manage Field Separators dialog 

box. 

b. Click Add to access the Add Separator dialog box. 

c. In the Character field, enter the character that your file uses as a field 

separator. If you prefer, you may enter the character by clicking Character 

Map and selecting from the lists provided. 

d. After you enter or select a character press the Tab key. The Unicode 

field will automatically be completed. Alternatively, you may enter the 

unicode value and the Character field will automatically be completed. 

e. (Optional) Enter a description of the character in the Description field. 

For example, if the character is "&" the description could be "ampersand." 

If you do not enter a description, the character will appear by itself in 

the list of available characters. 

f. Click OK twice. 

Use a different record separator other than the normal end of line (EOL) 

characters. 

If your file includes a different record separator than those listed, do the 

following: 

a. Click the ellipsis button to access the Manage Record Separators 

dialog box. 


Chapter 3:Jobs 

c. Enter the character that your files uses as an EOL character in the 

Character field. If you prefer, you may enter the character by clicking 

Character Map and selecting from the lists provided. 




33

Sources 

34 

Field Name 

Use default EOL 

Record length 

First row is header record 

Treat records with fewer fields 

than defined as malformed 

Adding Input Fields 

Description 

e. If you wish, enter a description of the character in the Description 

field. For example, if the character is "%" the description could be "percentage 

sign." If you do not enter a description, the character will appear 

by itself in the list of available characters. 


Use normal end of line (EOL) characters. 

The length of the records in the input file. 

For line sequential files, the number must be the minimum length of the 

record (but can be longer); for fixed width files, this number must be 

exact. 

The first record in a delimited input file contains header information and 

not data. 

Delimited input file records containing fewer fields than are defined on 

the Fields tab will be treated as malformed. For more information on 

malformed records, see Managing Malformed Input Records on page 

38. 

1. Double-click the Read from File icon. The Read from File Options dialog box opens. 

2. Click the Fields tab. 

3. Define the fields in your input records by selecting the appropriate field and clicking Add to add fields 

or clicking Remove to delete fields. You can also modify the position of a field by clicking Modify 

and changing the position as desired. If your file is delimited and contains a header record, you can 

add all fields from the input file by clicking Regenerate. 

Note: 

The fields available for selection depend on which stages are in the dataflow. 

4. Enter the Name of the field you are adding. 

5. The Type field will automatically populate based on the needs of the dataflow. If you are adding a 

field that exists downstream in your dataflow, the Type field will populate with the necessary type; 

otherwise, it will populate with string as the type. Note that you are able to override these entries if 

you like. Supported types include boolean, double, float, integer, long, and string. 

6. Enter the Start Position and Length for Fixed Width and Line Sequential record types (or Position 

if the record type is Delimited). 

7. If you want to have any excess space characters removed from the beginning and end of a field's 

character string, select the Trim Spaces check box. 

8. When you have named and mapped all your input fields, click OK. 


Sorting Input Fields 


2. Click the Sort Fields tab. 

3. Click Add. 

4. Click the drop-down arrow in the column under the Field Name heading and select the field you want 

to sort by. The fields available for selection depend on the fields defined in this input file. 

5. Select "Ascending" or "Descending" from the Order column. 

6. Repeat until you have added all the input fields you wish to use for sorting. Change the order of the 

sort by highlighting the row for the field you wish to move and clicking Up or Down. 

7. To specify additional sort performance options, click Advanced to open the Advanced Options 

dialog box. When you have finished specifying the additional sort performance options, click OK to 

close the Advanced Options dialog box and return to the Read from File Options dialog box. The 

Advanced Options dialog box contains the following sort performance options: 

• Override Sort Performance Options—Specifies that these options override the default sort performance 

options. 

• In Memory Record Limit—Specifies the maximum number of data rows a sorter will hold in 

memory before it starts paging to disk. 

• Maximum Amount of Temporary Files to Use—Specifies the maximum number of temporary 

files that may be used by a sort process. 

• Enable Compression—Specifies that temporary files are compressed when they are written to 

disk. 

The combination of sort performance option settings that will result in optimal sorting efficiency is 

highly dependent on your server's hardware configuration. Nevertheless, good sort performance 

results have been observed when using the following general guideline: (in_memory_record_limit × 

maximum_number_of_temporary_files_to_use ÷ 2) >= total_number_of_rows_to_be_sorted Be 

aware that in environments where there are concurrently running jobs, increasing the In Memory 

Record Limit setting increases the likelihood of running out of memory. 

8. When you have finished specifying the additional sort performance options, click OK to close the 

Advanced Options dialog box and return to the Read from File Options dialog box. 

9. Click OK to return to the canvas. 

Set Input Runtime Properties 


2. Click the Runtime tab. 

3. Enter the first record you want to process in the Starting Record field. 

4. Select either All Records or Max Records. 

5. If you selected Max Records, enter the maximum number of records you want your dataflow to process. 

6. Click OK. 

Read From DB 

The Read From DB stage reads data from a database table or view and supports the following data 

types: 

User's Guide 


35

Sources 

36 

Data Type 

double 

float 

integer 

long 

string 

Description 

A numeric data type that contains both negative and positive double precision 

numbers between 2 -1074 and (2-2 -52 )×2 1023 . In E notation, the range of values 

is 4.9E-324 to 1.7976931348623157E308. For information on E notation, 

see: 

http://en.wikipedia.org/wiki/Scientific_notation#E_notation 

A numeric data type that contains both negative and positive single precision 

numbers between 2 -149 and (2-2 23 )×2 127 . In E notation, the range of values 

is 1.4E-45 to 3.4028235E38. For information on E notation, see: 


A numeric data type that contains both negative and positive whole numbers 

between -2 31 (-2,147,483,648) and 2 31 -1 (2,147,483,647) 


between -2 63 (-9,223,372,036,854,775,808) and 2 63 -1 

(9,223,372,036,854,775,807) 

A sequence of characters 

Database types map to MapInfo Spatial Server as follows: 

Data Type 

String Types 

CHAR 

VCHAR 

LONGVARCHAR 

NCHAR 

NVARCHAR 

Numeric Types 

TINYINT 

SMALLINT 

INTEGER 

BIGINT 

REAL 

DECIMAL 

DOUBLE 

FLOAT 

Description 

string 

string 

string 

string 

string 

integer 

integer 

integer 

long 

float 

double 

double 

double 


Data Type 

NUMERIC 

Boolean Types 

BIT 

BOOLEAN 

To define a database source: 

Description 

double 

boolean 

boolean 

1. Under Sources and Sinks, click Read from DB and drag it to the canvas, placing it where you want 

on the dataflow. 

2. Double-click the icon. The Read from DB Options dialog box appears. 

3. In the Connection field, select the database connection you want to use. Your choices vary depending 

on what connections are defined in the Connection Manager of the Management Console. If you 

need to make a new database connection, click Manage. For more information, see Database 

Connection Manager on page 37. 

4. Click the browse button ([...]) to navigate to the database or view that you want to use. 

5. If you want to use a "where" SQL statement, enter it in the Where field (note that you should not actually 

include the word "where" in the statement). For example: STATEPROVINCE = 'IL'. The 

purpose of a "where" statement is to filter input records. After entering a "where" statement, click 

Preview to see a preview of the data (first 50 records) based on the criteria you defined. 

6. From the Fields table, select the fields you want to include by clicking the "Include" box next to the 

field. 

7. If you want to sort records based on the value of a field, click the Sort tab and specify the fields you 

want to sort on. 

8. Click OK. You will return to the canvas. 

Database Connection Manager 

The Database Connection Manager tool allows you to manage registered database connections. To 

add, modify, delete, and test connections: 

1. In the Read From DB Options dialog box, click Manage. 

The Database Connection Manager dialog box will appear. 

2. Click Add, Modify, or Delete. 

The Connection Properties dialog box will appear. 

3. If you are adding or modifying a database connection, complete these fields: 

• Connection name—Enter the name of the new connection. 

• Database driver—Select the appropriate database type. 

• Connection Options—Specify the host, port, instance, username, and password. 

Note: 

You can test the connection by clicking Test. 

4. If you are deleting a database connection, select the connection you want to remove and click Delete. 

User's Guide 


37

Sources 

Managing Malformed Input Records 

38 

A malformed record is one that MapInfo Spatial Server cannot parse. When MapInfo Spatial Server encounters 

a malformed record, it can do one or more of the following: 

• Terminate the job 

• Continue processing 

• Continue processing until a certain number of bad records are encountered 

• Continue processing but write bad records to a log file (via an optional sink stage) 

Note: Malformed records functionality is limited to sources configured to read from files local to the 

server and that do not have sorting configured. When a source is configured with either a remote 

file or with sort fields and the source encounters a malformed record, the job will fail regardless 

of the configuration for malformed records. 

To manage malformed records, 

1. Add a malformed records sink in your dataflow. 

a) Create your job by defining your input file and source stage and adding services and subflows 

to your dataflow. 

b) Do one of the following: 

• Connect a sink stage to the optional output port on the source stage in your dataflow. The optional 

port is the clear output port just beneath the black output port on your source stage. If 

you mouse over this port, you will see a tool tip that says, "error_port." Malformed records are 

written to this sink. 

• Connect nothing to the optional output port on the source stage in your dataflow, which causes 

MapInfo Spatial Server to ignore malformed records. 

The completed dataflow should look something like this: 

When you run your job, the Execution History will contain a column that shows the number of malformed 

records that were encountered during the job. 

2. By default MapInfo Spatial Server will abort a job when it encounters a malformed record. Override 

this setting by following these steps: 

a) Within an open job, go to Edit > Job Options . 

b) Select either Do not terminate the job on a malformed record or select Terminate the job after 

encountering... and enter the number of malformed records you will allow a job to encounter before 

terminating. 



Control stages perform common tasks such as routing records to different paths in the dataflow, sorting, 

and transforming. 

Aggregator 

An Aggregator takes input data rows from a single source, creates a schema (a structured hierarchy of 

data) by grouping the data based on field values, and then constructs lists of those groups in the schema. 

Aggregator stages have one stage input port that connects to an Aggregator and one stage output port 

that delivers data from the Aggregator to the next stage. 

Note: If your data includes a field by which you will group your data, such as an ID field, you must sort 

your data before running it through an Aggregator. You can do this by sorting the data prior to 

bringing it into the dataflow, by sorting the input file within Enterprise Designer (for jobs or subflows, 

but not services) or by adding a Sorter stage to your dataflow (for jobs, services, or subflows). 

Below is an example of how the Aggregator can be used in a dataflow. Click here to go directly to instructions 

on using the Aggregator. 

A practical example of the Aggregator's function is to take a group of street addresses and turn them 

into driving directions. You could do this with two points, such as a start point and an end point, or you 

could do this with multiple points along a route. The dataflow for this type of function might look like the 

following: 

The dataflow performs the function as follows: 

1. The Read from File stage contains street addresses in a flat file. The fields in this file include the 

following: 

User's Guide 

• an ID, which identifies a particular address in the file 

• a Type, which indicates whether the address is a "From" address or a "To" address 

• an AddressLine1field, which provides the street address 

• a LastLine field, which includes such information as a city, state, and/or postal code 


39


40 

2. The Field Transform between the Read from File stage and the Math stage changes the format of 

the ID field from string to double because the Math stage does not accept string data. 

3. The Math stage creates an expression that establishes a Group ID field to be used downstream in 

the dataflow. In this example, it calculates the Group ID as the floor of, or rounds down, the value of 

the ID field divided by 2. So, if the ID is 3, then the expression is 3/2, which equals 1.5. When you 

round down 1.5, it becomes 1. If the ID is 2, then the expression is 2/2, which equals 1, and there is 

no need to round down. Therefore, IDs 2 and 3 have the same Group ID of 1. 


4. Geocode US Address obtains latitudes and longitudes for each address. Click here for more information 

on Geocode US Address. 

5. The Aggregator stage establishes that the data should be grouped by the GroupID field and that 

the output lists should include Route Points devised of latitudes and longitudes. 

User's Guide 

The instructions below show how to manually configure the Aggregator stage for this dataflow: 

• Double-click the Aggregator stage, and then double-click Group by. 

• Select the GroupID field and click OK. 

Using this field will allow us to include route points for the next stage in the dataflow. Route points 

are essential for a dataflow that produces directions. 

• Double-click Output lists. The Field Options dialog box appears. 


• Create a New data type named RoutePoints made up of a type of RoutePoint data. By default, 

this is a list and cannot be changed, so the checkbox is grayed out. 

41


42 

• Press OK. 

• Click RoutePoints and click Add. The Field Options dialog box appears again. 

• Route Points are made up of latitudes and longitudes, so we need to first add an Existing field 

from the existing input field Latitude. The Name field will auto-populate. 

Repeat this step for Longitude. 


User's Guide 

The completed Aggregator stage will appear as follows: 

The instructions below show how to use a template type to configure the Aggregator stage for this 

dataflow: 





• Create a Template type from a downstream field. Get Travel Directions uses route points to perform 

its function, so select RoutePoints. The Name field will auto-populate. By default, this is a list 

and cannot be changed, so the checkbox is grayed out. 

43


44 

• Press OK. The completed Aggregator stage will appear as follows: 

6. Get Travel Directions provides driving instructions from point IDs 0, 2, and 4 to point IDs 1, 3, and 

5, respectively. 


7. The Splitter stage allows you to select Route Directions as your output for this dataflow and select 

which fields you want included in the output. Click here for more information on the Splitter stage. 

8. The Write to File stage collects the output from Step 7 and provides directions. 

User's Guide 


45


46 

The following image shows a portion of the inspection results for this dataflow. 

If you expand the tree for any individual row, you will see the data used for inspection—in this case, 

the latitude and longitude for the route points in the direction. 

Using the Aggregator Stage 

Follow the instructions below to use the Aggregator stage. 


1. Under Control Stages, click the Aggregator and drag it onto the canvas, placing it where you want 

on the dataflow and connecting it to input and output stages. 

2. Double-click the Aggregator. The Aggregator Options dialog box appears with the Group by control 

highlighted. 

3. Click Add. Alternatively, you can double-click the Group by control. The Group By dialog box appears. 

4. Select from the drop-down list the field that contains the data you want to put into a list and click OK. 

Note that the entry appears with the file type description. You can repeat this step as many times as 

necessary to select multiple Group by fields. Keep in mind that the Aggregator stage does not allow 

invalid XML characters in field names; it does allow alphanumeric characters, periods (.), underscores 

(_), and hyphens (-). 

Note: The list of available fields in the Group By drop-down depends on what fields are used in 

the stage connected to the Aggregator's input port. For instance, if your dataflow uses geocoding 

stages, your available fields would likely contain address elements such as Address- 

Line1, City, StateProvince, and so on. 

5. Now select the output you would like Aggregator to generate. Click Output lists and then Add. Alternatively, 

you can double-click the Output lists control. The Field Options dialog box appears. 

6. Indicate where the field information is coming from: 

• Existing field: Select from the fields provided in the Input field drop-down. This list also depends 

on what fields are coming from the stage connected to the Aggregator's input port. 

• New data type: Enter the name of the type of information that will be in this field (e.g., "CustomerID", 

"AltID", etc.). 

• Template: Select a field from the Downstream field drop-down. This option allows you to add a 

field based on data in the stage connected to the Aggregator's output port. Using the example 

above, the available options would be "RouteDirections" and "RoutePoints". 

7. Click the List box if it is unchecked and your output will be in list format. 

8. Enter the name of the field in the Name text box, or leave it as-is if it auto-filled and you are satisfied 

with the name. 

9. Click OK. Note that the entry appears with the file type description. If child elements appear with the 

parent, those entries will show the source of the information as well as the file type description. You 

can repeat this step as many times as necessary to select multiple Output list fields. 

10. If you need to add child entries to your parent Output list item, click Add and repeat steps 5 through 

9. 

Note: 

Broadcaster 

You can modify the field group by highlighting a row and clicking Modify, and you can remove 

a field group by highlighting a row and clicking Remove. You can also change the order of 

fields by clicking a field and clicking Move Up or Move Down. 

A Broadcaster sends records to two or more stages. Broadcasters have one stage input that connects 

to a Broadcaster, which then directs the input information into two or more stages. 

Under Control Stages, click the Broadcaster and drag it to the canvas, placing it where you want on the 

dataflow. 

User's Guide 


47


Broadcaster has no settings to change. 


48 

A Conditional Router sends records to different stages (or files) depending on criteria you specify. Conditional 

Routers can have one or more output ports, depending on how you define them. Output ports 

are numbered consecutively, beginning with 1 (which displays as "port"). The output ports connect to 

different stages that you want to send data to, depending on a condition. For example, you can send 

one group of records to a "successful match" output file on port 1 and the other group to a "failed match" 

output file on port 2. 

1. Under Control Stages, click the Conditional Router and drag it to the canvas, placing it where you 

want on the dataflow. 

2. Connect the router to other stages on the canvas. 

Note: 

You must complete this step before defining settings or the ports will not be available for 

editing. 

3. Double-click the Conditional Router. The Conditional Router Options dialog box appears. 

4. Click the square button under "Condition/Expression" for port. The Expressions Editor dialog 

box appears. 

5. In the Choose Expression Type field, select one of the following: 

• Custom expression—Select this option to write an expression using Groovy scripting. For more 

information, see Using Groovy Scripting on page 50. 

• Default expression—Select this to route records to this port by default. Records that do not match 

any of the other ports' expressions will be routed to this port. You should always have an output 

port with "default" as the expression to ensure that all rows are written from the router. 

• Expression created with Expression Builder—Select this option to create a basic expression. 

If you select this option: 

6. In the Combine expression method field, choose All if you you want all the expressions to evaluate 

to true in order for the record to be routed to this port; select Any if you want records to be routed to 

this port if one or more of the expressions is true. 

7. Click Add and specify the field to test, the operator, and a value. The operators are listed in the following 

table. 

Table 5: Expression Builder Operators 

Operator 

Is Equal 

Is Not Equal 

Description 

Checks if the value in the field matches the value specified. 

Supports boolean, double, float, integer, long, and string data types. 

Checks if the value in the field does not match the value specified. 



Operator 

Is Null 

Is Not Null 

Is Empty 

Is Not Empty 

Is Less Than 

Is Less Than Or Equal 

To 

Is Greater Than 

Is Greater Than Or 

Equal To 

Starts With 

Does Not Start With 

Contains 

User's Guide 

Does Not Contain 

Description 

Checks if the field is a null value. 


Checks if the field is not a null value. 


Checks if the field is null or a string with a length of 0. 

Supports string data types. 

Checks if the field is neither null nor a string with a length of 0. 


Checks if the field has a numeric value that is less than the value specified. 

Supports double, float, integer, long, and string data types. 

Checks if the field has a numeric value that is less than or equal to the value 

specified. 


Checks if the field has a numeric value that is greater than the value specified. 


Checks if the field has a numeric value that is greater than or equal to the 

value specified. 


Checks if the field begins with the characters specified. 


Checks if the field does not begin with the characters specified. 


Checks if the field contains the string specified. 


Checks if the field does not contain the string specified. 



49


50 

Operator 

Ends With 

Does Not End With 

Matches Regular Expression 

Using Groovy Scripting 

Description 

Checks if the field ends with the characters specified. 




Matches the field with a regular expression for identifying strings of text of 

interest, such as particular characters, words, or patterns of characters. The 

value field should contain a valid regular expression pattern. 


Each output port can have a Groovy expression associated with it. If you are not familiar with Groovy 

scripting, see this website for complete information on Groovy: 

groovy.codehaus.org 

Groovy expressions must evaluate to a boolean value (true or false) which indicates whether the record 

should be written to the port. The record is routed to the first output port whose expression evaluates to 

true. 

For example, if you wanted to route records with a validation confidence level of >=85 to one stage and 

records with a validation confidence level of =85 

And the Condition/Expression on port 2 would look like: 

row.get('Confidence')

Checking a Field for Multiple Values 

This example evaluates to true if the Status field has 'F' or 'f' in it. 

boolean returnValue = false; 

if (data['Status'] == 'F' || data['Status'] == 'f') 

{ 

returnValue = true; 

} 

return returnValue; 

Evaluating Field Length 

This example evaluates to true if the PostalCode field has more than 5 characters. 

return data['PostalCode'].length() > 5; 

Checking for a Character Within a Field Value 

This example evaluates to true if the PostalCode field has a dash in it. 


if (data['PostalCode'].indexOf('-') != -1) 

{ 


} 


Common Mistakes 

The following illustrate common mistakes when using scripting. 

The following is incorrect because PostalCode (the column name) must be in single or double quotes 

return data[PostalCode]; 

The following is incorrect because no column is specified 

return data[]; 

The following is incorrect because row.set() does not return a Boolean value. It will always evaluate to 

false as well as change the PostalCode field to 88989. 

return row.set('PostalCode', '88989'); 

Use a single equals sign to set the file of a file, and a double equals sign to check the value of a field. 


The Group Statistics stage allows you to run statistical operations across multiple data rows broken 

down into groups that you want to analyze. Grouping can be performed on numeric or string data. If no 

groups are defined all rows will be treated as belonging to one group. 

Groups are defined by one or more fields that have the same value across multiple data rows. For example, 

the data in the following table could be grouped by region, state, or both. 

User's Guide 


51


52 

Region 

East 

East 

East 

West 

West 

State 

A group by Region would yield East and West. A group by State would yield California, Connecticut, and 

Maryland. A group by Region and State would yield East/Maryland, East/Connecticut, and West/California. 

1. Under Control Stages, click the Group Statistics stage and drag it to the canvas, placing it where you 


2. Connect the stage to other stages on the canvas. 

Double-click the Group Statistics stage. The Group Statistics Optionsdialog box appears, with the 

Operations tab open. For more information, see Using the Operations Tab on page 52. This view 

shows the Input Fields, the Group by control, and the Operations control. Alternately, you can click the 

Output tab to change output settings. or more information, see Using the Output Tab on page 53. 

MD 

MD 

The Input fields control lists the valid fields found on the input port. 

The Group by control allows you to set the fields by which you want the output to be grouped. 

The Operations control contains a list of user-defined operations to be performed across multiple data 

rows as defined in the Group by control. Operations work on numeric data only. 

Using the Operations Tab 

Once data is grouped, various operations can be performed on individual fields across the rows in each 

group. 

• Use the >> button to move input fields into the Group by or Operations controls. This will cause the 

Modify dialog box to appear and allow you to design the operation. 

• Click Modify to alter an existing operation. 

• Click Remove to remove a field from the Group by or Operations controls. 

Note: 

Operations work only on numeric data. 

Table 6: Supported Operations 

Operation 

Average 

Maximum 

Minimum 

Description 

CT 

CA 

CA 

Returns the average value for a given field. 

Returns the maximum value for a given field. 

Returns the minimum value for a given field. 


Operation 

Standard Deviation 

Percentile 

Percent Rank 

Sum 

Variance 

ZScore 

Description 

Returns the standard deviation for a given field. The standard deviation 

represents the variation, across the values in a given field, from the average. 

It is the square root of the field's variance. 

Returns a user-defined percentile (0 - 100) for a given field. The percentile 

represents the value in which a certain percentage of observations may be 

found. 

Returns the percent rank of a given field. The percentile rank represents 

the percentage of scores that are lower then a given value. 

Returns the sum for a given field. 

Returns the variance for a given field. The variance represents the amount 

of variation across the values for a given field. 

Returns the ZScore for a given field. The ZScore indicates how many 

standard deviations a value is above or below the average for a given group. 

The data type for both input and output fields can be specified while configuring an operation. Each type 

selected has limitations on the kind of numeric data it will read and write. The available types are shown 

below, from smallest to largest: 

Data Type 

Integer 

Long 

Float 

Double 

Note: 

Description 


between -2 31 (-2,147,483,648) and 2 31 -1 (2,147,483,647) 


between -2 63 (-9,223,372,036,854,775,808) and 2 63 -1 

(9,223,372,036,854,775,807) 


numbers between 2 -149 (1.4E-45) and (2-2 23 )×2 127 (3.4028235E38) 


numbers between 2 -1074 (4.9E-324) and (2-2-52)×2 1023 

(1.7976931348623157E308) 

When using the integer and long types, data can be lost if the input number or calculated number 

from an operation contains decimal data. 

Using the Output Tab 

The Output tab allows you to determine the format in which your output should be returned. 

User's Guide 


53


Math 

54 

Table 7: Output Options 

Option 

Return one row per group 

Return a count of rows in 

each group 

Return a unique ID for each 

group 

Description 

Only one row per group, which includes the grouped fields as well as the 

output from Operations, will be returned; all other field data will be 

dropped. If this option is not selected, all rows will be returned, including 

the output from Operations (duplicated for each row in a group); no data 

will be dropped. Not valid with ZScore. 

Returns the count of rows in each group. The default field name is 

GroupCount. 

Returns a unique ID for each group. The ID starts at 1 and increments 

by 1 for each additional group found. The default field name is GroupID. 

The Math stage handles mathematical calculations on a single data row and allows you to conduct a 

variety of math functions using one or more expressions. Data is input as strings but the values must be 

numeric or Boolean, based on the type of operation being performed on the data. 

1. Under Control Stages, click the Math stage and drag it to the canvas, placing it where you want on 

the dataflow. 


3. Double-click the Math stage. The Math Options dialog box appears, with the Expressions tab open. 

This view shows the input fields, the Calculator, and the Expressions canvas. Alternately, you can 

click the Functions tab to use functions instead of the Calculator. 

The Input fields control lists the valid fields found on the input port. Field name syntax is very flexible but 

has some restrictions based on Groovy scripting rules. If you are not familiar with Groovy scripting, see 

this website for complete information on Groovy:groovy.codehaus.org 

The Calculator control contains buttons for entering numeric constants and operators into an expression. 

Double-clicking fields, constants, operators, and functions will insert them into an expression. For more 

information, see Using the Calculator on page 55. 

The Functions control contains a list of valid functions you can use in the Math stage. For more information, 

see Using Functions and Constants on page 56. 

The Expressions console allows you to create and enter your expressions. For more information, see 

Using the Expressions Console on page 59. 

Below the Expressions console is the error console. When a syntax error is detected, a grid displays 

that lists the error(s). Select the error to select the given line\column in the Expressions editor. 

The Fields control allows you to change input and output field types. For more information, see Using 

the Fields Control on page 60. 

The Preview control allows you to test math expressions. For more information, see Using the Preview 

Control on page 61. 


Using the Calculator 

Table 8: Calculator Operators 

Operator 

Backspace 

pi 

e 

/ 

* 

+ 

- 

x^y 

Mod 

; 

= 

() 

. 

if\else 

if\else if\else 

== 

!= 

&& 

|| 

> 

>= 

< 


56 

Using Functions and Constants 

The Math stage provides several functions that can be used in an expression. Functions take the general 

form function(parameter); function(parameter,parameter); function(parameter,...), where "parameter" is 

a numeric constant, a variable, or a math expression. Functions can be used with other math expressions 

(e.g., x=Sin(y)*Cos(z)). 

Constants, Conversion, Math, and Trigonometry. Each of the supported functions is listed below within 

its corresponding category. 

Table 9: Supported Functions 

Function 

Constants 

e 

false 

Infinity 

NaN 

Pi 

true 

Conversion 

Abs (value) 

Ceil (value) 

DegToRad (value) 

Floor (value) 

RadToDeg (value) 

Round (value) 

Math 

Description 

A mathematical constant that is the base of the natural algorithm. 

A Boolean constant that represents the value false. 

A mathematical constant that represents infinity. 

A mathematical constant that represents a value that is not a number. 

A mathematical constant that is the ratio of the circumference of a circle to 

its diameter. 

a Boolean constant that represents the value true. 

Takes one parameter. 

Returns the absolute value of the given value. 


Returns a rounded-up value (e.g., Ceil(5.5) returns 6). 


Converts a given value from degrees to radians. 


Returns a rounded-down value (e.g., Ceil(5.5) returns 5). 


Converts a given value from radians to degrees. 


Returns a rounded value. 


Function 

Avg (value, value,...) 

Exp (value) 

Fac (value) 

Ln (value) 

Log (value) 

Max (value, value,...) 

Min (value, value,...) 

Sqrt (value) 

Sum (value) 

Trigonometry 

ArcCos (value) 

ArcSin (value) 

ArcTan (value) 

Cos (value) 

User's Guide 

Description 

Takes one or more parameters. 

Returns the average of all given values. 


Returns Euler's number raised to the power of the value. 


Returns the factorial of a given value (e.g., Fac(6) is computed to 

6*5*4*3*2*1 and returns 720). 


Returns the natural logarithm (base e) of a given value. 


Returns the natural logarithm (base 10) of a given value. 


Returns the maximum value passed in. 


Returns the minimum value passed in. 


Returns the square root of the value passed in. 


Returns the sum of the given values. 


Returns the arc cosine of a value. 


Returns the arc sine of a value. 


Returns the arc tangent of a value. 


Returns the cosine of a value. 


57


58 

Function 

Ln (value) 

Sin (value) 

Tan (value) 

Using Conditional Statements 

Description 




Returns the sine of a value. 


Returns the tangent of a value. 

Conditional statements can be used to take actions depending on whether various conditions evaluate 

to true or false. Grouping using parentheses ( and ) can be used for more complex conditions. 

Table 10: Conditions 

Condition 

Equals 

Not Equals 

Greater Than 

Greater Than or Equal To 

Less Than 

Less Than or Equal To 

Not condition 

And 

Or 

If Statement 

Description 

expression = = expression 

expression != expression 

expression > expression 

expression >= expression 

expression < expression 

expression

actions to take if condition is true 

} 

else if... 

if(SideLength != NaN) 

{ 

AreaOfPolygon= 

((SideLength^2)*NumberOfSides)/ 

(4*Tan(pi/NumberOfSides)); 

} 

else if(Radius != NaN) 

{ 


(Radius^2)*NumberOfSides*Sin((2*pi)/NumberOfSides)/2; 

} 

One or more else if statements can be specified. Brackets are needed only if more than one statement 

is executed after the "else if\else if." 

If\Else If\Else Statement 

if(condition) 

{ 


} 

else if(condition) 

{ 


} 

else if... 

else 

{ 

actions to take if no conditions are met 

} 

Brackets are needed only if more than one statement is executed after the "if\else if\else." 

Using the Expressions Console 

The Expressions console is used to enter math expressions to be evaluated by the Math stage. The Input, 

Calculator, and Functions controls are used to insert values into this console. You can also manually 

type expressions into the console. Expressions take the form of a constant, variable, or math operation, 

and consist of numeric constants and variables. Numeric constants are whole or decimal numbers, which 

can be signed. Variables represent data from the incoming row; for example, if fields x, y, and z are 

defined in the input, then x, y, and z can be used in an expression. Variables are replaced with field 

values at runtime. 

The Math stage also allows grouped expressions, which involve using parentheses to group expressions 

and override operator precedence. For example, 2*5^2 equals 50, while (2*5)^2 equals 100. 

Note: 

Every expression you enter must end with a semi-colon. 

Additionally, conditional statements can be used in the Expressions console to take actions depending 

on whether various conditions evaluate to true or false. See Using Conditional Statements on page 

58 for more information on conditional statements. 

User's Guide 


59


60 

The Math stage deals primarily with assignment expressions, in which the output from an expression is 

assigned to a variable. Multiple assignment operations are supported in the stage and can use the output 

of a previous assignment operation. 

Assignment Expression Examples 

In the scenario below, x=10 and z=1000: 

x=5+5 

z=x*100 

In the scenario below, the area of a polygon is calculated based on the length of one side and the number 

of sides. 




Using the Fields Control 

The Fields control allows you to change input and output field types. You can change field types from 

within this control by clicking the drop-down arrow in the Type column and selecting from the list, which 

includes the following options: 

Table 11: Type 

Type 

Boolean 

Double 

Float 

Description 

A logical type with two values: true and false. Boolean variables can be 

used in conditional statements to control flow. The following code sample 

shows a Boolean expression: 

if(x && y) 

z=1; 

else if(x) 

z=2; 

else if(y) 

z=3; 

else 

z=4; 

A numeric data type that contains both negative and positive double 

precision numbers between 2 -1074 and (2-2 -52 )×2 1023 . In E notation, the 

range of values is 4.9E-324 to 1.7976931348623157E308. For information 

on E notation, see: 



numbers between 2 -149 and (2-2 23 )×2 127 . In E notation, the range 

of values is 1.4E-45 to 3.4028235E38. For information on E notation, 

see: 



Type 

Integer 

Long 

Using the Preview Control 

Description 

A numeric data type that contains both negative and positive whole 

numbers between -2 31 (-2,147,483,648) and 2 31 -1 (2,147,483,647) 


numbers between -2 63 (-9,223,372,036,854,775,808) and 2 63 -1 

(9,223,372,036,854,775,807) 

The Preview control allows you to test math expressions. Fields are listed in the Input Data area; you 

can provide specific values to pass to the expression and view the output in the Results area beneath 

Input Data. 

Numeric fields are initialized to 0 (0.000 for double) and boolean fields are initialized to False. Double 

and float fields are limited to four decimal places, and integer and long fields have no decimal places. 

Query DB 

The Query DB stage allows you to use fields as parameters into a database query. For example, if you 

read the field "AddressLine1" from a flat file, you can create a query to select from a database with the 

value for AddressLine1 as a parameter value. It supports the following data types: 

Data Type 

double 

float 

integer 

long 

string 

Description 




see: 







between -2 31 (-2,147,483,648) and 2 31 -1 (2,147,483,647) 


between -2 63 (-9,223,372,036,854,775,808) and 2 63 -1 

(9,223,372,036,854,775,807) 



User's Guide 


61


62 

Data Type 

String Types 

CHAR 

VCHAR 

LONGVARCHAR 

NCHAR 

NVARCHAR 

Numeric Types 

TINYINT 

SMALLINT 

INTEGER 

BIGINT 

REAL 

DECIMAL 

DOUBLE 

FLOAT 

NUMERIC 

Boolean Types 

BIT 

BOOLEAN 

Note: 

Description 

string 

string 

string 

string 

string 

integer 

integer 

integer 

long 

float 

double 

double 

double 

double 

boolean 

boolean 

If you want to query a spatial database, use Query Spatial Data instead of Query DB. 

To define a query database: 

1. Under Control Stages, click Query DB and drag it to the canvas, placing it where you want on the 

dataflow. 

2. Double-click the icon. The Query DB Options dialog box appears. 






5. If you want to use a "where" statement, enter it in the Where field (note that you should not actually 

include the word "where" in the statement). The purpose of a "where" statement is to filter input records. 

After entering a "where" statement, click Preview to see a preview of the data (first 50 records) based 

on the criteria you defined. 


6. By default, Return records with no results is checked. This means that if the query returns no 

results the record will still be returned by Query DB. If you clear this check box, the record will not 

be returned and will in effect be lost. We recommend that you leave this option checked. 

7. In the fields table, select the fields you want to include by clicking the Include box next to the field. 







1. In the Query DB Options dialog box, click Manage. 





• Connection Options—Specify the host, port, instance, user name, and password. 

Note: 




A Record Combiner combines two or more records from multiple stages into a single record. Record 

Combiners can have one or more stage input ports, depending on how you define them. The input ports 

are numbered consecutively, beginning with zero, shown as "port". The stage input ports generally 

connect to a Record Combiner, which then combines the records, processes them, and puts them into 

one sink (output) file. For example, you can have one group of records from one stage input file (port) 

and the other group from a second stage input file (port 2), and the records will merge into a single record. 

If you delete a middle stage, the ports will not renumber consecutively. 

Note: 

The Record Combiner will not release a record on output until each of its input ports has received 

a record. It must combine as many records as it has input ports before outputting a record. 

1. Under Control Stages, click the Record Combiner and drag it to the canvas, placing it where you 


2. Double-click the Record Combiner. The Record Combiner Options dialog box appears. This dialog 

box shows potential conflicts between multiple records and allows you to resolve them by determining 

which port takes priority or by allowing you to enter your own expression. 

3. Click OK when you are done. 

User's Guide 


63


Record Joiner 

64 

A Record Joiner uses SQL query-style logic to combine streams of records (from files, database tables, 

or stage outputs) based on a relationship between columns in those streams. The query compares a 

field in one stream to a field in another stream and returns rows, or records, based on the type of join 

you specify. 

You can select from three types of joins: 

• Inner Join—Returns all rows that have a match between the driving port and another port. For instance, 

if you have four input sources and port 1 (named "port") is the driving port, an inner join will return 

rows with matching fields between port and port 2, port and port 3, and port and port 4. 

• Left Outer Join—Returns the results from the inner join in addition to all remaining rows from the 

driving port, with field values for the driving port fields and "null" as the value for the other port's fields. 

• Full Join—Returns the results from the inner join in addition to all remaining rows from the driving 

port—with "null" as the value for the other port's fields—and all remaining rows from the other port—with 

"null" as the value for the driving port's fields. 

Record Joiners require two or more stage input ports. The stage input ports connect to a Record Joiner, 

which then analyzes the records based on your query and puts them into one sink (output) file or table. 

To configure the Record Joiner stage: 

1. Under Control Stages, click the Record Joiner and drag it to the canvas, placing it where you want 


2. Attach your input files. 

3. Double-click the Record Joiner. The Record Joiner Options dialog box appears. 

4. In the Driving Port field, select the port whose source data you want to match against. This will 

cause the Join definitions box to populate with associations between the driving port and each other 

port. 

5. In the Join type field, select the type of join you want to perform against the driving port. 

6. In the Join field field, select the field on which you want to perform the join. All the fields from the 

driving port input file are available. 

7. Click the Incoming data is sorted check box if the data in the driving port input file is already sorted. 

8. In the Join definitions box, click the definition you'd like to specify fields for and click Modify. The 

Specify Join dialog box appears. 

Note: 

The first drop-down box is disabled; if you want to change the driving port field, you need to 

return to the Record Joiner Options dialog box and change it in the Join field field. 

9. In the second drop-down box, select the field from the other port that corresponds to the field from 

the driving port and click OK. 

10. Column resolutions displays fields that are found in two inputs, as well as the default port number 

whose data will appear in the output for that field. If you want the output to contain field data from a 

different port, you can change the port by clicking the Port number selecting the other port. 


To modify a join definition: 

1. Click the join definition you want to modify and click Modify. 


Sorter 

2. Change the non-driving port join field as desired. 

3. Click the Incoming data is sorted check box if appropriate. 

4. Click OK. 

A Sorter sorts data by fields. Sorters have one stage input port that connects to a Sorter, which then 

sorts the records based on fields that you designate. For example, you can have records sorted into 

names, cities, or any other field in your dataflow. 

1. Under Control Stages, click the Sorter and drag it to the canvas, placing it where you want on the 

dataflow. 

2. Double-click the Sorter. The Sorter Options dialog box appears. This dialog box allows you to set 

the fields by which you want to sort, determine the order in which they are sorted, and determine the 

order of the fields in the output. 

3. Click Add. A blank field line will appear in the sort table. 

4. Click the down-arrow in the Field Name column and select the field that you want to sort. 

Note: 

The list of available fields depends on what stages are in the dataflow. 

5. Determine whether you want the field to be sorted in ascending or descending order and select the 

appropriate option in the Order column. 

6. Determine what type of data the field is and select the appropriate option in the Type column. Your 

options include the following: 

Data Type 

double 

float 

integer 

long 

string 

User's Guide 

Description 


numbers between 2 -1074 and (2-2 -52 )×2 1023 . In E notation, the range 

of values is 4.9E-324 to 1.7976931348623157E308. For information on E 

notation, see: 



numbers between 2 -149 and (2-2 23 )×2 127 . In E notation, the range of 

values is 1.4E-45 to 3.4028235E38. For information on E notation, see: 



between -2 31 (-2,147,483,648) and 2 31 -1 (2,147,483,647) 


between -2 63 (-9,223,372,036,854,775,808) and 2 63 -1 

(9,223,372,036,854,775,807) 


Note that if your incoming data is not in string format, the Type column will be disabled. 


65


Splitter 

66 

7. To remove blank space from before and after the value before sorting, check the box in the Trim 

column. The trim option does not modify the value of the field. It only trims the value for the purpose 

of sorting. Note that if your incoming data is not in string format, the Trim column will be disabled. 

8. Repeat steps 3 - 7 until you have added all the fields you want to sort. 

9. Rearrange the order of the fields as desired by clicking Up or Down. 


dialog box. The Advanced Options dialog box contains the following sort performance options: 


options. 






disk. 

Note: The combination of sort performance option settings that will result in optimal sorting efficiency 

is highly dependent on your server's hardware configuration. Nevertheless, good sort performance 

results have been observed when using the following general guideline: 

(in_memory_record_limit × maximum_number_of_temporary_files_to_use ÷ 2) >= 

total_number_of_rows_to_be_sorted Be aware that in environments where there are concurrently 

running jobs, increasing the In Memory Record Limit setting increases the likelihood 

of running out of memory. 

When you have finished specifying the additional sort performance options, click OK. 

11. Click OK. 

Note: 

You can remove the sort criteria as desired by highlighting a row and clicking Remove. 

A Splitter deconstructs a group of data, or a list, and puts it into data rows. Splitter dataflows have one 

stage input port that connects to a Splitter and then one output port that delivers data from the Splitter 

to the next stage. 

Below is an example of how the Splitter can be used in a dataflow. Click here to go directly to instructions 

on using the Splitter. 

One way you could use the Splitter's functionality is to take a list of information in a file and extract each 

discrete item of information into its own data row. For example, your input could include landmarks 

within a certain distance of a latitudinal/longitudinal point, and the Splitter could put each landmark into 

a separate data row. Another example would be to take output from a routing stage that includes driving 

directions and put each direction (or list item) into a data row. The dataflow for this type of function might 

look like the following: 



1. The Read from File stage contains latitudes, longitudes, and input key values to help you identify 

the individual points. 

2. The Aggregator stage builds up the data from the Read from File stage into a schema (a structured 

heirarchy of data) and identifies the group of latitudes and longitudes as a list of route points, which 

is a necessary step for the next stage to work correctly. 

User's Guide 


67


68 

Click here for more information on using the Aggregator stage in a job. 

3. Location Intelligence Module's Get Travel Directions stage creates directions from one location to 

another using the route points from step 2. 

4. The Splitter stage establishes that the data should be split at the Route Directions field and that the 

output lists should include all of the possible fields from the Get Travel Directions stage. 


User's Guide 


The schema is structured as follows, with Route Directions and Route Points being the available list 

types for this job: 

69


70 

5. The Write to File stage collects the output from Step 4. 


User's Guide 





71


Using the Splitter Stage 

1. Under Control Stages, click the Splitter and drag it onto the canvas, placing it where you want on 

the dataflow and connecting it to input and output stages. 

2. Double-click the Splitter. The Splitter Options dialog box appears. 

3. Click the Split at drop-down to see other list types available for this stage. Click the list type you 

want the Splitter to create. The Splitter Options dialog box will adjust accordingly with your selection, 

showing the fields available for that list type. 

Alternatively, you can click the ellipses (...) button next to the Split at drop-down. The Field Schema 

dialog box appears, showing the schema for the data coming into the Splitter. The list types are 

shown in bold, followed by the individual lists for each type. Also shown is the format of those fields 

(string, double, and so on). Click the list type you want the Splitter to create and click OK. The 

Splitter Options dialog box will adjust accordingly with your selection, showing the fields available 

for that list type. 

4. Select which fields you want the Splitter to include on output by checking the Include box for those 

fields. 

5. Click OK. 


A Stream Combiner joins two or more lists of records from multiple stages. Stream Combiners have one 

or more stage input ports, depending on how you define them. The input ports are numbered consecutively, 

beginning with zero (0). The input ports generally connect to a Stream Combiner, which then 

combines the records, processes them, and puts them into one sink (output) file. For example, you can 

have one group of records from one stage input file (port[0]) and another group from a second stage input 

file (port[1]), and the records will merge into a single input file. 

Under Control Stages, click the Stream Combiner and drag it to the canvas, placing it where you want 


Stream Combiner has no settings to change. 

Transformer 

72 

The Transformer stage modifies field values and formatting. To use transforms, you must have at least 

a defined input, a stage, and a defined output in your job. Note that you can select more than one 

transform to execute on a field as long as the input and output field names are identical. 

Note: If you map a single field to two different output fields (for example, ValidateAddress.City to Output.City1 

and ValidateAddress.City to Output.City2), and you add transforms to each field, the 

transform for the secondary field must be executed first. You must change the execution order 

of the transforms to execute the second field transform (Output.City2) first. For more information, 

see Changing the Order of Transforms on page 73. 

1. Within an open job, service, or subflow, add a Transformer stage to your dataflow. 


2. Double-click the Transformer stage. The Transformer Options dialog box appears. 

3. Click Add. The Add Transform dialog box appears. 

4. Click the type of transform you want to add. 

General 

• Construct Field—Appends and concatenates constant values and input fields based on "template". 

It provides the functionality of both the "transformer create value" and "concatenation function" 

transformer in a single transform. 

• Copy—Copies the value from one field to another. 

• Custom—Uses simple scripting techniques to define a customized transform. For more information, 

see Creating Custom Transforms on page 74. 

• Status—Changes the Status field to a value of either Success or Fail. When set to Fail, an optional 

Description and Code may also be set. 

Formatting 

• Case—Changes casing upper or lower case. 

• Mask—Applies or removes characters from a field. 

• Pad—Adds characters to the left or right of the field value. 

String Transformations 

• Minimize Whitespace—Removes whitespace at the beginning and end of the field. It also replaces 

any sequence of whitespaces (such as multiple, consecutive spaces) to a single whitespaces 

character. 

• Remove Substring—Removes all occurances of a string from a field. For example, you could remove 

"CA" from the StateProvince field. 

• Substring—Copies a contiguous sequence of characters from one field to another. 

• Trim—Removes specified characters from the left, right, or both sides of a field. Note that this 

transform is case-sensitive. 

• Truncate—Removes a specified number of characters from the left, right, or both sides of a field. 

5. Repeat step 4 until you have added all the transforms you wish to add, and click Close. The Transformer 

Options dialog box will reappear with your selections. 

6. Click OK. 

Changing the Order of Transforms 

If you have more than one transform to be executed on a particular output field, you can define or alter 

the order in which they are executed. 


2. Select a transform and use the Move Up and Move Down buttons to rearrange the order of the 

transforms. The top transform will be executed first. 

Note: 

3. Click OK. 

User's Guide 


Dependent transforms cannot be moved above primary transforms (the transforms upon 

which the dependent transforms rely). 

73


74 

Creating Custom Transforms 

The Transformer stage provides a set of predefined transforms that will satisfy most of your needs to 

transform data. If the predefined transforms are not sufficient, you can write a custom transform using 

a Groovy script to accomplish what you need. If you are not familiar with Groovy scripting, see this 

website for complete information on Groovy: 


When using Groovy to create a custom transform, note the following: 

• Groovy scripts can contain logical branching constructs. The most common of these are if statements 

and switch statements. For more information see Groovy.codehaus.org/Logical+Branching. 

• The only looping construct you should need is the for loop. For more information on looping or syntax 

see Groovy.codehaus.org/Looping. 

Below are some of the commonly used string operation. For more information and additional operations, 

see the java.lang.String class at java.sun.com/j2se/1.4.2/docs/api/index.html or the Groovy 

java.lang.String class at Groovy.codehaus.org/groovy-jdk.html. 

Note: 

Objects of type String are immutable, meaning that they cannot be modified. 

Table 12: String Operations 

Operation 

length() : int 

startsWith(String value) : boolean 

endsWith(String value) : boolean 

toUpperCase() : String 

toLowerCase() : String 

substring(int startIndex, int endIndex) 

: String 

Retrieving Field Values 

Description 

Retrieve the number of characters in the String. 

Indicates whether the String starts with the specified 

value. 

Indicates whether the String ends with the specified 

value. 

Returns a new copy of the String whose characters 

are all Upper Case. Does not change the value of 

the String itself. 


are all Lower Case. Does not change the value of 


Returns a substring which includes the characters 

from startIndex through endIndex-1. 

To retreive a field value, use a field (column) name: data[String column] : def 

Setting Field Values 


To set a field value, use a field (column) name: data[String column]=def value : void 

Note: 

The row variable that was previously used to get and set data works only with String types and 

has been deprecated. The data variable can be used with all supported data types and it is 

suggested that it be used, as described above, instead of the row variable. 

Using Mask Transforms 

There are two types of masks: remove and apply. 

• Remove Mask—This type of mask extracts a pattern of characters from a string. For example: Input: 

(800)368 5806 Mask: (###)### #### Output: 8003685806 // Because '(' and ')' and are literals, 

they will be removed. All the numbers will be kept because # is a MASK character. Input: (800)368 

5806 Mask: *###*###*#### Output: (800)368 5806 // Because there are no literals in your mask, 

nothing will be removed (mask character * allows anything) 

• Apply Mask—This type of mask applies formatting to a string. For example: Input: 8003685806 Mask: 

(###)### #### Output: (800)368 5806 // Because '(' and ')' and are literals, they will be added 

to the output. All the numbers will be kept because # is a mask character. 

Mask characters indicate the valid characters that can be contained at a particular location of the input 

string. For instance, if you have an input where the first character is a number, the first mask character 

needs to be #. Anything in the input that matches this mask character will be kept in the output. 

There are two types of characters used in a mask: Mask Characters and Literals. 

Table 13: Mask Characters 

Character 

# 

' 

U 

L 

A 

? 

* 

H 

User's Guide 

Definition 

Any valid number, uses Character.isDigit. 

Escape character, used to escape any of the special formatting characters. 

Any character (Character.isLetter). All lowercase letters are mapped to upper 

case. 

Any character (Character.isLetter). All upper case letters are mapped to lower 

case. 

Any character or number (Character.isLetter or Character.isDigit) 

Any character (Character.isLetter). 

Anything 

Any hex character (0-9, a-f or A-F). 


75


76 

The other type of character you can use in a mask is a literal. This represents actual characters that are 

present in the string. When a Remove Mask transform is used, the input character must match the mask 

literal character exactly. If that is the case, then they will be removed from the input. Similarly, the literal 

characters will be added to the input in the position indicated by the mask definition when the Apply 

Mask transform is used. Examples of literals are ( and -. 

Note the following common mistakes: 

• In a remove mask, if the number of characters in the input do not match the number of mask characters, 

the transform will fail. For example: Input: 21045 Mask: #####-#### Output: The mask transform will 

fail. For the mask transform to be successful, the number of digits in the input must match the number 

of # characters in the mask, as well as the literal '-'. The output would be 21045. 

• In an apply mask, if the number of characters in the input do not match the number of mask characters, 

the transorm may produce an undesired result. For example: Input: 21045 Mask: #####-#### Output: 

The mask transform will not fail. Instead it will try to produce the desired result, even though 21045 

does not match the mask. The result is "21045- " (four spaces have been added after the dash). 

• Concatenating Fields 

This example concatenates the FirstName field and the LastName field into a value and stores it in 

the FullName field 

String fullname = data['FirstName'] + ' ' + data['LastName']; 

data['FullName']=fullname; 

This is an alternative approach to concatenation: 

Input: 

Field 1: AddressLine1 


Output: Address 

Script: 

address1 = data['AddressLine1']; 


data['Address']=address1+ ',' + address2; 

Parsing a Field 

In this example, if the PostalCode field is greater than five characters, it separates the five- character 

ZIP Code and the +4 portion and writes them to separate fields in the output row. 

if (data.get['PostalCode'].length() > 5) 

{ 

String postalCode = data['PostalCode']; 

int separatorPosition = postalCode.indexOf('-'); 

String zip = postalCode.substring(0, separatorPosition); 

String plusFour = postalCode.substring( 

separatorPosition + 1, 

postalCode.length(); 

data['Zip']=zip; 

data['PlusFour']=plusFour; 

} 

Conditional Processing 

This example sets the field AddressCity to the first address line and city name if the city is Austin. 

Input 

Field 1: City 



Output: AddressCity 

Condition: If City is Austin 

Script: 

city = data['City']; 

address1 = data['AddressLine1'] 

if(city.equals('Austin')) 

data['AddressCity']=address1 +',' + city; 

Augmenting Data 

The following script appends the word "Incorporated" to the end of the FirmName field. 

Input 

Field 1: FirmName 

Output: FirmName 

Script: 

firmname = data['FirmName']; 

constant = 'Incorporated'; 

if(firmname.length() > 0) 

data['FirmName']=firmname + ' ' + constant; 

Unique ID Generator 

What is Unique ID Generator? 

The Unique ID Generator stage creates a unique key that is used to identify a specific record. A unique 

ID is crucial for data warehouse initiatives in which transactions may not carry all name and address 

data, but must be attributed to the same record/contact. A unique ID may be implemented at the individual, 

household, business, and/or premises level. Unique ID Generator provides a variety of algorithms to 

create unique IDs. 

The unique ID is based on either a sequential number or date and time stamp. Custom business rules 

based on algorithms and input source fields can be appended to the ID. The sequential number or date 

and time stamp IDs are required and cannot be removed from the generated ID. 

The following example shows that each record in the input is assigned a sequential record ID in the 

output. 

Record 

John Smith 

Mary Smith 

Jane Doe 

John Doe 

User's Guide 

RecordID 

1 

2 

3 

4 


77


78 

Defining a Unique ID 

1. Double-click on the instance of Unique ID Generator on the canvas. The Show Options for Unique 

ID Generator dialog box displays. 

Note: 

The Unique key is always displayed in a different color and cannot be deleted. 

2. Select the existing unique key and click the Modify button. The Unique Key dialog box displays. 

3. Select the unique key option you want. The options are: 

• Sequential Numeric Tag—Assign an incremental numeric value to each record. In the Starting 

at field, enter the number at which you want to start the sequence. 

• Date/Time Stamp—Create a unique key based on the date and time stamp 

4. Click OK. 

Appending a Unique ID Field 

The Unique ID Field option allows you to select from several algorithms and input source fields to append 

data to the sequential numeric or Data/Time stamp record id. 

To define a Unique ID field: 

1. Click the Add button. The Unique ID Field Options dialog displays. 

2. Click the Algorithm drop down box and select the appropriate algorithm. 

3. Click the Field name drop down box to select a field from the input source. 

4. Specify the starting position within the selected field. 

5. Specify the length of characters to include from the starting position. 

Note: 

Not all algorithms allow you to specify a start position and length. 

6. Pre-processing occurs before an algorithm is applied in creating a unique ID. 

Note: 

When Sort input is selected for pre-processing, Unique ID Generator inactivates the metaphone 

and soundex algorithms. 

• Remove Noise Characters: Removes all non-numeric and non-alpha characters such as hyphens, 

white space, and other special characters from an input field. 

• Sort Input: Sorts all characters in an input field or all terms in an input field in alphabetical order. 

• Characters: Sorts the characters values from an input field prior to creating a unique ID. 

• Terms: Sorts each term value from an input field prior to creating a unique ID. 

7. Click OK to save your settings. 

8. Repeat steps 1-7 to continue adding fields to the unique ID. 


Output 

Table 14: Unique ID Generator Outputs 

Field Name 

RecordID 


Description / Valid Values 

Identifies a record by assigning a unique number. 

Primary stages are the core of any dataflow. They generally perform the processing necessary to achieve 

a specific business goal, such as standardizing addresses, geocoding, or name standardization. There 

are two kinds of primary stages: 

• Module Stages on page 79 

• Subflows on page 79 

Module Stages 

MapInfo Spatial Server modules provide a variety of data quality processing capabilities, such as address 

validation, geocoding, best-of-breed processing, and more. When you license one of these modules, 

the module's stages are available in the Primary Stages folder in Enterprise Designer. To use one of 

these stages, drag the stage from the palette to the canvas. For information on each stage, see Modules 

on page 287. 

Subflows 

Subflows are dataflows that can be reused by multiple dataflows. Subflows that are saved and exposed 

are displayed in the User Defined Stages folder in Dataflow Components, while system-deployed 

stages are displayed in the Deployed Stages folder. For information on creating and managing 

subflows, see Subflows on page 155. 

To add a subflow: 

1. Open a dataflow. 

2. In User-Defined Stages, drag the subflow onto the canvas and into the dataflow as desired. 

3. Drag out a source and sink and connect them to the subflow. 

User's Guide 


79

Sinks 

Sinks 

A sink is the last stage in a job. Sinks define what to do with the output (write to a file or database) and 

can also perform other actions at the end or a dataflow, such as executing a program. The following 

sinks are used in jobs: 

• Write to File on page 80 

• Write to DB on page 83 

• Write to Null on page 86 

• Terminate Job on page 86 

• Execute Program on page 86 

Write to File 

80 

The Write to File stage defines an output file and the fields in that file. To configure a Write to File stage, 

1. Define the Output File on page 80 

2. Add Output Fields on page 82 

3. Sort Output Fields on page 82 

4. Set Output Runtime Properties on page 83 

Define the Output File 

Note: 

You can copy your source and paste it as the sink into your dataflow to quickly set up the file 

and use the same fields as you defined in your source. 

1. In the Toolbox, click the Write to File sink and drag it onto the canvas. 

2. Connect a stage output to Write to File. 

3. Double-click the Write to File stage. The Write to File Options dialog box appears. 

4. Click the ellipsis button next to the File name field. Navigate to your file or navigate to where you 

would like the file to reside, enter the name of the output file you are creating, and click Open. Your 

file will be displayed in the File name field. 

Note: 


5. In the Record Type field, specify the format of the records. 

6. In the Character Encoding field, specify the encoding method. 

7. If you are using a delimited file, choose the delimiter in the Field Separator field. If your file includes 

a different field separator than those listed, do the following: 

8. Click the ellipsis button to access the Manage Field Separators dialog box. 

9. Click Add. The Add Separator dialog box appears. 

10. In the Character field, enter the character that your file uses as a separator. If you prefer, you may 



11. After you enter or select a character press the Tab key The Unicode field will automatically be completed. 


completed. 

12. (Optional) Enter a description of the character in the Description field. For example, if the character 

is "&" the description could be "ampersand." If you do not enter a description, the character will appear 



14. If you are using a delimited file, complete the Text Qualifier field by selecting the appropriate qulifier 

character. If your file includes a different text qualifier than those listed, do the following: 

15. Click the ellipsis button to access the Manage Text Qualifiers dialog box. 


17. In the Character field, enter the character that your files uses as a separator . If you prefer, you may 


18. After you enter or select a character press the Tab key. The Unicode field will automatically be 

completed. Alternatively, you may enter the unicode value and the Character field will automatically 

be completed. 


is "#" the description could be "hash mark." If you do not enter a description, the character will appear 



21. If you want to use the normal end of line (EOL) characters for the platform on which the MapInfo 

Spatial Server server is installed, select the Use default EOL check box. If not, uncheck the box and 

specify the record separator you want to use in the Record Separator field. If your file includes a 

different record separator than those listed, complete the following steps: 

• Click the ellipsis button to access the Manage Record Separators dialog box. 

• Click Add to access the Add Separator dialog box. 

• Enter the character that your file uses as an EOL separator in the Character field. If you prefer, 

you may enter the character by clicking the Character Map button and selecting from the lists 

provided. 

• After you enter or select a character press the Tab key. The Unicode field will automatically be 


be completed. 

• (Optional) Enter a description of the character in the Description field. For example, if the character 

is "%" the description could be "percentage sign." If you do not enter a description, the character 

will appear by itself in the list of available characters. 

• Click OK twice. 

22. If you are using a line sequential or fixed width file, complete the Record Length field by entering the 

length of the records in the input file. For line sequential files, the number must be the minimum 

length of the record (but can be longer); for fixed width files, this number must be exact. 

23. If you are using a delimited file with a header row, click the First Row is a Header Record check box. 

The file viewer will update to highlight the header contents. The header row might contain generic 

terms ("Name," "Address," and so on) rather than specific information. 

User's Guide 


81

Sinks 

82 

Note: If you later remove fields from a delimited file with a header record, you must leave at least 

one field within this screen. Otherwise, Enterprise Designer will repopulate this screen with 

all fields the next time you click on the Fields tab. 

24. When you are satisfied with your selections, click OK. You will return to the canvas. 

Add Output Fields 

1. Double-click the Write to File icon. The Write to File Options dialog box opens. 


3. Define the fields in your output records by selecting the appropriate field and clicking Add to add 

fields or clicking Remove to delete fields. You can also modify the position of a field by clicking 

Modify and changing the position as desired. If your file is delimited and contains a header record, 

you can add all fields from the output file by clicking Regenerate. Click Quick Add to view a list of 

all available fields from upstream stages. 

Note: 


4. Enter the Name of the field you are adding to the output file. 

5. The Type field will automatically populate. If you are adding a field that exists upstream in your 

dataflow, the Type field will populate with the necessary type; otherwise, it will populate with string 

as the type. Note that you are able to override these entries if you like. Supported types include 

boolean, double, float, integer, long, and string. 





8. When you have named and mapped all your output fields, click OK. 

Sort Output Fields 

You have the option to sort your output file records by one or more output fields. 

1. Double-click the Write to File icon. The Write to File Options dialog box appears. 


3. Click Add. 


to sort by. 

Note: 

The fields available for selection depend on which stages you are using in this dataflow. 


6. Repeat until you have added all the output fields you want to use for sorting. 

7. Change the order of the sort by highlighting the row for the field you wish to move and clicking Up 

or Down. 


dialog box. 

The Advanced Options dialog box contains the following sort performance options: 



options. 

• In Memory Record Limit—Specifies the maximum number of data rows a sorter will hold in memory 

before it starts paging to disk. 

• Maximum Amount of Temporary Files to Use—Specifies the maximum number of temporary files 

that may be used by a sort process. 


disk. 


is highly dependent on your server's hardware configuration. Nevertheless, good 

sort performance results have been observed when using the following general guideline: 





When you have finished specifying the additional sort performance options, click OK to close the 

Advanced Options dialog box and return to the Write to File Options dialog box. 


Set Output Runtime Properties 

You can specify whether to overwrite or append output records by setting runtime properties. 



3. Select either Overwrite or Append. 

4. Click OK. 

Write to DB 

The Write to DB stage is an output stage that writes to a database or a view. It supports the following 

data types: 

Data Type 

double 

float 

User's Guide 

Description 




see: 






83

Sinks 

84 

Data Type 

integer 

long 

string 

Description 



between -2 31 (-2,147,483,648) and 2 31 -1 (2,147,483,647) 


between -2 63 (-9,223,372,036,854,775,808) and 2 63 -1 

(9,223,372,036,854,775,807) 



Data Type 

String Types 

CHAR 

VCHAR 

LONGVARCHAR 

NCHAR 

NVARCHAR 

Numeric Types 

TINYINT 

SMALLINT 

INTEGER 

BIGINT 

REAL 

DECIMAL 

DOUBLE 

FLOAT 

NUMERIC 

Boolean Types 

BIT 

BOOLEAN 

Note: 

Description 

string 

string 

string 

string 

string 

integer 

integer 

integer 

long 

float 

double 

double 

double 

double 

boolean 

boolean 

Due to a limitation of SQL Server, you cannot write to views that reference more than one table. 

To define a database sink: 


1. Under Sources and Sinks, click Write to DB and drag it to the canvas. 

2. Double-click the icon. The Write to DB Options dialog box appears. 

3. Select the connection for the database you want to use in the Connection field. Your choices vary 

depending on what connections you have defined in the Connection Manager section of the Management 

Console. If you need to make a new database connection, click Manage and enter the appropriate 

connection information. For more information, see Database Connection Manager on page 

85. 

4. Click the Browse button ([...]) to navigate to the database or view that you want to use. 


field. 

Note: 

It is recommended that you have a sorted index or key in the database table to prevent poor 

update performance. 


The Database Connection Manager allows you to manage registered database connections. To add, 

modify, delete, and test connections: 

1. In the Write To DB Options dialog box, click Manage. 






Note: 



Setting the Write Mode 

1. Click the Runtime tab to determine the write mode for the database. 

2. Select Insert, Update, or Insert if not able to update. 

Note: If you select Update, the primary key column name used in the input table must match the 

primary key column name in the output table. If you try to update a table where the primary 

key column name does not match the input, or where the primary key column is not defined, 

the update will not work. 

3. Select Batch commit to commit changes to the database after every 100 records are processed. 

By default this option is not selected, which means that changes are committed after each record is 

processed. Selecting this option can significantly improve the performance of the Write to DB stage. 

4. Click Truncate table before inserting data if you want Enterprise Designer to clear all data from 

the table before writing to the database. 


User's Guide 


85

Sinks 

Write to Null 

The Write to Null stage places records into a trash-like sink. Records are counted but discarded. You 

might use this when you do not want records from a particular state, ZIP Code, and so on. 

To use a null stage: 

1. Add a Conditional Router to your dataflow. 

2. Add a Write to Null stage to your dataflow. 

3. Connect the stages and configure the Conditional Router to route the records you want to the Write 

to Null stage. The completed dataflow should look something like the following: 

Terminate Job 

The Terminate Job stage ends a job if certain criteria are found within a record. 

Note: 

Terminate Job is not available in services or subflows. 


2. Add a Terminate Job stage to your dataflow. 

3. Connect the stages and configure the Conditional Router. The Conditional Router should be configured 

to contain the criteria you want to trigger job termination. When a record is found that meets the criteria, 

it is passed to the termination stage and the job terminates, producing a message that says, 

"Job terminated by stage: ." The completed dataflow should look something like this: 


86 

An Execute Program Stage invokes an executable, such as a program or command line command, when 

it receives a record. To use an Execute Program stage in your dataflow: 

1. Click and drag the Execute Program stage to the canvas. 

2. Double-click the Execute Program stage. The Execute Program Options dialog box appears. 


3. In the Command Line field, enter an executable name and arguments (if applicable). The arguments 

can be data available in the dataflow; to access that data open the Field List dialog box by clicking 

the [...] (Browse) button. You can select from the following three contexts: Current Job ID, Current 

Job Name, or Current User Name. You can also select from the available fields—for example, Job- 

Status and JobComment. 

4. If you want to set a timeout limit, click Timeout in milliseconds and enter the number of milliseconds 

you want to set as the timeout limit. 

5. If necessary, add environment variables. 

6. Click Add. 

7. Enter the appropriate key word in the Key field. An example might be "JAVA_HOME". 

8. Enter the appropriate value in the Value field. An example might be "C:\ j2sdk1.4.2_04. Alternatively, 

you can select a field from the Field List dialog box by clicking the [...] (Browse) button. You 

can select from the following three contexts: Current Job ID, Current Job Name, or Current User 

Name. You can also select from the available fields—for example, JobStatus and JobComment. 

Runtime Options 

Dataflow options allow you to make options available for modification at runtime. For example, you could 

choose to allow the user to change only casing and postal code separator. These options can then be 

mapped to stages within a dataflow. 

Creating Dataflow Options 

1. Create a new job or service or open an existing job, service, or subflow. 

2. Click the Dataflow Options icon on the toolbar or click Edit > Dataflow Options. The Dataflow Options 

dialog box appears. 

3. Click Add. The Define Dataflow Options dialog box appears.> 

4. Enter a name in the Option Name field and press . You will see the same text appear in the 

Option Label field. 

5. Enter a description of the option in the Description field. 

6. The table at the bottom of the dialog box contains each of the services with a list of options underneath. 

Check the items you would like to set for this option. You will see the Default Value and Legal Values 

fields be completed with data when you select your first item. 

Note: Each of the items you select for an option must share legal values. For example, if your first 

item has values of Y and N (for "yes" and "no"), each of the additional items must have either 

Y or N in their set of values, and you can only allow the value in common to be selected by 

the user. So, if you select an item with Y and N values, you cannot select an item with the 

values of E, T, M, and L (Exact, Tight, Medium, Loose), but you could select an item with the 

values of P, S, and N (PO Box Match, Street Match, Normal Match) because both items share 

"N" as a value. However, only "N" would be an available value for this option, not "Y", "P", or 

"S"). 

7. If you want to limit the values users can select, edit the available options in the Legal Values field by 

clicking on the icon just to the right of the field. 

User's Guide 


87

Reports 

8. If you want to change the default value users will see, click the arrow next to the Default Value field 

and select the new default. 

9. Map the option to the appropriate target in the Target field. 

10. Click OK. 

11. Continue adding options as desired. 

12. Click OK in the Dataflow Options dialog box when you are done adding options. 

Modifying Dataflow Options 

1. Open the job, service, or subflow. 

2. Click the Dataflow Options icon or click Edit > Dataflow Options. The Dataflow Options dialog box 

appears. 

3. Highlight the option you want to change and click Modify. The Define Dataflow Option dialog box 

appears. 

4. Make changes as desired and click OK. 

Deleting Dataflow Options 



appears. 

3. Highlight the option you want to delete and click Remove. 

Reports 

This section describes how to use the Reports feature within Enterprise Designer jobs. 

• Adding a Report to a Job on page 88 

• Setting Report Options on page 89 

• Viewing Reports on page 89 

Adding a Report to a Job 

88 

1. Drag the report you want included onto the canvas from the Reports palette. You do not need to 

connect the report icon to anything. 

2. Double-click the report to view and set options at the job level. The Stages tab opens. 

3. Click any and all stages that you wish to contribute to the report. 

4. Click the Parameters tab. 

5. De-select the Use default reporting options box and select the appropriate output format if you 

wish to specify a format other than PDF (such as html or txt). 


Setting Report Options 

You can set report options in three different ways. 

• The highest level is through the Management Console, where default options are set. 

• The middle level is at the job level through Enterprise Designer. Options set here affect all reports 

within a particular job. 

• The lowest level is at the report level through the report icon in a dataflow. Options set here affect that 

particular job only. 

• Setting Options at the Management Console Level 

a) Expand Execution then click Report Options. 

b) Determine the output format by selecting html, pdf, or txt. 

c) Check the Store report snapshot box to have the system store information indicating that a report 

was registered as well as the actual report snapshot. 

d) Check the Archive reports box if you wish to save report snapshots. 

e) Check Overwrite existing reports if you want new reports to replace previous reports. 

f) Complete the Naming template to reflect how you want to name your reports. 

g) Enter or browse to the location where you want archived reports saved. 

Note: 

Jobs that do not override these settings will perform as you indicated above. 

• Setting Options at the Job Level 

a) In an open job, go to Edit > Job Options and click the Reporting tab. 

b) Deselect the Use global reporting options check box and set the options as you wish. You can 

change report format and various other parameters as defined by the report template. If you name 

a template for an archive report, the name of the stage is available only for stages that generate 

their own reports and register the finished products with the server, not to those that defer generation 

of reports to MapInfo Spatial Server. 

c) Click OK. 

• Setting Options at the Report Level 

a) Within an open job, drag out the icon for the report you wish to generate from the Reports palette. 

b) Double-click the report icon. 

c) Select the stage that you want to run this report. You can select only one stage per report. 

d) Click the Parameters tab. 

e) Deselect the Use default reporting options check box and set the options as you wish. 

f) Click OK. 

When you run your job, the Execution History will contain a column that shows if there are any reports 

that are associated with the job. An empty icon reflects no reports, one document icon reflects one report, 

and multiple documents icons reflect multiple reports. You can use the Job Detail to view, save, or print 

the report. 

Note: 

Viewing Reports 

To delete a report, right-click the report icon on the canvas and select Delete. 

To view reports, first run the job then do one of the following: 

User's Guide 


89

Running a Job 

• In Enterprise Designer, the Execution Details window will appear when you run your job. Select the 

report you want to view. 

• In the Management Console, in the Execution node, click History then select the job whose reports 

you want to view, then click Details. 

Running a Job 

There are two ways to run a job: through Enterprise Deisnger or at the command line. Before you run a 

job you should validate it and expose it. 

• Validating a Job on page 90 

• Exposing a Job on page 90 

• Running a Job in Enterprise Designer on page 90 

• Running A Job from the Command Line on page 91 

• E-mail Notification on page 94 

• Viewing Execution Status and History on page 94 

• Pausing a Job on page 95 

• Canceling a Job on page 95 

Validating a Job 

Validate a dataflow prior to running it to ensure that it contains no errors. To validate a dataflow, select 

Run > Validate. 

Exposing a Job 

Exposing a job makes to available to process flows and command line execution. To expose a job, select 

File > Expose or click the Expose button (the light bulb). 

Note: Any job stored in the system during a server upgrade is marked as exposed to provide the same 

behavior for those jobs as before the upgrade. Any job that is exported prior to the upgrade will 

not have the exposure flag set. Therefore, when importing these jobs back into the system, you 

must manually expose the imported job. 

Running a Job in Enterprise Designer 

90 

You can run a job on your full input file or on a partial set of records. (See Read From File on page 32 

for information on running partial jobs.) You can also choose to overwrite or append any existing data 

in the file when setting up the output. (See Set Output Runtime Properties on page 83.) 

Go to Run > Run current flow. The Execution Details window will appear. You can use this window to 

manage the execution of your jobs. 


Running A Job from the Command Line 

To run a job from the command line, download and save the Job Executer to a location on your system. 

The Job Executor is available from the MapInfo Spatial Server Welcome page on the MapInfo Spatial 

Server server (for example, http://myserver:8080). 

The Job Executor usage is: 

java -jar jobexecutor.jar [arguments] 

For example, this is a basic command line entry with a job name, user name, and password: 

java -jar jobexecutor.jar -j Job1 -u Bob1234 -p "" 

This example shows the same information as above but with additional arguments. 

java -jar jobexecutor.jar -j validateAddressJob1 -u Bob1234 -p "" -h g1server.mydomain.com 

-s 8888 -w -d "%" -i 1 -t 9999 

The following table lists the Job Executor arguments. 

Table 15: Job Executor Arguments 

Property= 

-? 

-D= 

-d= 

-e 

User's Guide 

-f= 

-h= 

-i= 

-j= 

-n 

Description 

Prints usage information. 

Sets a Java system property. 


Sets instance/status delimiter. This appears in synchronous output only. 

Use a secure SSL connection for communication with the MapInfo 

Spatial Server server. 

Specifies a path to a property file. For more information on property 

files, see Creating a Job Property File on page 93. 

Specifies the name or IP address of the MapInfo Spatial Server server. 

Specifies how often to check for completed jobs, in seconds. This applies 

only in synchronous mode. 

A comma-separated list of jobs to run. Job names are case-sensitive. 

Jobs are started in the order listed. 

Specifies a comma-separated list of additional email addresses for 

configured job notifications. 

91

Running a Job 

92 

Property= 

-o== 

-p= 

-r 

-s= 

-t= 

-u= 

-v 

-w 

-X= 

stagename=filename 

Description 

Specifies a path to a property file that contains overrides to options set 

in Enterprise Designer. For more information on property files, see 

Creating a Job Property File on page 93 

The password of the user. 

Returns a delimited list with the following information about the job 

written to standard output: 

• Position 1—Name of job 

• Position 2—Job process ID 

• Position 3—Status 

• Position 4—Start Date/Time (MM/DD/YYYY HH:MM:SS) 

• Position 5—End Date/Time (MM/DD/YYYY HH:MM:SS) 

• Position 6—Number of successful records 

• Position 7—Number of failed records 

• Position 8—Number of malformed records 

• Position 9—Currently unused 

The information is delimited using the delimiter specified in the -d argument. 

For example: 

MySimpleJob|4|succeeded|04/09/2010 14:50:47|04/09/2010 

14:50:47|100|0|0| 

The socket (port) on which the MapInfo Spatial Server server is running. 

The default value is 8080. 

Sets the timeout (in seconds) for synchronous mode. The default is 

3600. This is a global, aggregate timeout and represents the maximum 

time to wait for all spawned jobs to complete. 

The login name of the user. 

Return verbose output. 

Specifies to wait for jobs to complete in a synchronous mode. 

Sets a non-standard Java property. 

Overrides the input or output file specified in the job. For more information, 

see Overriding Read from File and Write to File Locations on 

page 93. 


The following example shows command line invocation and output: 

D:\g1\job-executor>java -jar jobexecutor.jar -u guest -p "" -j 

validateAddressJob1 -h g1server.mydomain.com -s 8888 -w -d "%" -i 

1 -t 9999 

validateAddressJob1%105%succeeded 

In this example, the output indicates that the job named 'validateAddressJob1' ran (with identifier 105) 

with no errors. Other possible results include "failed" or "running." 

Overriding Read from File and Write to File Locations 

To override the Read from File or Write to File locations, specify the Read from File or Write from File 

stage names along with the input or output file as the last arguments. For example: 

java -jar jobexecutor.jar -j Job1 -u Bob1234 -p "" -h g1server.mydomain.com 

-s 8888 -w -d "%" -i 1 -t 9999 "Read from File"="file:C:/myfile_input.txt" 

"Write to File"="file:C:/myfile_output.txt" 

Note: 

You must use forward slashes (/) in file paths, not backslahes. 

The stage name specified in the command line must match the stage label shown under the stage's icon 

in the dataflow. For example, if the input stage is labeled "Read From File" you would specify: 

"Read From File"="file:C:/inputfile.txt" 

If the input stage is labeled "Illinois Customers" you would specify: 

"Illinois Customers"="file:C:/inputfile.txt" 

If you override a Read from File or Write to File location, you need to specify a protocol: 

• If the file is on the same machine as the MapInfo Spatial Server server, start the path with the "file:" 

protocol. For example, on Windows specify "file:C:/myfile.txt" and on Unix or Linux specify 

"file:/testfiles/myfile.txt". 

• If the file is on the same machine as Job Executor, start the path with the "esclient:" protocol. For example, 

on Windows specify "esclient:C:/myfile.txt" and on Unix or Linux specify "esclient:/testfiles/myfile.txt". 

• If the client and server are running on the same machine, you can use either protocol, but are likely 

to have get better performance using the "file:" protocol 

• To use a file server defined in the Management Console, use the following format: "ftp:/". For example, ftp://FS/testfiles/myfile.txt 

where FS is a file server resource defined in Management Console. 

Creating a Job Property File 

A property file contains arguments that you can reuse by specifying the path to the property file with the 

-f argument. The property file must contain, at minimum, the job (-j) and user ID (-u). 

To create a process flow property file, open a text editor and put one argument on each line (see the 

table above for a list of arguments). Save the file with a file extension of .properties (for example, "example.properties"). 

For example: 

D=property=true 

d=% 

h=g1server.mydomain.com 

User's Guide 


93

Running a Job 

i=30 

j=validateAddressJob1 

u=user 

p=password 

s=8888 

t=9999 

w=true 

X=Xmx=1024M 

A combination of both command-line entry and property-file entry is also valid. For example: 

java -jar jobexecutor.jar -f /dcg/job.properties -j job1 

In this case command line arguments take precedence over arguments specified in the properties file. 

In the above example, the job job1 would take precedence over a job specified in the properties file. 

Scheduling a Job 

To schedule a job to run automatically, use the job scheduler in Management Console. For more information, 

see Scheduling Jobs and Process Flows on page 266. 

E-mail Notification 

You can have MapInfo Spatial Server notify you of certain conditions that arise during execution. Follow 

the steps below to set notifications. 

Note: 

Notifications must be set up in the Management Console before you can successfully use a notification 

from within Enterprise Designer. 

1. With an open dataflow or process flow, select Edit > Notifications. 

2. Click Add. 

3. In the Send Notification To field, enter the e-mail address to which notifications should be sent. 

4. Select the events you want to be notified about. 

5. In the Subject field, enter the text you would like to appear in the subject line of the e-mail. 

6. In the Message field, enter the text you would like to appear in the body of the e-mail. 

7. Click Preview if you wish to see what the notification will look like. 

8. Click OK. The Notifications dialog box will reappear with the new notification listed. 

9. Click OK. 

Viewing Execution Status and History 

94 

To track the progress of job execution and view execution history: 

1. Select View > Execution History in Enterprise Designer. 

The Execution History dialog box contains two tabs: Jobs and Process Flows. The Jobs tab is used 

to monitor job status and to pause, resume, or cancel jobs that are running as well as delete completed 

jobs. 

2. Select the fields you want displayed in the Execution History. 

a) Click the icon just to the left of the first column. 


) Select or deselect fields to include in the Execution History. The fields will populate and unpopulate 

automatically. 

c) Click the "x" in the top-right corner of the box to close the Field Chooser. 

3. Group columns as desired. To do this, highlight a column name (such as ID or Name) and drag it up 

to the area that says, "Drag a column header here to group by that column." 

4. Sort and filter the job list. 

a) Click on the drop-down list next to Show only jobs where to select a variable (such as ID). 

b) Select one of the criterion in the next drop-down (such as "greater than or equal to"). 

c) Type in a comparison value (such as zero) in the last box. 

d) Click Refresh to refresh the data. 

5. View job details. 

The Details screen allows you to view the job definition, which shows the dataflow. It also allows 

you to see how a dataflow was built if it is no longer accessible by Enterprise Designer. 

a) In the Jobs tab, select a job you wish to view and click Details.... 

b) If you are looking at a job, click the name of a report under Reports to view its output. You can 

save or print reports by clicking the appropriate icon at the top of the right pane. 

Pausing a Job 

To pause a job, select View > Execution History then click Pause. To continue a paused job, click 

Resume. 

Canceling a Job 

To cancel a job that is running, select View > Execution History then click Cancel. 

User's Guide 


95

Services 


• What is a Service? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .98 

• Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .98 

• Control Stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102 

• Primary Stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .142 

• Sinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .142 

• Setting Web Service Options . . . . . . . . . . . . . . . . . . . . . .151 

• Runtime Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152 

• Validating Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .154 

4

What is a Service? 

What is a Service? 

A service is a dataflow that is executed by an API call to MapInfo Spatial Server. Input data is passed 

to the service through the API. The service processes the data and returns the data through a response 

returned by the API. 

The following dataflow is a service. Note that it uses the Input stage for input and and Output stage for 

output. 

Note: Since the service name, option name, and field name ultimately become XML elements, they 

may not contain characters that are invalid in XML element names (for example, spaces are not 

valid). Please consult the xml specification for clarification ( www.w3.org/TR/REC-xml/#NT- 

Name ). Services not meeting this requirement will still function but will not be exposed as web 

services. 

Sources 

There is one type of source available for services: the Input stage. 

Input Stage 

98 

Defining Input Fields 

1. Drag an Input icon on the canvas then double-click it. The Input Options dialog box appears. 

2. Select the fields you want to use for input. The list of fields shown depends on the stage that the Input 

stage is connected to. 

3. To add a new field to the field list, click Add. The Add Custom Field dialog box appears. You can 

also modify or delete a custom field. 

4. Click Add again. 

5. Type the field name in the text box. 

6. Select the Data type and press OK. The following data types are supported: 


Data Type 

AccessibleNode 

boolean 

double 

float 

Geometry 

integer 

long 

RouteCostMatrix 

string 

Description 

A data type that returns a MultiPoint with one point for each node accessible 

for the isochrones or isodistances. Nodes are either intersections or significant 

geometry features. 

Note: 

This type is available only for the Location Intelligence Module. 

A logical type with two values: true and false. 










A data type that returns a MultiPolygon representing the area that can be 

reached for an iso. 

Note: 



between -2 31 (-2,147,483,648) and 2 31 -1 (2,147,483,647). 


between -2 63 (-9,223,372,036,854,775,808) and 2 63 -1 

(9,223,372,036,854,775,807) 

The total time and distance of an individual route. 

Note: 



You can also add a new, user-defined data type if necessary, and that new type can be a list of any 

defined data type. For example, you could define a list of names (string), or a new data type of addresses 

that includes AddressLine1 (string), City (string), StateProvince(string) and PostalCode 

(string). After you create the field, you can view the data type by accessing the Input Options dialog 

and pressing the button in the Data Type column. The Data Type Details dialog box will appear, 

showing the structure of the field. 

7. Press OK again. 

8. Click the check box next to Expose to select the check box of all fields in the field list. Selecting a 

field in the field list exposes it to the dataflow for stage operations. Click the check box again to clear 

User's Guide 

Chapter 4:Services 

99

Sources 

100 

Note: 

the check box for all fields in the list. Clearing the check box of one or more fields in the field list and 

clicking OK deletes the field from the field list. 

If you define hierarchical data in the input fields, you will not be able to import data or view the 

data vertically. 

Defining a Web Service Data Type 

The Data type name field allows you to control the WSDL (SOAP) and WADL (REST) interfaces for the 

service you are creating. The name of the Rows element is determined by the name you give this stage 

in the service, and the name of the Row element is determined by the text you enter here. 

Note: 

For WSDL, both requests and responses are affected, but for WADL only responses are affected. 

Prior to naming this stage and entering text in this field, your code might look like this: 

 

 

John 

Doe 

 

 

Jane 

Doe> 

 

 

After naming this stage and entering text in this field, your code might look like this: 

 

 

John 

Doe 

 

 

Jane 

Doe> 

 

 

Defining Inspection Data 

To use data inspection you must enter test data by following the steps below. 

Note: 

The Inspection Data tab allows you to specify test input records to use with the Data Inspection 

tool. For more information on data inspection, see Inspecting Dataflows on page 230. 


2. Click the Inspection Input tab. 

3. Enter inspection data using one of the following methods: 


Note: 

You can specify a maximum of 50 records. Likewise, certain field types have the restrictions 

when using inspection: 

Data Type 

double and float 

integer and long 

Description 

Can process numeric data only; supports up to 16 digits and 6 decimal 

places. Exponential notation is not supported. 

Can process numeric data only. 

• Manually enter data—If you want to use just a few records for inspection, you can manually type in 

the data, one record per line. 

• Import data from a file—If you have data in a CSV or TXT file, you can import the data by clicking 

Import Data. The data must use one of the following delimiters: 

• \t 

• | 

• , 

• ; 

• Copy and paste data—You can copy delimited data from another application and paste it into the 

inspection data editor. 

The Inspection Input tab indicates pass-through data by enclosing the field name in parentheses, as 

shown here: 

User's Guide 


101




and transforming. The control stages are: 

• Aggregator on page 102 

• Broadcaster on page 110 

• Conditional Router on page 111 

• Group Statistics on page 114 

• Math on page 117 

• Query DB on page 124 

• Record Combiner on page 126 

• Sorter on page 128 

• Splitter on page 129 

• Stream Combiner on page 135 

• Transformer on page 135 

Aggregator 

102 














following: 



following: 













User's Guide 


103


104 














User's Guide 

• Press OK. 






105


106 



dataflow: 











User's Guide 


107


108 










User's Guide 


109





highlighted. 




























9. 

Note: 

Broadcaster 

110 







dataflow. 













Note: 


editing. 



box appears. 













table. 


Operator 

Is Equal 

Is Not Equal 

User's Guide 

Description 






111


112 

Operator 

Is Null 

Is Not Null 

Is Empty 

Is Not Empty 

Is Less Than 


To 



Equal To 

Starts With 


Contains 


Description 












specified. 
















Operator 

Ends With 




Description 














true. 










{ 


} 









{ 


} 













114 







Region 

East 

East 

East 

West 

West 

State 






Double-click the Group Statistics stage. The Group Statistics Options dialog box appears, with the 



Output tab to change output settings. or more information, see Using the Output Tab on page 116 

MD 

MD 







group. 





Note: 



Operation 

Average 

Maximum 

Minimum 

User's Guide 

Description 

CT 

CA 

CA 





115


116 

Operation 


Percentile 

Percent Rank 

Sum 

Variance 

ZScore 

Description 






found. 











Data Type 

Integer 

Long 

Float 

Double 

Note: 

Description 


between -2 31 (-2,147,483,648) and 2 31 -1 (2,147,483,647) 


between -2 63 (-9,223,372,036,854,775,808) and 2 63 -1 

(9,223,372,036,854,775,807) 





(1.7976931348623157E308) 






Math 


Option 



each group 


group 

Description 







GroupCount. 







the dataflow. 





















User's Guide 


117


118 



Operator 

Backspace 

pi 

e 

/ 

* 

+ 

- 

x^y 

Mod 

; 

= 

() 

. 

if\else 


== 

!= 

&& 

|| 

> 

>= 

< 









Function 

Constants 

e 

false 

Infinity 

NaN 

Pi 

true 

Conversion 

Abs (value) 

Ceil (value) 


Floor (value) 


Round (value) 

Math 

User's Guide 

Description 






its diameter. 















119


120 

Function 


Exp (value) 

Fac (value) 

Ln (value) 

Log (value) 



Sqrt (value) 

Sum (value) 

Trigonometry 




Cos (value) 

Description 







6*5*4*3*2*1 and returns 720). 






















Function 

Ln (value) 

Sin (value) 

Tan (value) 


Description 










Condition 

Equals 

Not Equals 

Greater Than 


Less Than 


Not condition 

And 

Or 

If Statement 

Description 






expression


122 


} 

else if... 


{ 




} 


{ 



} 




if(condition) 

{ 


} 


{ 


} 

else if... 

else 

{ 


} 












Note: 











x=5+5 

z=x*100 


of sides. 









Type 

Boolean 

Double 

Float 

User's Guide 

Description 




if(x && y) 

z=1; 

else if(x) 

z=2; 

else if(y) 

z=3; 

else 

z=4; 










see: 


123


Type 

Integer 

Long 


Description 





(9,223,372,036,854,775,807) 



Input Data. 



Query DB 

124 




Data Type 

double 

float 

integer 

long 

string 

Description 




see: 







between -2 31 (-2,147,483,648) and 2 31 -1 (2,147,483,647) 


between -2 63 (-9,223,372,036,854,775,808) and 2 63 -1 

(9,223,372,036,854,775,807) 




Data Type 

String Types 

CHAR 

VCHAR 

LONGVARCHAR 

NCHAR 

NVARCHAR 

Numeric Types 

TINYINT 

SMALLINT 

INTEGER 

BIGINT 

REAL 

DECIMAL 

DOUBLE 

FLOAT 

NUMERIC 

Boolean Types 

BIT 

BOOLEAN 

Note: 

Description 

string 

string 

string 

string 

string 

integer 

integer 

integer 

long 

float 

double 

double 

double 

double 

boolean 

boolean 




dataflow. 











User's Guide 


125


















Note: 




126 








Note: 










Record Joiner 




you specify. 



















port. 







Note: 











User's Guide 


127


Sorter 

128 



4. Click OK. 





dataflow. 






Note: 






Data Type 

double 

float 

integer 

long 

string 

Description 











between -2 31 (-2,147,483,648) and 2 31 -1 (2,147,483,647) 


between -2 63 (-9,223,372,036,854,775,808) and 2 63 -1 

(9,223,372,036,854,775,807) 




Splitter 









options. 






disk. 









11. Click OK. 

Note: 













User's Guide 


129


130 













User's Guide 


131


132 





User's Guide 


133


134 



















fields. 

5. Click OK. 











Transformer 










User's Guide 


135


136 




General 









Formatting 







character. 









6. Click OK. 







Note: 

3. Click OK. 


















Note: 



Operation 







: String 


Description 



value. 


value. 











User's Guide 


137


138 


Note: 



















Character 

# 

' 

U 

L 

A 

? 

* 

H 

Definition 




case. 


case. 



Anything 


















User's Guide 






Input: 




Script: 








{ 









} 



Input 

Field 1: City 



139




Script: 







Input 



Script: 






140 











output. 

Record 

John Smith 

Mary Smith 

Jane Doe 

John Doe 

RecordID 

1 

2 

3 

4 





Note: 







4. Click OK. 










Note: 



Note: 










User's Guide 


141


Output 


Field Name 

RecordID 









Module Stages 





on page 287. 

Subflows 

Subflows are dataflows that can be reused by multiple dataflows. Subflows that are saved and exposed 


stages are displayed in the Deployed Stages folder. For information on creating and managing 

subflows, see Subflows on page 155. 

Sinks 

142 

To add a subflow: 

1. Open a dataflow. 

2. In User-Defined Stages, drag the subflow onto the canvas and into the dataflow as desired. 

3. Drag out a source and sink and connect them to the subflow. 

Sinks define what to do with the output data. The sinks for services are: 



• Output Stage on page 143 

• Write to DB on page 149 















6. Click Add. 






Output Stage 

Input Fields 

The Output stage defines the output fields that the service or subflow returns. Follow the steps below to 

define the service output. 

1. Double-click the Output icon on the canvas. The Output Options dialog box appears. When you 

open the Output Options dialog box for the first time, a list of fields defined in the Input is displayed. 






User's Guide 


143

Sinks 

144 

Data Type 


boolean 

double 

float 

Geometry 

integer 

long 


string 

Description 




Note: 














Note: 



between -2 31 (-2,147,483,648) and 2 31 -1 (2,147,483,647). 


between -2 63 (-9,223,372,036,854,775,808) and 2 63 -1 

(9,223,372,036,854,775,807) 


Note: 





that includes AddressLine1 (string), City (string), StateProvince (string) and PostalCode 










Note: 

If you define heirarchical data in the input fields, you will not be able to import data or view 

the data vertically. 


Defining a Web Service Data Type 

The Data type name field allows you to control the WSDL (SOAP) and WADL (REST) interfaces for the 

service you are creating. The name of the Rows element is determined by the name you give this stage 

in the service, and the name of the Row element is determined by the text you enter here. 

Note: 

For WSDL, both requests and responses are affected, but for WADL only responses are affected. 

Prior to naming this stage and entering text in this field, your code might look like this: 

 

 

John 

Doe 

 

 

Jane 

Doe> 

 

 

After naming this stage and entering text in this field, your code might look like this: 

 

 

John 

Doe 

 

 

Jane 

Doe> 

 

 

Write to File 







Note: 

User's Guide 




145

Sinks 

146 







Note: 












completed. 













be completed. 














provided. 



be completed. 











Note: 

If you later remove fields from a delimited file with a header record, you must leave at least 












Note: 












User's Guide 


147

Sinks 

148 





3. Click Add. 


to sort by. 

Note: 





or Down. 


dialog box. 



options. 






disk. 

















4. Click OK. 

Write to DB 


data types: 

Data Type 

double 

float 

integer 

long 

string 

Description 




see: 







between -2 31 (-2,147,483,648) and 2 31 -1 (2,147,483,647) 


between -2 63 (-9,223,372,036,854,775,808) and 2 63 -1 

(9,223,372,036,854,775,807) 



Data Type 

String Types 

CHAR 

VCHAR 

LONGVARCHAR 

NCHAR 

NVARCHAR 

Numeric Types 

TINYINT 

SMALLINT 

INTEGER 

User's Guide 

Description 

string 

string 

string 

string 

string 

integer 

integer 

integer 


149

Sinks 

150 

Data Type 

BIGINT 

REAL 

DECIMAL 

DOUBLE 

FLOAT 

NUMERIC 

Boolean Types 

BIT 

BOOLEAN 

Note: 

Description 

long 

float 

double 

double 

double 

double 

boolean 

boolean 









150. 



field. 

Note: 












Note: 

















Write to Null 








Setting Web Service Options 

Web service options allow you to specify if you want your service exposed as a web service via Simple 

Object Access Protocol (SOAP) or (Representational State Transfer) REST. 

Services deployed on the MapInfo Spatial Server are also published as web services. A web service is 

a collection of protocols and standards used for exchanging data between applications. Software applications 

written in various programming languages and running on various platforms can use web services 

User's Guide 


151


to exchange data over computer networks like the Internet. MapInfo Spatial Server web services are 

available using the Simple Object Access Protocol (SOAP) and Representational State Transfer (REST) 

over HTTP. 

The MapInfo Spatial Server server allows you to access MapInfo Spatial Server services using web 

services in document/literal mode. This method allows you to create an xml schema to enforce the 

contract between the client and the server. Document/literal web services are the WS-I compliant format 

for web services. 

With this ability, you can: 

• Call services via a standard web service interface 

• Use a web service interface that is dynamically generated based on the provided metadata 

• Pass data into the service and have it returned in the response. 

Note: This interface is not designed to be a high performance method for accessing the server. If performance 

is a concern and HTTP is a requirement, the MapInfo Spatial Server proprietary XML 

over HTTP protocol may be the preferred method for calling services from third-party applications. 

Be advised that our proprietary XML has limited support for hierarchical types and all fields must 

be in string format. 

1. Open the Enterprise Designer. 

2. Browse to Edit and click Web Service Options. 

3. Select one of the following options 

• SOAP—Expose the service via enhanced SOAP, which provides more options, including faults, 

basic authentication, and more. 

• REST—Expose the service via REST. 

After the service is exposed, you can access it via URL. The locations shown below depict addresses 

for SOAP, Legacy SOAP, and Rest, where [serviceName] represents the service you are accessing: 

• http://localhost:8080/soap/[serviceName]?wsdl 

• http://localhost:8080/rest/[serviceName]?_wadl&_type=xml 

For example, to access Validate Address using SOAP, you would go to this address: 

http://localhost:8080/soap/ValidateAddress?wsdl 






152 



















"S"). 






10. Click OK. 






appears. 


appears. 





appears. 


User's Guide 


153

Validating Services 

Validating Services 

154 




Subflows 


• What is a Subflow? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156 

• Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156 

• Control Stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .164 

• Primary Stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .205 

• Sinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .205 

• Runtime Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .214 

• Validating a Dataflow . . . . . . . . . . . . . . . . . . . . . . . . . . . .215 

• Using Subflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .215 

5

What is a Subflow? 

What is a Subflow? 

Subflows are dataflows that can be reused by other dataflows. Subflows that are saved and exposed 


stages are displayed in the Deployed Stages folder. 

Sources 

Sources define the location of the input data for the subflow. The types of sources are: 

• Input Stage on page 156 

• Read From DB on page 159 

• Read from File on page 161 

Input Stage 

156 

The Input stage defines the input fields for a service or subflow. It also defines test data to use during 

data inspection. 

Defining Input Fields 


2. Select the fields you want to use for input. The list of fields shown depends on the stage that the Input 

stage is connected to. 






Data Type 


boolean 

double 

Description 




Note: 






Data Type 

float 

Geometry 

integer 

long 


string 

Description 










Note: 



between -2 31 (-2,147,483,648) and 2 31 -1 (2,147,483,647). 


between -2 63 (-9,223,372,036,854,775,808) and 2 63 -1 

(9,223,372,036,854,775,807) 


Note: 





that includes AddressLine1 (string), City (string), StateProvince(string) and PostalCode 









Note: 

If you define hierarchical data in the input fields, you will not be able to import data or view the 

data vertically. 

Defining Inspection Data 

To use data inspection you must enter test data by following the steps below. 

User's Guide 

Chapter 5:Subflows 

157

Sources 

158 

Note: 

The Inspection Data tab allows you to specify test input records to use with the Data Inspection 

tool. For more information on data inspection, see Inspecting Dataflows on page 230. 


2. Click the Inspection Input tab. 

3. Enter inspection data using one of the following methods: 

Note: 

You can specify a maximum of 50 records. Likewise, certain field types have the restrictions 

when using inspection: 

Data Type 

double and float 

integer and long 

Description 

Can process numeric data only; supports up to 16 digits and 6 decimal 

places. Exponential notation is not supported. 

Can process numeric data only. 

• Manually enter data—If you want to use just a few records for inspection, you can manually type in 

the data, one record per line. 

• Import data from a file—If you have data in a CSV or TXT file, you can import the data by clicking 

Import Data. The data must use one of the following delimiters: 

• \t 

• | 

• , 

• ; 

• Copy and paste data—You can copy delimited data from another application and paste it into the 

inspection data editor. 

The Inspection Input tab indicates pass-through data by enclosing the field name in parentheses, as 

shown here: 


Read From DB 

The Read From DB stage reads data from a database table or view and supports the following data 

types: 

Data Type 

double 

float 

integer 

long 

string 

Description 




see: 







between -2 31 (-2,147,483,648) and 2 31 -1 (2,147,483,647) 


between -2 63 (-9,223,372,036,854,775,808) and 2 63 -1 

(9,223,372,036,854,775,807) 



User's Guide 


159

Sources 

160 

Data Type 

String Types 

CHAR 

VCHAR 

LONGVARCHAR 

NCHAR 

NVARCHAR 

Numeric Types 

TINYINT 

SMALLINT 

INTEGER 

BIGINT 

REAL 

DECIMAL 

DOUBLE 

FLOAT 

NUMERIC 

Boolean Types 

BIT 

BOOLEAN 

To define a database source: 

Description 

string 

string 

string 

string 

string 

integer 

integer 

integer 

long 

float 

double 

double 

double 

double 

boolean 

boolean 

1. Under Sources and Sinks, click Read from DB and drag it to the canvas, placing it where you want 


2. Double-click the icon. The Read from DB Options dialog box appears. 




Connection Managerconnectionsmodifyingconnectionsadding on page 161. 


5. If you want to use a "where" SQL statement, enter it in the Where field (note that you should not actually 

include the word "where" in the statement). For example: STATEPROVINCE = 'IL'. The 

purpose of a "where" statement is to filter input records. After entering a "where" statement, click 

Preview to see a preview of the data (first 50 records) based on the criteria you defined. 


field. 








1. In the Read From DB Options dialog box, click Manage. 

The Database Connection Manager dialog box will appear. 


The Connection Properties dialog box will appear. 





Note: 



Read from File 

The Read from File stage specifies an input file for a dataflow. 

Define the Input File 

1. Double-click the Read from File icon on the canvas. The Read from File Options dialog box opens. 

2. Click the ellipsis button next to the File Name field. 

3. Navigate to your file and click Open. Your file will be displayed in the File Name field. 

Note: 


4. Complete the remaining fields as follows. 

Field Name 

Record type 

Character encoding 

Field separator 

Text qualifier 

User's Guide 

Description 

The format of the records 

The encoding method of the characters 

The type of field delimiter, if applicable. 

The qualifier character, if applicable. 


161

Sources 

162 

Field Name 

Record separator 

Use default EOL 

Record length 

Description 

If your file includes a different field separator than those listed, do the 

following: 

a. Click the ellipsis button to access the Manage Field Separators dialog 

box. 


c. In the Character field, enter the character that your file uses as a field 

separator. If you prefer, you may enter the character by clicking Character 

Map and selecting from the lists provided. 




e. (Optional) Enter a description of the character in the Description field. 

For example, if the character is "&" the description could be "ampersand." 

If you do not enter a description, the character will appear by itself in 

the list of available characters. 


Use a different record separator other than the normal end of line (EOL) 

characters. 

If your file includes a different record separator than those listed, do the 

following: 

a. Click the ellipsis button to access the Manage Record Separators 

dialog box. 


c. Enter the character that your files uses as an EOL character in the 

Character field. If you prefer, you may enter the character by clicking 

Character Map and selecting from the lists provided. 




e. If you wish, enter a description of the character in the Description 

field. For example, if the character is "%" the description could be "percentage 

sign." If you do not enter a description, the character will appear 



Use normal end of line (EOL) characters. 

The length of the records in the input file. 


Field Name 

First row is header record 

Treat records with fewer fields 

than defined as malformed 

Adding Input Fields 

Description 

For line sequential files, the number must be the minimum length of the 

record (but can be longer); for fixed width files, this number must be 

exact. 

The first record in a delimited input file contains header information and 

not data. 

Delimited input file records containing fewer fields than are defined on 

the Fields tab will be treated as malformed. For more information on 

malformed records, see Managing Malformed Input Records on page 

38. 



3. Define the fields in your input records by selecting the appropriate field and clicking Add to add fields 

or clicking Remove to delete fields. You can also modify the position of a field by clicking Modify 

and changing the position as desired. If your file is delimited and contains a header record, you can 

add all fields from the input file by clicking Regenerate. 

Note: 


4. Enter the Name of the field you are adding. 

5. The Type field will automatically populate based on the needs of the dataflow. If you are adding a 

field that exists downstream in your dataflow, the Type field will populate with the necessary type; 

otherwise, it will populate with string as the type. Note that you are able to override these entries if 

you like. Supported types include boolean, double, float, integer, long, and string. 





8. When you have named and mapped all your input fields, click OK. 

Sorting Input Fields 



3. Click Add. 


to sort by. The fields available for selection depend on the fields defined in this input file. 


6. Repeat until you have added all the input fields you wish to use for sorting. Change the order of the 

sort by highlighting the row for the field you wish to move and clicking Up or Down. 

User's Guide 


163



dialog box. When you have finished specifying the additional sort performance options, click OK to 

close the Advanced Options dialog box and return to the Read from File Options dialog box. The 

Advanced Options dialog box contains the following sort performance options: 


options. 






disk. 

The combination of sort performance option settings that will result in optimal sorting efficiency is 

highly dependent on your server's hardware configuration. Nevertheless, good sort performance 

results have been observed when using the following general guideline: (in_memory_record_limit × 

maximum_number_of_temporary_files_to_use ÷ 2) >= total_number_of_rows_to_be_sorted Be 

aware that in environments where there are concurrently running jobs, increasing the In Memory 

Record Limit setting increases the likelihood of running out of memory. 

8. When you have finished specifying the additional sort performance options, click OK to close the 

Advanced Options dialog box and return to the Read from File Options dialog box. 


Set Input Runtime Properties 



3. Enter the first record you want to process in the Starting Record field. 

4. Select either All Records or Max Records. 

5. If you selected Max Records, enter the maximum number of records you want your dataflow to process. 

6. Click OK. 


164 


and transforming. The control stages are: 

• Aggregator on page 165 

• Broadcaster on page 173 

• Conditional Router on page 174 

• Group Statistics on page 177 

• Math on page 180 

• Query DB on page 187 

• Record Combiner on page 189 


• Sorter on page 191 

• Splitter on page 192 

• Stream Combiner on page 198 

• Transformer on page 198 

Aggregator 














following: 



following: 

User's Guide 






165


166 













User's Guide 










167


168 

• Press OK. 






User's Guide 



dataflow: 








169


170 








User's Guide 


171


172 










highlighted. 




























9. 

Note: 

Broadcaster 







dataflow. 

User's Guide 


173




174 










Note: 


editing. 



box appears. 













table. 


Operator 

Is Equal 

Is Not Equal 

Description 






Operator 

Is Null 

Is Not Null 

Is Empty 

Is Not Empty 

Is Less Than 


To 



Equal To 

Starts With 


Contains 

User's Guide 


Description 












specified. 
















175


176 

Operator 

Ends With 




Description 














true. 









{ 


} 









{ 


} 


















User's Guide 


177


178 

Region 

East 

East 

East 

West 

West 

State 






Double-click the Group Statistics stage. The Group Statistics Options dialog box appears, with the 



Output tab to change output settings. or more information, see Using the Output Tab on page 179 

MD 

MD 







group. 





Note: 



Operation 

Average 

Maximum 

Minimum 

Description 

CT 

CA 

CA 





Operation 


Percentile 

Percent Rank 

Sum 

Variance 

ZScore 

Description 






found. 











Data Type 

Integer 

Long 

Float 

Double 

Note: 

Description 


between -2 31 (-2,147,483,648) and 2 31 -1 (2,147,483,647) 


between -2 63 (-9,223,372,036,854,775,808) and 2 63 -1 

(9,223,372,036,854,775,807) 





(1.7976931348623157E308) 





User's Guide 


179


Math 

180 


Option 



each group 


group 

Description 







GroupCount. 







the dataflow. 
























Operator 

Backspace 

pi 

e 

/ 

* 

+ 

- 

x^y 

Mod 

; 

= 

() 

. 

if\else 


== 

!= 

&& 

|| 

> 

>= 

< 


182 









Function 

Constants 

e 

false 

Infinity 

NaN 

Pi 

true 

Conversion 

Abs (value) 

Ceil (value) 


Floor (value) 


Round (value) 

Math 

Description 






its diameter. 















Function 


Exp (value) 

Fac (value) 

Ln (value) 

Log (value) 



Sqrt (value) 

Sum (value) 

Trigonometry 




Cos (value) 

User's Guide 

Description 







6*5*4*3*2*1 and returns 720). 






















183


184 

Function 

Ln (value) 

Sin (value) 

Tan (value) 


Description 










Condition 

Equals 

Not Equals 

Greater Than 


Less Than 


Not condition 

And 

Or 

If Statement 

Description 






expression


} 

else if... 


{ 




} 


{ 



} 




if(condition) 

{ 


} 


{ 


} 

else if... 

else 

{ 


} 












Note: 





User's Guide 


185


186 






x=5+5 

z=x*100 


of sides. 









Type 

Boolean 

Double 

Float 

Description 




if(x && y) 

z=1; 

else if(x) 

z=2; 

else if(y) 

z=3; 

else 

z=4; 









see: 



Type 

Integer 

Long 


Description 





(9,223,372,036,854,775,807) 



Input Data. 



Query DB 




Data Type 

double 

float 

integer 

long 

string 

Description 




see: 







between -2 31 (-2,147,483,648) and 2 31 -1 (2,147,483,647) 


between -2 63 (-9,223,372,036,854,775,808) and 2 63 -1 

(9,223,372,036,854,775,807) 



User's Guide 


187


188 

Data Type 

String Types 

CHAR 

VCHAR 

LONGVARCHAR 

NCHAR 

NVARCHAR 

Numeric Types 

TINYINT 

SMALLINT 

INTEGER 

BIGINT 

REAL 

DECIMAL 

DOUBLE 

FLOAT 

NUMERIC 

Boolean Types 

BIT 

BOOLEAN 

Note: 

Description 

string 

string 

string 

string 

string 

integer 

integer 

integer 

long 

float 

double 

double 

double 

double 

boolean 

boolean 




dataflow. 




























Note: 











Note: 









User's Guide 


189


Record Joiner 

190 




you specify. 



















port. 







Note: 












Sorter 



4. Click OK. 





dataflow. 






Note: 






Data Type 

double 

float 

integer 

long 

string 

User's Guide 

Description 











between -2 31 (-2,147,483,648) and 2 31 -1 (2,147,483,647) 


between -2 63 (-9,223,372,036,854,775,808) and 2 63 -1 

(9,223,372,036,854,775,807) 




191


Splitter 

192 









options. 






disk. 









11. Click OK. 

Note: 




















User's Guide 


193


194 







User's Guide 




195


196 



User's Guide 





197
















fields. 

5. Click OK. 











Transformer 

198 














General 









Formatting 







character. 









6. Click OK. 







Note: 

3. Click OK. 

User's Guide 




199


200 















Note: 



Operation 







: String 


Description 



value. 


value. 













Note: 



















Character 

# 

' 

U 

L 

A 

? 

* 

H 

User's Guide 

Definition 




case. 


case. 



Anything 



201


202 





















Input: 




Script: 








{ 









} 



Input 

Field 1: City 





Script: 







Input 



Script: 
















output. 

Record 

John Smith 

Mary Smith 

Jane Doe 

John Doe 

User's Guide 

RecordID 

1 

2 

3 

4 


203


204 




Note: 







4. Click OK. 










Note: 



Note: 











Output 


Field Name 

RecordID 









Module Stages 





on page 287. 

Subflows 

Sinks 

Subflows can be embedded within other subflows. 

Sinks define what to do with the data at the end of a subflow. They can also define other actions to take, 

such as executing a program. The sinks for subflows are: 


• Output Stage on page 206 


• Write to File on page 210 

User's Guide 


205

Sinks 














6. Click Add. 






Output Stage 

206 

Input Fields 

The Output stage defines the output fields that the service or subflow returns. Follow the steps below to 

define the service output. 

1. Double-click the Output icon on the canvas. The Output Options dialog box appears. When you 

open the Output Options dialog box for the first time, a list of fields defined in the Input is displayed. 






Data Type 


boolean 

Description 




Note: 




Data Type 

double 

float 

Geometry 

integer 

long 


string 

Description 












Note: 



between -2 31 (-2,147,483,648) and 2 31 -1 (2,147,483,647). 


between -2 63 (-9,223,372,036,854,775,808) and 2 63 -1 

(9,223,372,036,854,775,807) 


Note: 





that includes AddressLine1 (string), City (string), StateProvince (string) and PostalCode 









Note: 

If you define heirarchical data in the input fields, you will not be able to import data or view 

the data vertically. 


User's Guide 


207

Sinks 

Write to DB 

208 


data types: 

Data Type 

double 

float 

integer 

long 

string 

Description 




see: 







between -2 31 (-2,147,483,648) and 2 31 -1 (2,147,483,647) 


between -2 63 (-9,223,372,036,854,775,808) and 2 63 -1 

(9,223,372,036,854,775,807) 



Data Type 

String Types 

CHAR 

VCHAR 

LONGVARCHAR 

NCHAR 

NVARCHAR 

Numeric Types 

TINYINT 

SMALLINT 

INTEGER 

BIGINT 

Description 

string 

string 

string 

string 

string 

integer 

integer 

integer 

long 


Data Type 

REAL 

DECIMAL 

DOUBLE 

FLOAT 

NUMERIC 

Boolean Types 

BIT 

BOOLEAN 

Note: 

Description 

float 

double 

double 

double 

double 

boolean 

boolean 









209. 



field. 

Note: 












Note: 



User's Guide 


209

Sinks 














Write to File 

210 







Note: 









Note: 













completed. 













be completed. 













provided. 



be completed. 











User's Guide 


211

Sinks 

212 

Note: If you later remove fields from a delimited file with a header record, you must leave at least 












Note: 
















3. Click Add. 


to sort by. 

Note: 





or Down. 


dialog box. 




options. 






disk. 
















4. Click OK. 

Write to Null 








User's Guide 


213







214 


















"S"). 






10. Click OK. 







appears. 


appears. 





appears. 


Validating a Dataflow 



Using Subflows 

Exposing Subflows 

Go to File > Expose/Unexpose and Save or click the Expose button (the light bulb). This will make the 

subflow available for use in other dataflows. 

Note: Any subflow currently stored in the system during a server upgrade are marked as exposed to 

provide the same behavior for those subflows as before the upgrade. Any subflow that is exported 

prior to the upgrade will not have the exposure flag set. Therefore, when importing these subflows 

back into the system, you must manually expose the imported subflow. 

Adding a Subflow to a Dataflow 

For information on adding a subflow to a dataflow, see Subflows on page 79. 

User's Guide 


215

Using Subflows 

Modifying Subflows 

When modifying a subflow, consider how the change will impact the dataflows using the subflow. To see 

which dataflows are using the subflow, open the subflow and select Tools > Used By. 

When you delete an input or output or add an additional input or output, Enterprise Designer displays a 

warning message reminding you that other dataflows are using the subflow and giving you the option of 

seeing which dataflows use the subflow. If you continue saving the reusable stage, Enterprise Designer 

will unexpose all dataflows used by the subflow. 

If you change a subflow in another way, such as by changing a file name or the stage configurations, 

Enterprise Designer will display a warning message reminding you that other dataflows are using the 

subflow and give you the option of seeing which dataflows use the subflow. You can continue without 

unexposing those dataflows. 

Note: 

Deleting Subflows 

When making changes to a subflow, you must refresh the view in order for the changes to be 

reflected in the parent dataflow. 

If you try to delete an exposed subflow, Enterprise Designer displays a warning message reminding you 

that other dataflows are using the subflow you are about to delete. If you continue to delete the subflow, 

Enterprise Designer unexposes all connected dataflows. 

Unexposing a Subflow 

If you unexpose a subflow, Enterprise Designer displays a warning message reminding you that other 

dataflows are using the subflow you are about to alter. If you continue to unexpose the subflow, Enterprise 

Designer unexposes all dataflows that use the subflow. 

Converting Stages to Subflows 

216 

1. Create a new job, service, or subflow. 

2. Add the stage you would like to include in the job, service, or subflow. 

3. If you wish to configure the stage at this point, right-click the stage and select Options. Then configure 

the stage options as desired and click OK. 

4. Right-click the stage you want to convert and select Convert Stage to Subflow. The Save As dialog 

box appears. 

5. Enter the name you want to give the subflow and click OK, then save the service. The name must 

be unique to the system. Three things happen: 

• The system creates a new subflow that includes the following: 

• the stage you selected 

• a dataflow input for each input port on the stage 

• a dataflow output for each output port on the stage 

• connections between the stage and its inputs and outputs 


• The system replaces your selected stage with the new subflow. 

• The system exposes the new subflow. You will see it in the Server Explorer and in the User Defined 

Stages section of the toolbox. 

After you have created a subflow and used it in other dataflows, you can see what other dataflows are 

using the subflow. Open the subflow and go to Tools > Used By. (Alternately, you can right-click the 

subflow in Server Explorer and select Used By.) This will show a list of dataflows that use the current 

subflow, allowing you to see which dataflows would be affected if you changed the current subflow. 

User's Guide 


217

Process Flows 


• What is a Process Flow? . . . . . . . . . . . . . . . . . . . . . . . . .220 

• Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .220 

• Creating Process Flow Variables . . . . . . . . . . . . . . . . . .222 

• Using Transition Options . . . . . . . . . . . . . . . . . . . . . . . . .223 

• Running a Process Flow . . . . . . . . . . . . . . . . . . . . . . . . .224 

• Deleting Process Flows . . . . . . . . . . . . . . . . . . . . . . . . . .227 

6

What is a Process Flow? 

What is a Process Flow? 

A process flow executes a series of activities such as MapInfo Spatial Server jobs and external applications. 

For example, a process flow could run a MapInfo Spatial Server job to standardize names, validate 

addresses, then invoke an external application to sort the records into the proper sequence to claim 

postal discounts. Such a process flow would look like this: 

In this example, the jobs StandardizeNames and ValidateAddresses are exposed jobs on the MapInfo 

Spatial Server server. Run Program invokes an external application, and the Success activity indicates 

the end of the process flow. 

Activities 

Process flows consist of these activities: 

• Run Program on page 220 

• Jobs on page 221 

• Success on page 222 

Run Program 

220 

The Run Program activity executes an external application. 

Table 36: Run Program Options 

Option Name 

Program name 

Arguments 

Time out (in seconds) 

Description 

The path to the executable you wish to run. 

Specifies command line arguments to pass to the 

program specified in the Program name field. 

Separate multiple arguments with spaces. You can 

use variables defined on the Variables tab as arguments 

by clicking Insert Variable. For more information 

on variables, see Creating Process Flow 

Variables on page 222. 

Specifies an amount of time to wait for the program 

specified in the Program name field to respond. If 

the program is unresponsive for the amount of time 

specified the process flow will fail. 


Jobs 

Option Name 

Environment variables 

Description 

Specifies environment variable values to use when 

running this program. If you specify values here 

the program will use these environment variables 

instead of those specified on your system. Otherwise, 

it will use the environment variables specified 

on your system. Note that if the program you are 

calling uses multiple environment variables you 

must either define values for all of them or none of 

them. 

Click Add and enter the name of the variable in the 

Variable Name field. An example might be 

"JAVA_HOME". Enter the value of the variable in 

the Variable Value field. An example might be 

"C:\Program Files\Java\jdk1.6.0_17." Instead of 

entering a value you can click Insert Variable to 

set it to the value of a variable defined in on the 

Variables tab. For instructions on defining variables, 

see Creating Process Flow Variables on page 

222. 

Process flows can execute any exposed job. Exposed jobs are listed in the Activities palette in Enterprise 

Designer when you open a process flow. When you add a job to a process flow, you can double-click 

the job to access the Options tab and the Variables tab. 

Options Tab 

The Options tab allows you to view and override dataflow options that were set for the job you brought 

into the process flow. For example, if one of your job's dataflow options is to return the distance from 

one point to another in miles (an option with the Get Travel Directions service), you could override that 

option here and have your process flow's job activity output returned in kilometers instead. Similarly, if 

one of your job's dataflow options is to perform Canadian processing on your input file that contains 

addresses (an option with the Validate Address service), represented by "Y" for "yes", you could override 

that option here and choose not to perform Canadian processing, represented by "N" for "no". Finally, 

if one of your job's dataflow options include returning a maximum of 50 results for a city/state/province 

search within a particular postal code (an option with the Get City State Province service), you could 

override that option here and choose to return a maximum of 100 results instead. 

1. With your process flow open, double-click the Job stage. 

2. Click the option you want to override. 

3. Click the drop-down and change the option's value accordingly, or enter the new value if values are 

not provided. Using the Get Travel Directions example above, you would click the drop-down and 

select "Kilometers". Using the Validate Address example, you would click the drop-down and select 

"U". Using the Get City State Province example, you would enter "100". 

User's Guide 

Chapter 6:Process Flows 

221

Creating Process Flow Variables 

Variables Tab 

The Variables tab allows you to specify the files to use for input and output. This is useful if you want to 

use a different input or output file than those specified in the job dataflow's input and output stages. 

Success 

For input select one of the following: 

• Use job's specified file—Choose this option if you want to use the file specified in the job's input 

stage. 

• Browse for file on the server—Choose this option if you want to specify a path and filename for the 

input file to use. 

• Reference an upstream activity's file—Choose this option if you want to reference a file whose 

name and location is defined in an upstream activity's Read from File or Write to File stage or an upstream 

activity's variable. 

For output select one of the following: 

• Use job's specified file—Choose this option if you want to use the file specified in the job's output 

stage. 

• Browse for file on the server—Choose this option if you want to specify a path and filename for the 

output file. 

• Let the server manage this file—Choose this option if you want this variable to reference a temporary 

file that will be automatically created and deleted as needed. This option is useful in cases where a 

file used only as an intermediate step in a process flow and is not needed once the process flow 

completes. 

A Success activity indicates the end of a process flow. A process flow must have at least one Success 

activity. 

Creating Process Flow Variables 

222 

Variables are used in Run Program activities to reference input and output files used in upstream activities, 

reference a defined file, or reference temporary files. For example, if you have a process flow where 

the output file for the first activity is the input for one or more downstream activities, you could easily 

point to that file using a variable that points the output file defined in the upstream activity's Write to File 

stage. Now you only need to reference the variable when you want to point to that file. If the upstream 

activity's Write to File stage is ever modified to point to another file, the variable will still point to the correct 

file. Another advantage of variables is that you do not need to know the file path and name of upstream 

activities' input and output files to point to them with variables. 

1. In a process flow, double-click a Run Program activity. 

2. Click the Variables tab. 

3. Click the Add button next to the kind of variable you want to create. There are three kinds of variables: 


• Inputs—These variables point to files that contain data that you want to use as input to the program 

you are calling with Run Program. 

• Outputs—These variables refer to files that get written to by the program you are calling with 

Run Program. 

• Control files—Control file variables reference configuration files used by the program you are 

calling with Run Program. For example, if you are calling VeriMove you could specify a VeriMove 

control file. 

4. In the Name field, give the variable a name. 

5. For input and output variables, select an option in the Location field. The options available depend 

on if you are creating an input or output variable. 

For input variables select one of the following: 

• Browse for file on the server—Choose this option if you want to specify a path and filename 

for this variable to reference. 

• Reference an upstream activity's file—Choose this option if you want to reference a file whose 

name and location is defined in an upstream activity's Read from File or Write to File stage or an 

upstream activity's variable. 

For output variables select one of the following: 

• Browse for file on the server—Choose this option if you want to specify a path and filename 

for this variable to reference. 

• Let the server manage this file—Choose this option if you want this variable to reference a 

temporary file that will be automatically created and deleted as needed. This option is useful in 

cases where a file used only as an intermediate step in a process flow and is not needed once 

the process flow completes. 

6. If you are creating a control file for use with an external program such as VeriMove, specify the 

contents of the control file in the Contents field. You can use input and output variables in the control 

file. To use the control file, specify the control file variable as an argument on the Options tab. Any 

variables you specify in the control file are updated with actual values, and the control file is passed 

to the program. See the program's documentation for additional information about creating and using 

control files. 

Using Transition Options 

Transition options specify which return codes from the previous activity will trigger a particular outgoing 

transition. 

1. In a process flow, double-click a channel between two activities of the flow. The Transition Options 


2. Select the type of transition you wish to add: simple, conditional, or otherwise. If you select Conditional, 

include a numeric value as described on the screen. Specify any combination of discrete integer 

values, open-ended ranges, or closed-ended ranges. For example, if the execution of a Run Program 

activity results in one of the following result codes: 

User's Guide 

• 0—job succeeded 

• 1—job failed 

• -1—job was canceled 


223

Running a Process Flow 

Then in a transition after the activity, you could enter 0, 1, or -1 in the Conditional field of a transition 

to control the behavior based on the result code. 

Note: 

3. Click OK. 

Only one "otherwise" transition can exist among the transitions leading from an activity. 

4. Right-click the activity, point to Input Modes, and select All or First. If you select First, when the first 

transition into this activity is taken, this activity will begin and any further transitions are ignored. If 

you select All, this activity does not begin until all transitions into this activity are taken. 

5. Right-click the activity, point to Output Modes, and select All or First. If you select First, the first 

transition that evaluates to true is taken. If you select All, all transitions that evaluate to true are taken. 


Before running a process flow you can check it for errors by selecting Run > Validate in Enterprise 

Designer. 

For information on viewing the execution history for process flows, see Viewing Execution Status and 

History on page 226. 

There are two ways to run a process flow: 

• Running a Process Flow in Enterprise Designer on page 224 

• Running a Process Flow from the Command Line on page 224 

Running a Process Flow in Enterprise Designer 

To run a process flow, select Run > Run current flow. The Execution Details dialog box appears. Click 

on one of the activities under the Execution Information tree to see the return code for that individual 

activity. 

Running a Process Flow from the Command Line 

224 

1. Install the Process Flow Executer by downloading it from the MapInfo Spatial Server Welcome page 

(for example, http://myserver:8080). 

2. Run the process flow executor from a command line or script using this syntax: 

java -jar pflowexecutor.jar -r -u -p [OptionalArguments] 

For example, this is a basic command-line entry, with a process flow name and user ID, and password: 

java -jar pflowexecutor.jar -r MyFlow1 -u Bob1234 -p "mypassword1" 

This example shows the same information as above but with additional arguments: 

java -jar pflowexecutor.jar -r Flow1 -u Bob1234 -p "mypassword1" -h 

g1server.mydomain.com -s 8888 -w -d "%" -i 1 -t 9999 


The following example shows command line invocation and output. 

D:\g1\pflow-executor>java -jar pflowexecutor.jar -u guest -p "mypassword1" 

-r 

validateAddressFlow1 -h g1server.mydomain.com -s 8888 -w -d "%" -i 

1 -t 9999 

validateAddressJob1%111%succeeded 

In this example, the process flow named validateAddressFlow1 ran (with identifier 111). No errors 

occurred. Other possible results include "failed" or "running." 

The following table lists the Process Flow Executor arguments. 

Table 37: Process Flow Executor Arguments 

Argument 

-? 

-D 

-d 

-e 

-f 

-h 

-i 

-p 

-r 

-s 

-t 

-u 

-w 

User's Guide 

Description 

Prints usage information. 

Sets a Java system property. 

Sets an instance/status delimiter. This appears in synchronous output 

only and defaults to "|". 

Use a secure SSL connection for communication with the MapInfo 

Spatial Server server. 

Specifies a path to a property file. For more information on property 

files, see Using a Process Flow Property File on page 226. 

Specifies the name or IP address of the MapInfo Spatial Server 

server. 

Specifies how often to check for completed jobs, in seconds. The 

default is "5". 

The password of the user. Required. 

A comma-separated list of process flows to run. Required. 

The socket (port) on which the MapInfo Spatial Server server is running. 

The default value is 8080. 

Sets the timeout (in seconds) for synchronous mode. The default is 

3600). 

The login name of the user. Required. 


Specifies to wait for process flows to complete in a synchronous 

mode. 

225


Argument 

-X 

Description 

Using a Process Flow Property File 

Sets a non-standard Java property. 

A property file contains arguments that you can reuse by specifying the path to the property file with the 

-f argument in the process flow executor. The property file must contain, at minimum, the process flow 

(r), user ID (u), and password (p). 

1. Open a text editor. 

2. Specify one argument on each line as shown in the following example. See Running a Process 

Flow from the Command Line on page 224 for a list of arguments. 

D=property=true 

d=% 

h=myserver.mydomain.com 

i=30 

u=user 

p=password 

r=MyFlow1 

s=8888 

t=9999 

w=true 

X=Xmx=1024M 

3. Save the file with a file extension of .properties (for example, "example.properties"). 

4. When you run the process flow executor, specify the path to the property file using the -f argument. 

A combination of both command-line entry and property-file entry is also valid. Command line arguments 

take precedence over arguments specified in the properties file. 

java -jar pflowexecutor.jar -f /dcg/flow.properties -r MyFlow2 

In the above example, the process flow MyFlow2 would take precedence over a process flow specified 

in the properties file. 


226 

To track the progress of process flow execution and view execution history, select View > Execution 

History in Enterprise Designer. The Execution History dialog box contains two tabs: Jobs and Process 

Flows. The Process Flows tab shows information about the process flow as well as status. 

To view Activity Status information for the process flow, click the plus sign next to a process flow. The 

following information is displayed: 

• ActivityName—includes the names of all activities, including any success activities, that make up the 

process flow 

• State—the status of the activity (failed, succeeded, running, cancelled) 

• ReturnCode—any codes that were returned when the activity ran 

• Started—the date and time the activity started 


• Finished—the date and time the activity ended 

• Comment—any comments associated with the activity 

To cancel a process flow that is running, select the process flow then click Cancel. 

To select which fields you want displayed in the Execution History list, click the icon just to the left of the 

first column. The Field Chooser dialog box appears. 

You can group types of information together in the Execution History. Simply highlight a column name 

(such as ID or Name) and drag it up to the area that says, "Drag a column header here to group by that 

column." The information will then be grouped by that type of information. 

To sort the process flow list, click the column name. To change the list of process flows shown: 

1. Click on the drop-down list under Show only process flows where to select a variable (such as 

ProcessID). 

2. Select one of the comparisons in the next list. 

3. Type in a comparison value (such as zero) in the last box. 

4. Click Refresh. 

Deleting Process Flows 

1. Go to File > Manage . The Manage dialog box will appear. 

2. Right-click on the process flow you want to delete and select Delete. 

3. Click OK. 

User's Guide 


227

Tools 


• Importing and Exporting Dataflows . . . . . . . . . . . . . . . .230 

• Inspecting Dataflows . . . . . . . . . . . . . . . . . . . . . . . . . . . .230 

• Process List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .234 

• Changing Field Names and Data Types . . . . . . . . . . . . .235 

• Routing Processing to Another Server . . . . . . . . . . . . . .235 

• Using Multiple Runtime Instances . . . . . . . . . . . . . . . . .237 

• Data Types in MapInfo Spatial Server . . . . . . . . . . . . . . .237 

7

Importing and Exporting Dataflows 

Importing and Exporting Dataflows 

You can exchange dataflows with other Enterprise Designer users with the import and export features. 

Note: 

Dataflows can only be exchanged between identical versions of MapInfo Spatial Server. 

• To export a dataflow, select File > Export . Do not use special characters in the name of the services 

and jobs you define. Doing so may result in an error during export. 

• To import a process flow, select File > Import > Process Flow . 

• To import a dataflow, select File > Import > Dataflow . The stages in the dataflow must be available 

on your system before you import the dataflow. If the dataflow you import contains unavailable stages, 

you will see an error. 

• If you try to import a dataflow with the same name as a dataflow that already exists on the server, 

you will be given the option to override the existing dataflow with the imported dataflow. 

Inspecting Dataflows 

The Data Inspection tool allows you see how input data is modified at specific points in the dataflow. 

Data Inspection enables you to isolate problems or identify records that contain defects. Typically you 

should inspect outer points on the dataflow first and then move inward to narrow down where a problem 

may be. 

Note: 

MapInfo Spatial Server supports hierarchical data for inspection input and inspection output. 

Specifying Inspection Data 

230 

The first step in data inspection is to specify the data you want to run through the dataflow. The data 

should be representative of actual data, or, if you are troubleshooting a specific issue, should be the 

data that causes the issue you are troubleshooting. 

There are two ways to specify the data to use for inspection, depending on whether you are inspecting 

a dataflow that uses the Input stage or a dataflow that uses either the Read From File or Read From DB 

stage. 

When inspecting a job, the data used for inspection is the data specified in the Read From File or Read 

From DB stage. The Data Inspection tool can process a maximum of 50 records, which by default is the 

first 50 records in the input file or database. If you want the job to start somewhere other than the first 

record, double-click the Read From File stage and complete the Starting record field in the Runtime 

tab. Because it reads only 50 records, the write-to-file result will be different than running the dataflow. 

Dataflows that use an Input stage do not have access to data when you are editing the dataflow. For 

these dataflows you must define inspection data in the Input stage. For information on defining inspection 

data for a service, see Input Stage on page 98. For information on defining inspection data for a subflow, 

see Input Stage on page 156. 


Setting Inspection Points 

Inspection points indicate the point in the dataflow where you want to view data. To add an inspection 

point, right-click to the left of the Rename node on a channel and select Add Inspection Point. You can 

add a maximum of two inspection points. 

A point is added to the job: 

Note: 

To assign a name to the inspection point, click within "Point" and rename it accordingly. You will 

see the name change on the canvas and in the Inspection Results pane. 

Move an inspection point by dragging and dropping it to another channel. The inspection data updates 


Delete an inspection point by right-clicking the point and selecting Delete Inspection Point. The inspection 

data updates accordingly. 

Viewing Inspection Results 

To view inspection results, select Run > Inspect Current Flow or click the Inspect Current Flow 

button on the toolbar. The Inspection Results pane opens on the bottom of the screen, showing the inspected 

data in horizontal view. This window also includes a toolbar that allows you to refresh data and 

change how you view information. 

User's Guide 

Chapter 7:Tools 

231

Inspecting Dataflows 

The table below describes the Inspection Results toolbar. 

Table 38: Inspection Results Toolbar 

Icon 

Note: 

Description 

Refreshes data. 

Splits two panes vertically. 

Splits two panes horizontally. 

View data horizontally. 

View data vertically. 

If your inspection data is hierarchical, it cannot be viewed vertically. 

When you update or make changes to the dataflow, click the Refresh button for the inspection data to 

update accordingly. Certain changes, such as removing or adding stages, cause the inspection data to 

become "stale" because it is no longer representative of the dataflow. You can continue to use the stale 

data or select Run > Inspect Current Flow to update the inspection data. 

Note: 

Correlating Data 

232 

When inspection data is no longer representative of the dataflow you have inspected, the data 

in the inspection grid is grayed out and the docking window title is changed to "Inspection Results 

(Dataflow has been modified, please refresh.)" 

If you have two inspections points in the dataflow, you can compare data at one point with data at another. 

This makes it easy to see how specific records change as they move through the dataflow. 

1. Add two inspection points. 

2. Go to Run > Inspect Current Flow or click the Inspect Current Flow button on the Toolbar. The 

Inspection Results pane opens on the bottom of the screen, showing the inspected data in two panes. 


The left pane shows the upstream data (the left-most inspection point in the job) and the right pane 

shows the downstream data (the right-most inspection point in the job). 

The columns in the upstream data are in alphabetical order. The downstream column order is based 

on the column order of the upstream data as default. New columns are shown after the preserved 

columns in alphabetical order. 

3. Click a row in the left pane. You will likely see a highlighted, correlating row in the right pane. (Similarly, 

if you click a row in the right pane, you will see a correlating row in the left pane.) Note the following: 

• As you manually scroll through either pane, the data in the alternate pane will auto-scroll with you. 

When you scroll upstream data, the system scrolls to the record in the downstream data that correlates 

to the first visible record in the upstream data. Similarly, when you scroll downstream data, 

the system scrolls to the record in the upstream data that correlates to the first visible record in the 

downstream data. 

• Records added to the second inspection point will display at the bottom of the list (because they 

will not be correlated with records from the first inspection point). 

• If you create a stage with a pass-through field turned off in between inspection points and a new 

row is created, no correlation will exist (though data will still be present). 

• Sort data by clicking a field name in one pane. The data will sort in ascending or descending order 

and will correlate in the other pane, with the data in the other pane automatically sorted based on 

the same record order of the first pane. Uncorrelated records are appended at the end. 

• Choose fields to display by clicking on the Choose Fields icon to the left of the field names. 

• To change the column order, drag and drop the column headings into the order you want. The 

column order in both grids is updated. 

• Filter records based on values in a field by clicking the funnel icon to the right of any field name 

and selecting the data you wish to view (such as postal code, state, city, etc.). 

Inspecting an Embedded Subflow 

To inspect a subflow embedded in a job or service, right-click the subflow stage and select Inspect this 

Dataflow as shown below. The input data (in a job) or the inspection data (in a service) is automatically 

passed to the subflow, so there is no need to enter inspection data in the subflow's Input stage. 

User's Guide 


233

Process List 

Saving Inspection Results 

1. In the inspection results grid, select the rows whose data you wish to save. You can select all data 

by right-clicking in either pane and clicking Select All. 

2. Select Copy from the context menu or press to copy the data. 

3. Open the application into which you want to save the data (Excel, Notepad, etc.). 

4. Go to Edit > Paste or press to paste the data. 

5. Save the file in a useful format, such as a comma-delimited (.csv), .xls, or .txt file. 

Closing the Data Inspection Tool 

When you close the Inspection Results pane, the inspection data is lost. Similarly, when you close a job, 

the inspection points and inspection data are lost. 

Note: 

Process List 

234 

You can save data to another program such as Excel or Notepad. For more information on saving, 

please see Saving Inspection Results on page 234. 

Process List is a tool you can use within a service or subflow to turn data into a list. This is useful if your 

dataflows include services that require list input, such as those in the Routing Module. 

1. With an existing dataflow in place, right-click the stage whose output you want to convert into a list. 

This could be any stage except Input or Output. 

2. Select Process List. You will see the stage within a blue square background. 

3. To move a stage into and out of the process list, press the Shift key while dragging the additional 

stage. 

Note: 

If you have several stages whose data you would like Process List to handle, consider creating 

a subflow, bringing it into your dataflow, and applying the Process List feature to the subflow 

as a whole. 


4. The input and output fields of a process list are called "ListField." Using the Rename Fields function, 

you must map your input stage field to "ListField" in the input channel, and map "ListField" to your 

output stage field. For more information, see Changing Field Names and Data Types on page 235. 

5. If you want the list to keep the data in the same order in which it was input, right-click the Process 

List box and select Options. Then check the Maintain sort order box. 

6. To confirm that the data input into the next stage will be formatted as a list, validate or inspect the 

dataflow. For more information on inspecting data, see Inspecting Dataflows on page 230. 

Changing Field Names and Data Types 

This option allows you to map or rename fields from a previous stage's output to the next stage's input. 

This is helpful when a latter stage's input requires certain field names but the previous stage's output 

uses other field names. You can therefore map the fields from one stage to another using this tool. The 

list of required field names is driven by the input fields in the latter stage, and they are shown in the 

Output Field Name column. 

Note: 

After a field is renamed, it is no longer available in subsequent stages with the old name. 

1. With an existing dataflow in place, double-click the channel between two stages that contain fields. 

The Field Transform Options dialog box appears. 

2. Change the field name(s) as desired. For example, the latter stage could require "AddressLine3" but 

the former stage uses "FirmName" instead. In this case, you would click the drop-down arrow in the 

Input Field Name that corresponds to AddressLine3 as the Output Field Name and then select 

"FirmName." 

You will see that the color of the output field name and possibly output data type changes to green. 

Fields that do not need mapping (meaning the same field exists on both the previous stage and the 

next stage) are indicated by a gray background. You can override this by selecting another field from 

the list. 

Most data types must remain the same from the old field name to the new field name; however, 

Polygon and MultiPolygon types can map to a Geometry type, list types must be mapped to list types, 

and custom types must be mapped to custom types. You will receive a warning if there is a same 

field name but different type in the dataflow. When a data type has changed, the circle on the channel 

between the two stages turns to blue. 

3. Click OK. Your output file will contain the field with the new name. 

Routing Processing to Another Server 

The Routing button enables you to specify a different server to use for a stage or service's processing, 

reducing time for installation and maintenance of those services. It also allows you to design custom 

dataflows that include services and stages installed on remote servers. 

If a stage is routed to remote server, you will see a red star in the top-left corner of the stage after you 

drag it into a dataflow. Before routing a stage or service to a remote server, you must first configure one 

User's Guide 


235

Routing Processing to Another Server 

236 

or more remote servers in Management Console. For more information on configuring remote servers, 

see Remote Servers on page 272. 

In Enterprise Designer, you can choose to route certain stages through a remote server. Then, dataflows 

using that service will run on the machine where those dataflows are defined. To determine if a stage 

within a dataflow is eligible for routing, click that stage within the dataflow and see if a Routing button 

appears at the bottom of the Options dialog. The button will be grayed out until you click the Override 

system default options button at the top of the dialog. If there is no Routing button, that stage is not 

eligible for routing because it is not installed on the remote server. 

Note: 

Services can be run through remote servers via Management Console. For more information on 

using remote servers in Management Console, see Remote Servers on page 272. 

Follow the steps below to route a stage through a remote server in Enterprise Designer: 

1. In a dataflow, double-click the stage you want to route to a remote server. 

2. Click Routing. The Routing dialog appears. 

3. Click Remote and select the remote server to which you wish to route the process for this stage. 

4. Click OK. 

The following describes possible errors you may encounter. 

Module Not Licensed 

A real-time license is required on the remote server to execute remote stages. If you try to run a dataflow 

with an unlicensed stage, you will receive an error similar to the following: 


Remote Server Not Available 

If you have Enterprise Designer open with services routed through a remote server and you shut down 

that remote server, you will see a yellow hazard icon in the status bar at the bottom of the screen: 

Click this icon to see an error message that describes which remote servers are not available. This same 

message will appear if you try to launch Enterprise Designer and the remote server is not running. 

Likewise, the stage within the service that is routed through the remote server will be replaced with an 

icon showing you the stage is no longer available: 

Using Multiple Runtime Instances 

The Runtime Instances option specifies the number of parallel instances to load into memory. While 

specifying multiple runtime instances can help improve performance, setting this value too high can 

strain your system resources, resulting in decreased performance. 

Data Types in MapInfo Spatial Server 

MapInfo Spatial Server supports a variety of numeric, string, and complex data types. Depending on the 

type of processing you want to perform you may use one or more of these. For an address validation 

dataflow you might only use string data. For dataflows that involve the mathematical computations you 

may use numeric or Boolean data types. For dataflows that perform spatial processing you may use a 

complex data type. For dataflows that combine these, you may use a variety of data types. 

Specifying a Field's Data Type 

You can specify the data type for a field in these situations: 

• Source stages (Read from File, Read from DB, and Input): Specifying data types allows you to set 

the data type at the beginning of a dataflow, eliminating the need for data type conversions later in 

the dataflow. Note that for Read from DB, the data type is selected automatically and cannot be 

changed. 

• Sink stages (Write to File, Write to DB, and Output): Specifying data types allows you to control 

the data format returned by the dataflow. Note that for Write to DB, the data type is selected automatically 

and cannot be changed. 

• Transformer stage: You can specify data types in this stage if you use a custom script. 

User's Guide 


237


238 

• Math stage and Group Statistics stage: Since these stages perform mathematical calculations, 

choosing to use a particular numeric data type can have an effect on the results of the calculations, 

such as the precision of a division operation. If you specify a data type for a field that is different than 

the data type of the field coming into the stage, the downstream channel will automatically convert the 

field to the data type you specify, as described below in Data Type Conversions on page 238. 

Note: 

Each stage supports different data types. For a description of the supported data types for each 

stage, see the documentation for the stage. 

Data Type Conversions 

When the data presented to a stage is of an inappropriate type, MapInfo Spatial Server can, in some 

cases, automatically convert the data to the appropriate type. For example, Validate Address accepts 

only string data as input. If the PostalCode input field is of type integer, MapInfo Spatial Server can 

automatically convert the field to string and successfully process the PostalCode. Likewise, the Math 

stage needs data to be of a numeric data type. If the incoming data is of type string, MapInfo Spatial 

Server can convert the data to the data type specified in the Math stage's Fields tab. Data type conversions 

happen in the channels of a dataflow. If a channel is converting a data type, there will be a blue dot in 

the middle of the channel: 

If you double-click the channel you can see the data type conversion that's occurring. In this case, string 

data is being converted to integer data: 


Note that you cannot change the data type in this dialog box for automatic data type conversions. The 

output data type is determined by settings in the downstream stage. 

MapInfo Spatial Server can convert string fields to Boolean and numeric data types (and can convert 

Boolean and numeric fields to sting) as long as the fields contain valid values for the field's data type. If 

the fields contain invalid values the conversion will fail and MapInfo Spatial Server will take the action 

you specify in the type conversion options. The following table lists the valid values for each data type. 


Type 

Boolean 

Double 

Float 

Integer 

Long 

Description 




if(x && y) 

z=1; 

else if(x) 

z=2; 

else if(y) 

z=3; 

else 

z=4; 









see: 






(9,223,372,036,854,775,807) 

Fields that do not contain valid values cannot be converted by MapInfo Spatial Server. You can specify 

what MapInfo Spatial Server should do in these cases by using the type conversion options. You can 

specify a global default settings and dataflow-specific settings. For more information see Setting Default 

Type Conversion Options on page 240 and Setting Type Conversion Options for a Dataflow on page 

240. 

User's Guide 


239


Setting Default Type Conversion Options 

Type conversion options specify what to do when MapInfo Spatial Server is unable to convert a field's 

data type to the data type required by a stage. MapInfo Spatial Server automatically attempts data type 

conversions when the data presented to a stage is of an inappropriate type. For more information see 

Data Type Conversions on page 238. 

Specifying default type conversion options in the Management Console allows you to define default behavior 

for all dataflows on your system. You can override the default behavior for individual dataflows in 

Enterprise Designer if needed. For instructions, see Setting Type Conversion Options for a Dataflow 

on page 240. 

1. Open the Management Console. 

2. Browse to Execution and click Type Conversion Options. 


• Fail the dataflow—If MapInfo Spatial Server encounters a field it cannot convert the dataflow 

will fail. 

• Fail the record—If MapInfo Spatial Server encounters a field it cannot convert the record will fail 

but the dataflow will continue to run. 

• Initialize the field using default values—If MapInfo Spatial Server encounters a field it cannot 

convert the field's value is replaced with the value you specify here. This option is useful if you 

know that some records contain bad data and you want to replace the bad data with a default 

value. Specify a value for each data type. 

Setting Type Conversion Options for a Dataflow 

240 

Type conversion options specify what to do when MapInfo Spatial Server is unable to convert a field's 

data type to the data type required by a stage. MapInfo Spatial Server automatically attempts data type 

conversions when the data presented to a stage is of an inappropriate type. For more information, see 

Data Type Conversions on page 238. 

By default dataflows use the default type conversion options specified in the Management Console when 

a data type conversion fails. (For instructions on setting default type conversion options for your system, 

see Setting Default Type Conversion Options on page 240.) However you can override the default 

options for a job or service by following the procedure below. 

Note: 

Subflows inherit the type conversion settings from the dataflow they are in. You cannot specify 

type conversion settings for subflows. 

To specify type conversion settings for a dataflow, 

1. Open the dataflow in Enterprise Designer. 

2. Select Edit > Type Conversion Options. 


• Use global options—Use the system default specified in the Management Console. The current 

default setting is shown. 

• Fail the dataflow—If MapInfo Spatial Server encounters a field it cannot convert the dataflow 

will fail. 


User's Guide 


• Fail the record—If MapInfo Spatial Server encounters a field it cannot convert the record will fail 

but the dataflow will continue to run. 

• Initialize the field using default values—If MapInfo Spatial Server encounters a field it cannot 

convert the field's value is replaced with the value you specify here. This option is useful if you 

know that some records contain bad data and you want to replace the bad data with a default 

value. Specify a value for each data type. 

241

Part III: Administration 


• Configuring Database Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .245 

• Configuring External Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .255 

• Managing Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .263 

• Monitoring Your System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .277 

• Managing User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .283

Configuring Database 

Resources 


• Introduction to Database Resources . . . . . . . . . . . . . . .246 

• Adding a Database Resource . . . . . . . . . . . . . . . . . . . . .246 

• Renaming a Database Resource . . . . . . . . . . . . . . . . . . .254 

• Deleting a Database Resource . . . . . . . . . . . . . . . . . . . .254 

8

Introduction to Database Resources 

Introduction to Database Resources 

Some modules rely on reference data to perform their processing. For example, the Universal Addressing 

Module uses databases containing postal data from postal authorities such as the United States Postal 

Service ® to validate addresses. The Database Resources tool allows you to manage these databases. 

Adding a Database Resource 

Adding an Enterprise Geocoding Module Global Database Resource 

246 

Unlike other stages, the Geocode Address Global and Reverse Geocode Global stages are not visible 

in Management Console, Enterprise Designer, or Interactive Driver until you define a database resource. 

New stages are created for each global database resource that you define. For example, if you define 

one database resource containing databases for Mexico and Canada, and another database resource 

containing data for Australia and Singapore, you would see two Geocode Address Global stages, one 

capable of geocoding addresses in Mexico and Canada and the other capable of geocoding addresses 

in Australia and Singapore. You would also see two Reverse Geocode Global stages, one for Mexico 

and Canada and one for Australia and Singapore. 

Note: • Australia, Canada, France, Germany, and Japan have large geocoding databases. Do not put 

more than one or two of these in the same database resource. 

• If you are running the MapInfo Spatial Server server on a 32-bit machine, note the following 

restrictions: 

• Database resources should contain no more than four to five countries. If you require more, 

Java memory settings need to be modified. For assistance, contact technical support. 

• Japan cannot share a database resource with other countries. It must be in its own database 

resource. 

• If you are running the MapInfo Spatial Server server on a 64-bit machine, database resources 

should contain no more than eight to ten countries. If you require more, Java memory settings 

need to be modified. For assistance, contact technical support. 

To create a Geocode Address Global database resource: 

1. If you haven't already done so, install the database files on your system. For instructions on installing 

databases, see the MapInfo Spatial Server Installation Guide. 


3. In Management Console, expand Modules > Enterprise Geocoding > Tools then click Global 

Database Resources. 

4. Click Add to create a new database resource or click Modify to change an existing database resource. 

5. In the Database field, specify the name you want to give to this resource. This name can be anything 

you choose. You typically create a new database resource each time you receive an updated geo- 


coding database from Pitney Bowes Business Insight so you may want to consider using the database 

date in the database resource name. 

6. Click Add. 


8. In the Name field, specify a name for this database path. This name can be anything you choose. 

9. In the Path field specify the folder that contains the database files for the country you selected. The 

database files are typically found in: \IGEO-\\data 

Where: is the directory you specified when you installed the database 

files. is the two-letter country code. is the version number of the data. 

Some countries may have multiple databases in the data directory, some of which you may have licensed 

and some you may have not. Only specify the location of the data you have licensed. 

Note: 

Do not put databases on a network drive. Doing so can cause performance problems. 

10. If the database is a custom database, check the Custom database box. A custom database is a 

user-defined database that contains addresses and latitude/longitude coordinates that you can use 

for geocoding. For more information, see What Is a Custom Database? on page 582 

Note: 

11. Click OK. 

If you are specifying a path for a custom database you must specify a path to a Pitney Bowes 

Business Insight provided database first. The first path in all database resources must be a 

path for a Pitney Bowes Business Insight provided database. 

12. If you have additional database paths to add, click Add, otherwise click OK. 

13. If you have additional countries to add, click Add, otherwise click OK. By adding multiple countries 

to the same database resource, you will create a Geocode Address Global stage that can geocode 

addresses for each country in one stage. 

14. If there are any open Enterprise Designer sessions, click the Refresh button to see the new stage. 

Adding an Enterprise Geocoding Module U.S. Database Resource 

Whenever you install a new database resource or modify an existing database resource you must define 

it in the Management Console in order for it to become available on your system. This procedure describes 

how to add or modify a U.S.database resource for the Enterprise Geocoding Module. For instructions 

on database resources for geocoding non-U.S. locations, see Adding an Enterprise Geocoding 

Module International Database Resource on page 248. 




3. In Management Console, expand Modules > Enterprise Geocoding > Tools > US Database Resources. 

4. Click Add to install a new database or click Modify to change an existing database resource. 

5. If you are adding a new database, enter a name for the database resource in the Name field. The 

name can be anything you choose. You cannot modify the name of an existing database resource. 

Changing the name of an existing database resource would cause any services or jobs that reference 

the database resource to fail. 

Note: 

User's Guide 

Chapter 8:Configuring Database Resources 

If you are using the Enterprise Geocoding Module with the Siebel Module, name the U.S. 

geocoding database KGDDatasource. 

247


6. In the Path elements field, specify the folder that contains the database files. You can include multiple 

database paths. This allows you to specify a single resource that includes both the primary database 

and any optional databases you may have, such as DPV, LACS Link , or elevation data. 

7. Click OK. 

The database resource now appears in the list of available database resources. 

Adding an Enterprise Geocoding Module International Database Resource 



how to add or modify a non-U.S. database resource for the Enterprise Geocoding Module. For instructions 

on database resources for geocoding U.S. locations, see Adding an Enterprise Geocoding Module 

U.S. Database Resource on page 247. 




3. In Management Console, expand Modules > Enterprise Geocoding > Tools then click the database 

resource icon for the country whose data you want to configure. 


5. Specify a database resource name in the Database field. This name can be anything you choose. 

You typically create a new database resource each time you receive an updated geocoding database 

from Pitney Bowes Business Insight so you may want to consider using the database date in the 

database resource name. 

6. Click Add. In the Name field, specify a name for this database resource. In the Path field specify the 

folder that contains the database files. The database files are typically found in: \IGEO-\\data 

Where: is the directory you 

specified when you installed the database files. is the two-letter country code. 

is the version number of the data. Some countries may have multiple databases in the 

data directory, some of which you may have licensed and some you may have not. Only specify the 

location of the data you have licensed. 

For the Australia Geocoded National Address File (G-NAF) database, you must specify separate 

database resources for the GNAF123 and GNAF456 folders. We recommend that you use both 

databases to validate the existence of addresses but only use the GANF123 for parcel-level geocoding. 

If you do not require parcel-level geocodes you can use the GANF456 database for geocoding. 

Note: 

7. Click OK. 

If you are specifying a path for a user-defined database you must specify a path to a Pitney 

Bowes Business Insight provided database first. The first path in all database resources must 

be a path for a Pitney Bowes Business Insight provided database. 


Adding an Enterprise Tax Module Database Resource 

248 



how to add or modify Enterprise Tax Module database resources. 




2. In Management Console, expand Modules > Enterprise Tax > Tools > Database Resources. 






5. Specify the paths for the databases you want to include in this database resource. 

6. Click OK. 


Adding a Location Intelligence Module Centrus Database Resource 



how to install or modify a Location Intelligence Module database resource for a Centrus database. 

Centrus data is used by Closest Site and Point in Polygon. 




3. In Management Console, expand Modules > Location Intelligence > Tools > Centrus Database 

Resources. 






6. In the Path field, enter the full path to the database file(s). Centrus database files have a .gsb extension. 

The file names for .gsb files must be in all lower case on Unix and Linux systems for them to 

be available to MapInfo Spatial Server. 

7. In the Cache Size field, select the amount of memory to use to use to cache data. In general, the 

larger the cache the better the performance. The options are: 

• None—Do not cache data. 

• Medium—Use up to 5 MB of memory to cache data. Use this setting if there is a small amount 

of memory available for caching. 

• Large—Use up to 20 MB of memory to cache data. Use this setting if you are processing a large 

number of records. 

• Huge—Use up to 100 MB of memory to cache data. Use this setting if you are processing a large 

number of records. 

8. Click OK.The list of databases includes this information: 

User's Guide 


• Name—The name you have given the database. This is the name to use when referencing this 

database from a stage or service. 

• Path—The location of the database file. 

• Cache size—The amount of memory to use to cache data from this database. 

249


• Feature Type—Indicates the type of spatial data contained in the database (Points, Polygons, 

or Lines). Points databases can be used with the Closest Site and Point In Polygon stages. 

Polygon databases and Line databases can be used with Point In Polygon. 

• Buffered—Indicates whether or not the database supports buffering, which is a Point in Polygon 

feature that allows you to define areas that are close to the edge of a point, polygon, or line. 

The database resource now appears in the list of available database resources in Closest Site and Point 

in Polygon. 

Adding a Location Intelligence Module Routing Database Resource 



how to install or modify Location Intelligence Module routing database resources. Routing database resources 

are used by Find Nearest, Get Travel Boundary, Get Travel Cost Matrix, and Get Travel Directions. 




3. In Management Console, expand Modules > Location Intelligence > Tools > Routing Database 

Resources. 






6. In the Path elements field, specify the folder that contains the database files. The database files can 

be found in: \ERM-\\\ Where: 

is the directory you specified when you installed the database files. is the 

two-letter country code. is the date of the data. For example, 2009.1. is driving 

or pedestrian. is the name of the country. 

7. Click OK. 

The database resource now appears in the list of available database resources for Find Nearest, Get 

Travel Boundary, Get Travel Cost Matrix, and Get Travel Directions. 

Adding a Location Intelligence Module Spatial Database Resource 

250 



how to install or modify Location Intelligence Module spatial database resources. Spatial database resources 

are used by Find Nearest, Query Spatial Data, and Read Spatial Data. 

MapInfo Spatial Server supports the following JDBC data types: BIGINT, BINARY, BIT, BLOB, BOOLEAN, 

CHAR, DATE, DECIMAL, DOUBLE, FLOAT, INTEGER, LONGVARBINARY, LONGVARCHAR, NULL, 

NUMERIC, REAL, SMALLINT, TIME, TIMESTAMP, TINYINT, VARBINARY, VARCHAR. In addition, 

MapInfo Spatial Server supports the following Oracle data types: SDO_GEOMETRY and MD- 

SYS.SDO_GEOMETRY. These data types are handled as follows: 

• string , INTEGER, long, FLOAT, and DOUBLE—No changes. 


• DECIMAL—Converted to DOUBLE. 

• SDO_GEOMETRY and MDSYS.SDO_GEOMETRY—Converted to GEOMETRY data type in MapInfo 

Spatial Server. 

• All others—Converted to STRING data type in MapInfo Spatial Server. 




3. In Management Console, expand Modules > Location Intelligence > Tools > Spatial Database 

Resources. Then click one of the following: 

• Click Add to define a new database resource. 

• Click Modify to change an existing database resource. 





5. In the Spatial source type field select one of the following: 

• MapInfo—Choose this option if the data is in MapInfo TAB format. 

• Oracle—Choose this option if the spatial data is in an Oracle database. 

• Shape File—Choose this option if the spatial data is in ESRI Shape file format. 

6. If you selected MapInfo as the source type, specify the path to the TAB file in the Path field. 

7. If you selected Shape File as the source type, specify the path to the shape file in the Path field. 

8. If you selected Oracle as the source type, complete these fields: 

• Connection name—The name of a set of parameters used to access the database. Select a name 

from the list to specify an existing set of connection parameters, or enter a new name to define 

a new set. 

• User name—The user name to use to access this database. 

• Password—The password to use when accessing this database. 

• Host—The server name or IP address of the server where the database is located. 

• Port—The network port to use to access the database. 

• Instance—The name of the Oracle instance running on the host computer. 

• Schema—The Oracle schema object. This is typically the same as the user name. 

• Table—The table containing the spatial data you want to read into the dataflow. 

• Spatial column—The column containing the spatial data. 

9. Click OK. 

The database resource now appears in the list of available database resources in Find Nearest, Query 

Spatial Data, and Read Spatial Data. 

Adding a Universal Addressing Module Database Resource 



how to add or modify database resources used by Get Candidate Addresses, Get City State Province, 

Get Postal Codes, Validate Address. 

User's Guide 


251


Note: 

If you want to configure a database resource for Validate Address Global, see Adding a Validate 

Address Global Database Resource on page 252. 




3. In Management Console, expand Modules > Universal Addressing > Tools Click the icon for the 

country whose database resource you want to configure. 

Note: 

If you want to define a Global Database Resource for use with Validate Address Global, see 

Adding a Validate Address Global Database Resource on page 252. 






6. Specify the paths to the database files. 

7. Click OK. 


Adding a Validate Address Global Database Resource 

252 



how to install or modify database resources for use with Validate Address Global. 

1. If you have not already done so, install the database files on your system and enter the unlock key 

for the data in \server\modules\addressglobal\conf\unlockcodes.txt. 

For instructions on installing databases, see the MapInfo Spatial 

Server Installation Guide. 

Note: 

You must specify an unlock key in the file unlockcodes.txt before creating the database resource. 


3. In Management Console, expand Modules > Universal Addressing > Tools > Global Database 

Resources . 






6. In the Cache size field, choose the amount of memory you want to use for speeding up file system 

lookups in reference data that has not been preloaded. (Preloading is discussed below.) One of the 

following: 

• None—Do not cache data. 

• Small—Choose this option if you need to reduce the amount of memory used by Validate Address 

Global. 


• Large—This is the recommended setting. Use this setting unless all reference data is preloaded 

(in which case you may choose a cache size of None) or you want to reduce the amount of 

memory used by Validate Address Global. 

7. In the Path elements field, specify the folder that contains the database files. To specify path elements, 

a) Click Add (or Modify to change an existing path). 

b) In the Path field specify the folder that contains the database files. 

c) Click Add to specify country preferences (or Modify to change an existing preference). 

8. Select a database type. The options are: 

• Batch_Interactive— (Default) Used for all non-FastCompletion databases. 

• FastCompletion—Validation mode used in quick address entry applications that allows input of 

truncated data in several address fields and will generate suggestions for this input. FastCompletion 

can also be used to create suggestions while you type. 

Note: 

FastCompletion databases do not support extended parsing. 

• Certified—Validation mode used in batch processing environments for Australian mail. Validate 

Address Global is certified by Australia Post's Address Matching Approval System (AMAS). It will 

standardize and validate your mail against the Postal Address File, providing postal discounts 

and allowing for the least amount of undeliverable pieces. 

9. Select a preloading type. 

Preloading loads database data into memory, which can improve performance. Since large amounts 

of memory may be allocated during preloading, it might take some time to load the databases into 

memory. The options are: 

• None—No data is preloaded into memory. Use this option on machines with limited memory. 

(Default) 

• Partial—Partial preloading loads the metadata and indexing structures into memory. The reference 

data itself remains on the hard drive. Partial preloading offers some performance enhancements 

and is an alternative when not enough memory is available to fully load the desired databases. 

Partial preloading may not be supported for all databases. 

• Full—Full preloading moves the entire reference database into memory. This may need a significant 

amount of memory for countries with large databases such as the USA or the United 

Kingdom, but it will increase the processing speed significantly. 

10. Choose one of the following: 

• Make default—Make the selected database type and preloading type the default for all countries 

in the folder. 

• Apply to selected countries only—Apply this database type and preloading type only to the selected 

countries. 

11. Click OK. 

12. Repeat as needed to specify different database type and preloading settings for different countries. 

For example, if you have several countries in a folder you could specify a default database type of 

FastCompletion and preloading type of Partial then click OK. Then click Add, specify a default 

database type of FastCompletion and preloading type of Full for those few countries that you expect 

to use often, and click OK again. 

13. When you are done defining database type and preloading options, click OK. 

14. If necessary, define additional database paths. Click OK if you are done. 

User's Guide 


253

Renaming a Database Resource 

The database resource now appears in the list of available database resources for Validate Address 

Global. 

Renaming a Database Resource 

Renaming a database can potentially break existing jobs/services that reference the database. If no 

jobs/services reference the database or if you want to change existing jobs/services to reference a different 

database or the new name, you can safely rename databases. 

1. Click the Database Resources icon under the Tools node of the module for which you want to define 

a database. 

2. Click Rename. 

3. Confirm that you want to rename the database by clicking OK. 

4. Enter a new name then click OK. 

Deleting a Database Resource 

254 

1. Before deleting a database, verify that there are no jobs or services using the database. Deleting a 

database that is referenced by jobs/services will cause those jobs/services to fail. 

2. Click the Database Resources icon under the Tools node of the module for which you want to define 

a database. 

3. Click Delete. 

Note: 

This process makes the database unavailable to MapInfo Spatial Server jobs but it does not 

delete the database files from your system. 


Configuring External 

Resources 


• Introduction to External Resources . . . . . . . . . . . . . . . .256 

• Connecting to Databases . . . . . . . . . . . . . . . . . . . . . . . . .256 

• Connecting to File Servers . . . . . . . . . . . . . . . . . . . . . . .258 

• Accessing External Web Services . . . . . . . . . . . . . . . . .259 

9

Introduction to External Resources 

Introduction to External Resources 

MapInfo Spatial Server can read from and write to databases and file servers, using your existing data 

repository as input to jobs and output from jobs. MapInfo Spatial Server can also access external web 

services. This section explains how to view and manage connections, which must be configured prior 

to using certain sources. 

Connecting to Databases 

The Connections subnode within the Management Console allows you to manage registered database 

connections. 

• Adding a Connection on page 256 

• Modifying a Connection on page 256 

• Deleting a Connection on page 256 

Adding a Connection 


2. Expand Resources then click Connections. The Connections dialog box appears. 

3. Click Add. The Connection Properties dialog box will appear. 

4. Enter the name of the new connection in the Connection name field. 

5. Select the appropriate database type in the Database driver field. 

6. Complete the fields in the Connection Options table. This includes the host, port, instance, username, 

and password. 

7. If desired, test the connection by pressing Test. 

8. Click OK. 

Modifying a Connection 


2. Expand Resources then click Connections. The Connection Manager dialog box will appear. 

3. Highlight the connection you want to update and click Modify. The Connection Properties screen will 

appear. 

4. Make the appropriate changes to the connection and click OK. 

Deleting a Connection 

256 


2. Expand Resources then click Connections. The Connection Manager dialog box will appear. 


3. Highlight the connection you want to update and click Delete. You will receive a confirmation message 

asking if you wish to delete the connection. 

4. Click OK to confirm. 

Using JDBC Connections 

The JDBC Drivers subnode within the Management Console allows you to manage JDBC drivers. You 

can add, modify, or delete these drivers. 

Adding a JDBC Driver 

Note: 

JDBC driver settings are very specific and require total accuracy to function. Ensure you have 

the correct information from your database/database driver provider before adding a JDBC driver. 


2. Expand Resources then click JDBC Drivers. 

3. Click Add. The Add Driver dialog box will appear. 

4. Enter the name of the driver in the JDBC driver configuration name field. 

5. Enter the class name of the driver in the JDBC driver class name field. 

6. Enter the template name of the driver in the Connection string template field. 

7. In the Driver files section, click Add. 

8. Navigate to and select the appropriate driver and click Save. 

9. In the Connection Properties section, click Add. The JDBC Connection Property dialog box will 

appear. 

10. Enter the property's label (e.g., "username" or "password") in the Label field. This can be any 

name you choose; the labels included by default are named "username" and "password." 

Note: 

11. Click OK. 

You will need to enter user and password properties for every JDBC connection you create. 

Updating a JDBC Driver 



3. Select an existing JDBC driver and click Modify. The Modify Driver dialog box will appear. 

4. Update the driver as necessary. 

5. Click OK. 

Deleting a JDBC Driver 



3. Select an existing JDBC driver and click Delete. The Confirm Delete dialog box will appear. 

Note: 

User's Guide 

Chapter 9:Configuring External Resources 

If any connections are using this driver, you will be notified which connections are using it 

and you cannot delete the driver. 

257

Connecting to File Servers 

Connecting to File Servers 

The File Servers subnode within the Management Console displays options for configuring file servers. 

• Adding a File Server on page 258 

• Modifying a File Server on page 258 

• Deleting a File Server on page 258 

Adding a File Server 


2. Expand Resources thenclick File Servers. The File Servers dialog box will appear. 

3. Click Add. The Add File Server dialog box will appear. 

4. Enter the name of the new connection in the Connection name field (required). 

5. Enter the host information in the Host field (required). 

6. Enter the Port number in the Port field (optional). 

7. Enter a name in the Username field (required if the FTP server requires it). 

8. Enter a password in the Password field (required if the FTP server requires it). 

9. Click OK. 

10. If you wish to test the server, highlight the connection you want to test and click the Test button on 

the File Servers dialog box. 

Note: 

Modifying a File Server 

After a File Server is established, you can select it when you click Remote Machine while 

using a Read From File source in Enterprise Designer. 

Follow the steps below to modify a file server. 


2. Expand Resources then click File Servers. The File Servers dialog box will appear. 

3. Highlight the server you want to update and click Modify. The Modify File Server screen will appear. 

4. Make the appropriate changes to the server and click OK. 

Note: 

Deleting a File Server 

258 

Modifying a configuration may cause any dataflows reference that configuration to no longer 

function properly. 


2. Expand Resources then click File Servers. The File Servers dialog box will appear. 


3. Highlight the server you want to update and click Delete. You will receive a confirmation message 

asking if you wish to delete the server. 


Note: 

Deleting a configuration will cause any dataflows referencing that configuration to no longer 

function properly. 

Accessing External Web Services 

The External Web Services subnode within the Management Console displays options for accessing 

external web services. 

Web services are services that are provided by a host and which you access remotely over the Internet 

using the HTTP protocol. The services provided by the host usually involve some type of data processing. 

To use a web service, you submit a request to the host URL. The request can include a set of data that 

you want the web service to process in some way. When the web service has completed its work, it 

sends back a response that includes the processed data. 

Currently, only external web services that use either REST, or SOAP 1.1 or 1.2 messaging, can be accessed 

using MapInfo Spatial Server. 

For more information, see: 

• Adding an External Web Service on page 259 

• Modifying an External Web Service on page 261 

• Renaming an External Web Service on page 262 

• Deleting an External Web Service on page 262 

Adding an External Web Service 


2. Expand the Resources node, then click External Web Services. 

3. Click Add. 

4. In the Name field, enter the name you want to give the external web service. The name must be 

unique. 

5. Under External service type, select the web service type you are calling: SOAP (Simple Object 

Access Protocol) or REST (Representational State Transfer). 

6. In the Timeout field, enter the number of seconds that are allowed to elapse before a request submitted 

to the web service times out. 

User's Guide 


Note: The timeout value you specify here applies to any request made to the web service. This includes 

not only transactions made against the exposed web service, but also requests made 

in the course of configuring the web service. Such configuration-type requests are invoked 

by clicking Refresh, choosing a new item in the Operation list, and running Preview. Timeouts 

can occur when performing any of these actions. If timeouts do occur, increasing the Timeout 

value can help to avoid them, provided the web service is actually up and running. 

259


260 

7. Click the Expose as service check box to access the web service from the MapInfo Spatial Server 

API. If this box is checked, the "Exposed" column in the External Web Services view will say "true." 

8. If you want to expose the web service via SOAP or REST, click the appropriate check box in the 

Exposed service type field. You will then be able to see the service in either http://localhost:8080/soap 

or http://localhost:8080/rest. 

9. On the Options tab, enter the URL of the web service you want to access. 

10. Enter a user name and password if they are required to access the external web service. 

Note: 

Some web services require you to provide login credentials (user name and password) before 

you can access them. In this case you must provide the required credentials prior to clicking 

Refresh. Otherwise, the refresh operation will fail. 

11. Click Refresh to populate the Operation list with the operations that are available from the web 

service. 

12. In the Operation list, select the web service operation you want to perform. 

When you select a web service operation in the Operation list, the field names for the operation request 

and response are listed on the Request and Response tabs. 

13. On the Request tab, specify the settings and values you want for the request fields, according to 

whether you selected SOAP or REST as the web service type. 

If you selected SOAP: 

a) Select a location path in the Filter list, if desired. 

The Filter list contains a list of all XPath location paths available from the external web service. 

If you want only a subset of available XPath location paths to be displayed in the table, select a 

path in the Filter list. All XPath location paths that match the selected path, and any descendant 

paths, are then displayed in the table and will be included in the request. 

b) Change the default field name, if desired. 

Each XPath location path in the table is associated with a corresponding request field that is 

given an initial default name provided by the external web service. For each request field, you 

can either accept the default name or enter a new name. 

c) Specify a default value for each request field, if desired. 

d) Select the Expose option for each request field you want to expose as an available input field in 

the resulting MapInfo Spatial Server service. If you want to expose all request fields, select the 

Expose option in the table heading row. 

e) If you want to view a template of the XML that will be sent as a request to the external web service, 

click View Template. 

If you selected REST: 

a) Add each request parameter required to access the external web service by clicking Add and 

entering the parameter name. If you want to delete a parameter, select it in the table and click 

Delete. 

If the web service URL you entered on the Options tab included any query string parameters, 

these parameters automatically appear in the list of parameters on the Request tab. 

b) For each request parameter, enter a field name. This is the name given to the input field in the 

resulting MapInfo Spatial Server service, if the field is exposed. 

c) Specify a default value for each request field, if desired. 

d) Select the Expose option for each request field you want to expose as an available input field in 

the resulting MapInfo Spatial Server service. If you want to expose all request fields, select the 

Expose option in the table heading row. 


e) If you want to view a template of the request URL that will be sent to the external web service, 

click View Template. 

14. On the Response tab, specify the settings and values you want for the response fields, according 

to whether you selected SOAP or REST as the web service type. 

If you selected SOAP: 

a) Select the Return response XML as text option if you want the external web service response 

to be returned as a single field named SoapResponse that contains the response XML. If this 

option is not selected, the web service response is returned as individual fields based on the 

specified mapping of field names to XPath location paths. 

If you select the Return response XML as text option, a template of the XML that will be returned 

as a response from the external web service is displayed. If you do not select the Return response 

XML as text option, continue with the remaining steps below. 

b) Select a location path in the Filter list, if desired. 

The Filter list contains a list of all XPath location paths available from the external web service. 

If you want only a subset of available XPath location paths to be displayed in the table, select a 

path in the Filter list. All XPath location paths that match the selected path, and any descendant 

paths, are then displayed in the table and will be included in the response. 

c) Change the default field name, if desired. 

Each XPath location path in the table is associated with a corresponding reponse field that is 

given an initial default name provided by the external web service. For each response field, you 

can either accept the default name or enter a new name. 

d) Select the Expose option for each response field you want to expose as an available output field 

in the resulting MapInfo Spatial Server service. If you want to expose all response fields, select 

the Expose option in the table heading row. 

A field which has its Expose option selected will be returned in the response from the external 

web service. Each field is mapped to an XPath location provided by the external web service. If 

the fields that have their Expose option selected are mapped to XPath locations that are all at 

the same level, then individual records will be returned for the fields. However, if the exposed 

fields are mapped to XPath locations at different levels, then a hierarchical data object will be 

returned. 

e) If you want to view a template of the XML that will be sent as a response from the external web 

service, click View Template. 

15. On the Preview tab, enter any test data you would like to submit to the external web service, then 

click Preview. 

16. Click OK to save the external web service. 

Modifying an External Web Service 



3. Highlight the external web service you want to modify and click Modify. The Modify Web Service 

dialog box will appear. 

4. Make the appropriate changes to the external web service and click OK. 

User's Guide 


261


Renaming an External Web Service 

Renaming an external web service will break existing jobs/services that reference the external web service. 

If no jobs/services reference the external web service, or if you want to change existing jobs/services to 

reference a different external web service or the new name, you can safely rename the external web 

service. 



3. Highlight the external web service you want to rename and click Rename. 

4. Confirm that you want to rename the external web service by clicking OK. 

5. Enter a new name for the external web service, then click OK. 

Deleting an External Web Service 

262 

Deleting an external web service will break existing jobs/services that reference the external web service. 

If no jobs/services reference the external web service, or if you want to change existing jobs/services to 

reference a different external web service, you can safely delete the external web service. 



3. Highlight the external web service you want to delete and click Delete. You will receive a confirmation 

message asking if you wish to delete the external web service. 



Managing Execution 


• Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .264 

• Jobs and Process Flows . . . . . . . . . . . . . . . . . . . . . . . . .266 

• Transaction History . . . . . . . . . . . . . . . . . . . . . . . . . . . . .271 

• Remote Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .272 

• Sort Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .276 

10

Services 

Services 

Services are processing capabilities that you can access using MapInfo Spatial Server API. You can 

use the API to call a service, passing a record to MapInfo Spatial Server. You can also specify the options 

to use when processing the record. 

Some services become available when you install a module. For example, when you install the Universal 

Addressing Module the service ValidateAddress becomes available on your system. These services are 

listed in teh Component Reference section of this document. In other cases, you must create a service 

in Enterprise Designer then expose that service on your system as a user-defined service. For example, 

the Locaiton Intelligence Module's stages are not available as services unless you first create a service 

using the module's stages. 

Specifying Default Service Options 

Default service options control the default behavior of each service on your system. You can specify a 

default value for each option in a service. The default option setting takes effect when an API call does 

not explicitly define a value for a given option. They are also the settings used by default when you create 

a dataflow in Enterprise Designer using this service. 

1. Open Management Console. 

2. Select a service. The Options tab containing options for that service will appear. In the following example, 

we've selected Geocode US Address. 

3. Select your options. 

Previewing a Service 

264 

You can preview the results of a service using the Preview tab. Preview can be useful in helping you 

decide what options to specify because you can immediately see the effect that different options have 

on the data retured by the service. 


2. On the left side of the Management Console, select a service. 

3. Click the Preview tab. 


4. Enter test input data manually or import data from a file. You do not have to enter data in every field. 

You can leave fields blank as necessary. 

• To enter data manually, simply type the test data into each field. 

• To import test data from a file, click the Import Data button. The maximum number of records you 

can import is limited to the maximum number of records your system is configured to process. For 

more information, see Limiting the Number of Records to Process on page 265. 

Note: 

See the Component Reference section of this guide for a detailed description of the input 

fields for each service. 

5. Click the Run Preview button. Data will appear in the output grid. 

6. Review your output data, making sure the results are what you intended to get from the service. If 

necessary you can make changes to the service's settings and click Run Preview again. (You do not 

need to input the data again.) 

The default view is vertical; if you wish to change your view to horizontal, Click the View button and 

select Horizontal. 

Note: 

See the Components section of this guide for a detailed description of all the output fields. 

Limiting the Number of Records to Process 


2. Click Tools > Options. 

3. In the Maximum number of records to process field, enter the maximum number of records that 

a service can process. The maximum number you can enter is 100. 

User's Guide 

Chapter 10:Managing Execution 

265

Jobs and Process Flows 

Specifing a Field Separator 

A field separator, or delimiter, is the character used to mark the end of one field and the start of another 

when you use a flat file as input to a service. To specify the field separator to use for services, 



3. In the File field separator field, specify the delimiter character to use. If the character you want is 

not listed, 

a) Click the . . . button. 

b) Click Add. 

c) After you enter or select a character press Tab. The Unicode field will automatically be completed. 


completed. 

d) If you wish, enter a description of the character in the Description field. For example, if the character 

is "&" the description could be "ampersand." If you do not enter a description, the character 


e) Click OK twice. 

Setting Service Timeout 



3. In the Time-out in seconds field, specify the number of seconds to wait for a response before the 

service times out. 


A job is a dataflow that performs batch processing. A job reads data from one or more files or databases, 

processes that data, and writes the output to one or more files or databases. 

A process flow executes a series of activities such as MapInfo Spatial Server jobs and external applications. 

For example, a process flow could run a MapInfo Spatial Server job to standardize names, validate 

addresses, then invoke an external application to sort the records into the proper sequence to claim 

postal discounts. 

Use the Management Console to set global job and process flow settings and manage job and process 

flow execution. To create or edit jobs and process flows, use Enterprise Designer. 

Scheduling Jobs and Process Flows 

266 

If you have jobs or process flows that you want to run automatically at a specified time, use the Management 

Console to set up job and process flow execution schedules. 



2. Browse to Execution then click Scheduling. 

3. Click Add to create a new schedule or, if you want to modify an existing schedule, choose the 

schedule and click Modify. 

4. In the Add Task or Modify Task window, choose the settings for this task. 

• Task Name—The name you want to give to this scheduled task. This is the name that will be 

displayed in the task listing. 

• Flow type—Choose the type of process you are scheduling, either a job or a process flow. 

• Flow name—Select the job or process flow that you want to schedule. Only jobs and process 

flows that are saved and exposed are available here. If the job or process flow that you want is 

not shown, open the job or process flow in Enterprise Designer then select File > Expose/Unexpose 

and Save. 

• Enable task—Check this box to run the job or process flow at the specified time. Clear this box 

to suspend the schedule. 

• Schedule—Specify the date and time you want the job or process flow to run. 

5. Any input or output files referenced by a scheduled flow must reside on the MapInfo Spatial Server 

server. This applies both to jobs executed by the scheduler as well as job activities within a process 

flow executed by the scheduler. If the Read from File or Write to File stages reference local files 

perform one of the following procedures: 

Options 

Option 1: Modify the 

dataflow 

Option 2: Override the 

dataflow file location 

when this schedule 

runs 

Description 

You can modify the dataflow itself so that it no longer references local 

files. 

1. Open the dataflow in Enterprise Designer. 

2. Double-click the Read from File or Write to File stage. 

3. In the File name field, click the browse button. 

4. Click Remote Machine then select the file you want. 

Note: If you are running Enterprise Designer on the same machine 

as the MapInfo Spatial Server server, it will appear that 

clicking Remote Machine is no different than clicking My 

Computer. However, you must select the file using Remote 

Machine in order for the system to recognize the file as being 

on the MapInfo Spatial Server server. 

You can override the file references contained in the flow when this 

schedule runs. 

1. Click Options. 

2. Under Stage file locations select the stage that references a local 

file. 

3. Click Modify and select the file on the MapInfo Spatial Server server. 

6. If you want the job or process flow to run on a recurring schedule, check the Task recurrence check 

box then click the Recurrence button and complete the fields. 

7. If the job or process flow has email notification enabled you can specify additional recipients for the 

notifications that will be sent when this scheduled task runs. For instructions on enabling notification 

for a job or process flow, see E-mail Notification on page 94. To specify additional recipients for 

email notifications: 

User's Guide 


267


a) Click Options. 

b) Under Notification, click Add. 

c) Enter the email address you want the notification to be sent to. For example, me@mycompany.com. 

d) Verify that your system's notification settings have been configured. For more information, see 

E-mail Notification on page 280. 

8. Click OK. 


268 


2. Expand Execution then click History. 

3. Click the Jobs tab to view the history of job execution. Click the Process Flows tab to view the history 

of process flow execution. 

The Jobs tab is used to monitor job status and to pause, resume, or cancel jobs that are running as 

well as delete completed jobs. The Jobs tab displays the ID number, report number, job name, user, 

dates, job status, number of records processed, the number of records succeeded, failed, and malformed, 

and any comments returned from the server in a grid format. This information is collected 


The Process Flows tab is used to monitor process flow status and to cancel process flows that are 

running as well as delete completed process flows. The Process Flows tab displays the ProcessID 

number, the ProcessFlowID name, the name of the user who started the process flow, the status of 

the process flow, times when the process flow started and ended, and any comments returned from 

the server in a grid format. This information is collected automatically. If you click the plus sign next 

to any given process flow, you will view Activity Status information for the process flow. The following 

information is included in this area: 

• ActivityName—includes the names of all activities, including any success activities, that make up 

the process flow 

• State—the status of the activity (whether it has completed or not) 

• ReturnCode—any codes that were returned when the activity ran 

• Started—the date and time the activity started 

• Finished—the date and time the activity ended 

• Comment—any comments associated with the activity 

4. Select the fields you want displayed in the Execution History by clicking the icon just to the left of the 

first column. 

This is the Field Chooser. 


5. You can group types of information together in the Execution History. Simply highlight a column name 

(such as ID or Name) and drag it up to the area that says, "Drag a column header here to group by 

that column." The information will then be grouped by that type of information. For instance, if you 

group by name, your Execution History might look like the following: 

6. You can sort the data in the grid by clicking the column name. Filter the data to change the list of 

process flows shown by doing the following: 

User's Guide 


a) Click on the drop-down list next to Show only process flows where to select a variable (such as 

ProcessID). 

b) Select one of the criterion in the next drop-down (such as "greater than or equal to"). 

c) Type in a comparison value (such as zero) in the last box. 

d) Click Refresh to refresh the data. 

269


7. The Details screen allows you to view the job definition or the process flow definition, which shows 

the dataflow. It also allows you to see how a dataflow was built if it's no longer accessible by Enterprise 

Designer. 

a) Click the job or process flow you wish to view then click Details.... 

The left pane displays the name of the job or process flow you selected and allows you to select 

to see the Execution Information or the flow definition. Within the Execution Information, you can 

select any activity within the process flow. 

b) Click Job/Process Flow Definition on the left pane to review the processing selections for that 

flow. 

Pausing and Resuming a Job 

To pause and resume a job that is running: 



3. Click the Jobs tab. 

4. Select the job you want to pause then click Pause. 

5. To resume job execution, click Resume. 

Canceling a Job or Process Flow 



3. Click the Jobs tab. 

4. Select the job you want to cancel then click Cancel. 

Setting the Malformed Records Threshold 

270 

You can specify how many malformed records to allow before a job stops processing. For example, if 

you specify 50, jobs containing 50 or more malformed records will not complete processing successfully. 

Note: 

A job definition may override this global malformed records setting. 


2. Expand Execution then click Job Options. 

3. Select one of the following: 

• Do not terminate the job on a malformed input record—Select this option to allow an unlimited 

number of malformed records in a job. 

• Terminate the job after reading _ malformed records—Select this option to terminate jobs if 

a certain number of malformed records are encountered. Enter the number of malformed records 

after which you want a job to stop processing. 


Setting Reporting Options 

If a job includes a report stage the job generates a report file as specified in the job definition. Reports 

can include processing summaries or postal forms such as the USPS CASS 3553 form. The kind of reports 

available depend on the modules you have installed. 


2. Expand Execution then click Report Options. 

3. Select the format to use for reports by selecting html, pdf, or txt. 

4. Check the Store report snapshot box to have the system store information indicating that a report 

was registered as well as the actual report snapshot. 

5. Check the Archive reports box if you wish to save report snapshots. In the Report archive location 

field, specify the location where you want to keep the archived reports. 

6. Check Overwrite existing reports if you want new reports to write over previous reports. 

7. Complete the Naming template to reflect how you want to name your reports. 

Transaction History 

The Transaction History contains data on service usage for the date range you specify. Data is summarized 

and sorted by service and by user. 

Viewing Transaction History 


2. Expand Transaction History then click Report. 

3. Select a date range for your report. You can select from the following options: 

• All dates—includes a history report for all transactions. 

• Dates before and including—includes transactions up to a certain date when you enter an end 

date 

• Dates after and including—includes transactions after a certain date when you enter a start date 

• Dates between—includes transactions between two dates when you enter both a start date and 

an end date. 

4. Click View Report to run and view the report. The Transaction History Report for the date range you 

specified is displayed. This report shows Successes, Failures, and Errors for calls to each service 

by service and by User. 

5. Click the Export button if you wish to save the report to an external file. 

Setting Transaction History Options 


2. Expand Transaction History then click Options. 

User's Guide 


271

Remote Servers 

3. Check the Enable transaction history tracking check box to turn on this option. All subsequent 

transactions with the service(s) and server will be recorded. 

4. If you want to delete transactions from the log, click the drop-down box next to Clear all transaction 

log entries occurred on or before and enter a date (MM/DD/YYYY) or select a date from the calendar 

that appears below. 

5. Click Clear to delete the transactions. 


If you have multiple servers running MapInfo Spatial Server you can distribute processing among the 

servers by routing the processing for a given service to another server. This feature enables users to 

access services available on non-local servers, reducing time for installation and maintenance of those 

services. It also allows users to design custom dataflows that include services installed on remote servers. 

When a service is routed to another server, the execution of the service will take place on the remote 

server, whether the services is within a dataflow, executed from Interactive Driver, or called using the 

MapInfo Spatial Server API. 

To determine if a service is eligible for routing, open the Management Console, click that service, and 

see if the Routing button at the bottom of the Options tab is enabled. 

Note: 

A real-time license is required on the remote machine to execute batch dataflows on remote 

server modules. 

Tools deployed with a particular product are available only on the machine where that product is physically 

installed. For example, if the Enterprise Geocoding Module is installed on both local and remote servers, 

the tools for that module will display only for the local server version. If you are running the Enterprise 

Geocoding Module only on a remote server, tools will not display at all. 

For additional information, see: 

• Adding a Remote Server on page 272 

• Routing a Service to a Remote Server on page 273 

• Modifying a Remote Server on page 274 

• Deleting a Remote Server on page 274 

• Troubleshooting Remote Server Errors on page 275 

Adding a Remote Server 

272 

Follow the steps below to add a remote server. 


2. Under System, select the Remote Servers subnode. The Remote Servers dialog box appears. 

3. Click Add. The Add Remote Server dialog box appears. 

4. Enter the name of the remote server in the Name field (required). 

5. Enter the host name or IP address of the remote server in the Host field (required). 

6. Enter the port number in the Port field (required). 

7. Enter a valid user name for the remote server in the User name field (required). 


8. Enter a valid password for the user name you entered in step 6 in the Password field (required if the 

server requires it). 

9. In the Microbatch size field, enter the number of records passed at one time, between 1 and 99 

(required). The default is 50. Entering a higher number in this field will speed up input and ouput but 

slow down data transmission. 

10. Enter the number of seconds, between 1 and 99, when the connection should time out in the Timeout 

field (required). The default is 2. 

11. Check the Use Secure Sockets Layer box if the remote server you are trying to connect to is behind 

a firewall with only HTTPS access. 

12. If you wish to test the connection, click the Test button. If you successfully added a remote server, 

you will receive a message that says, "Remote server connection test successful." 

If the remote server test fails, you will receive a message that says, "Remote server test failed," along 

with the reason for the failure. 

If the remote server test takes longer than you would like to wait to test (which implies that the test 

will fail), you have the option of clicking the Stop button, shown below. 

13. Click OK. 

14. Click Refresh after adding or deleting a service on a remote server to update Management Console. 

(Conversely, when you add, modify, or delete a remote server, Management Console will refresh 

automatically.) 

Routing a Service to a Remote Server 

The Routing button enables you to specify a different server to use for a stage or service's processing, 

reducing time for installation and maintenance of those services. It also allows you to design custom 

dataflows that include services and stages installed on remote servers. 

Note: The action to run a service through a remote server can be overridden in Enterprise Designer 

or the MapInfo Spatial Server API. For more information on using remote servers in Enterprise 

Designer, please see Remote Servers on page 272. Routing cannot be overridden in Interactive 

Driver; instead, Interactive Driver will use the routing that is designated in Management Console. 

Follow the steps below to route a service or stage through a remote server: 


User's Guide 


273


2. Make sure the server you want to route to has been defined. For instructions see Adding a Remote 

Server on page 272. 

3. Select the module you want to route to a remote server. 

4. On the Options tab, click Routing. If the Routing button is grayed out then routing is not available 

for this module. The Routing dialog appears. 

5. Click Remote and select the remote server to which you wish to route the process for this stage. 

6. Click OK. 

When you add a remote server that contains services or stages not also available on a local server, it 

brings with it the default options from that remote server. 

When you make changes to services or stages on a remote Management Console, those changes will 

not be reflected on the local server. The local Management Console will reflect its own default options. 

Modifying a Remote Server 

Follow the steps below to modify a remote server. 

1. Under System, select the Remote Servers subnode. The Remote Servers dialog box will appear. 

2. Highlight the server you want to update and click Modify. The Modify Remote Server dialog box 

will appear. 

3. Make the appropriate changes to the server and click OK. 

4. Click Refresh after adding or deleting a module on a remote server to update Management Console. 



Deleting a Remote Server 

274 

Follow the steps below to delete a connection. 

Note: 

If someone else is using a dependent dataflow, you will not be able to delete the remote server. 

1. Under System, select the Remote Servers subnode. The Remote Servers dialog box will appear. 

2. Highlight the server you want to update and click Delete. 


3. You will receive a confirmation message asking if you wish to delete the server. Click OK to confirm. 

4. Click Refresh after adding or deleting a module on a remote server to update Management Console. 



5. Deleting a configuration will cause any dataflows referencing that configuration to no longer function 

properly. If you delete a remote server that has a service or stage routed through it, you are prompted 

to change the routing of that service or stage. 

• To prevent affected services, stages, and dataflows from becoming unusable, reconfigure the 

order of servers, in order of preference, that you wish to replace the server being deleted and 

click Next. 

• The Verify Dataflow References dialog will appear if you have any dataflows that use the remote 

server you are deleting. 

• The Verify Service References dialog will appear if you have any services or stages that use 

the remote server you are deleting. 

• Review the information on these dialogs and change the server that the dataflows or services 

used. Click Finish. 

Troubleshooting Remote Server Errors 

This section discusses possible error conditions you may experience when using remote servers. 

Module Not Licensed 

A real-time license is required to execute remote server modules. If you try to run a preview with an unlicensed 

module, you will receive an error similar to the following: 

User's Guide 


275

Sort Performance 

Remote Server Not Available 

If you have Management Console open with services installed only through a remote server (not locally) 

and you shut down that remote server, the remote services will disappear from the left pane and you 

will see a yellow hazard icon in the status bar at the bottom of the screen: 

Click this icon to see an error message that describes which remote servers are not available. This same 

message will appear if you try to launch Management Console and the remote server is not running. 

Routing Has Changed 

If you delete or undeploy a service that is installed both locally and remotely and has been routed through 

a remote server, and then click that service within Management Console, you will see a routing change 

indicator (a blinking exclamation point) next to the routing button on the Options tab for that service. This 

indicator means the routing has changed for that service. 

Sort Performance 

276 

Sort Performance options enable you to optimize the performance of sorting operations on large data 

sets. The sort performance values you specify in the Management Console can be overridden in individual 

stages that perform sorting operations on data. 

To specify sort performance settings: 


2. Expand Execution then click Sort Performance. 

3. Use these settings to control sort performance: 






disk. 









Monitoring Your System 


• Event Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .278 

• Custom Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .279 

• E-mail Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .280 

• Configuring License Expiration Notification . . . . . . . . .281 

• Viewing Version Information . . . . . . . . . . . . . . . . . . . . . .281 

• Viewing and Exporting License Information . . . . . . . . .282 

11

Event Log 

Event Log 

Viewing the Event Log 


2. Expand Event Log then click Events. The window displays the information in the current log. These 

log entries include both system logging and service logging. 

3. Click Refresh to view the latest entries. 

4. Check Show events upon open to turn on (or turn off if already checked) the events log. 

You can also view the event log by using a text editor and opening the file \server\repository\logs\system.log. 

Setting Event Log Options 

278 

You can specify the default logging level as well as logging levels for each service on your system. When 

you change logging levels the change will not be reflected in the log entries made before the change. 


2. Expand Event Log then click Options. 

3. Click the System default logging level drop-down list to select an event logging level. Event logging 

levels include the following: 

• Disabled—no event logging enabled. 

• Fatal—minimal logging, logs only fatal errors. Fatal errors are those that make the system unusable. 

• Error—logs only errors and fatal errors. Errors make a single call unusable, possibly a single service, 

but not the whole system. The inability to load a specific service might be an error since other 

services would be available. 

• Warn—event warnings and errors are logged. Warnings indicate problems that do not stop the 

system from working (for example, when loading a service where a parameter has an invalid value, 

a warning is issued and the default parameter is used). During the use of a service, if results are 

returned but there is a problem, a warning will be logged. An example might be that casing was 

set to lower case, but Canadian does not support casing. Results are returned with a warning that 

the casing option was ignored. 

• Info—logging of high-level system information. This is the most detailed logging level suitable for 

production. Info level will typically be used during startup and initialization, providing product and 

version information, which services were loaded, etc. 

• Debug—a highly detailed level of logging, suitable for debugging problems with the system. 

• Trace—the most detailed level of logging, tracing program execution (method entry and exit). It 

provides detailed program flow information for debugging. 

Each logging level includes the ones above it on the list. In other words, if Warning is selected as 

the logging level, errors and fatal errors will also be logged. If Info is selected, informational messages, 

warnings, errors, and fatal errors will be logged. 

Note: 

Selecting the most intensive logging level can affect system performance. Therefore, you 

should select the least intensive setting that meets your particular logging requirements. 


4. If you want to specify different logging levels for each service choose the logging level you want. 

Custom Logs 

You can create user-defined logs using your own database tables. These logs can then be used as 

dataflow sinks to capture information about the dataflow when it is executed. 

All logs contain standard fields, including the following: 

• Time stamp 

• Job ID 

• Job Name 

• Job User 

Custom logs allow you to add other fields as well. 

The table below shows the capabilities of internal and external logs. 

Feature 

Write to Tables 

Write to Views 

Write to Stored Procedures 

For additional information, see: 

Internal DB Log 

Yes 

No 

No 

• Creating a Custom Log on page 279 

• Modifying a Custom Log on page 280 

• Deleting a Custom Log on page 280 

• Clearing a Custom Log on page 280 

Creating a Custom Log 


2. Expand Custom Logging then click Logs. 

3. Click Add. The DataSource Connection dialog box will appear. 

External DB Log 

Yes 

Yes 

Yes, but not Oracle 

4. Select the appropriate connection and click OK. The New Log dialog box will appear. 

5. Enter the name of the custom log in the Log Name field. 

6. If desired, click the ... (Browse) button to select a table. The Select Database Item dialog box will 

appear. 

7. Enter SQL syntax in the Filter field to narrow results in this screen. 

8. Select the database entity (table, view, or stored procedure) you want to work with and click Open. 

You should see fields shown in the table on the New Log screen. 

9. If desired, enter new fields by typing directly in the table in the Field Name column. 

User's Guide 

Chapter 11:Monitoring Your System 

279


Note: 

If you selected "SQL" in step 3, the database you use must already existing and must contain 

the standard fields mentioned above (plus any additional fields you choose to add). 

10. Check the Select/Deselect all check box to select or deselect all fields to include in the log file. 

Now you can add the log sink to a dataflow within Enterprise Designer. 

Modifying a Custom Log 



3. Select the log you want to modify and click Modify. The DataSource Connection dialog box will appear. 

4. Modify the log as desired and click OK. 

Deleting a Custom Log 



3. Select the log you want to delete and click Delete. You will receive a confirmation message asking 

if you wish to delete the connection. 


Clearing a Custom Log 



3. From the Custom Logging screen, select the log whose contents you want to clear and click Clear. 

You will receive a confirmation message asking if you wish to clear the contents of the log. 



280 

MapInfo Spatial Server can alert you to potential problems to ensure that critical business processes 

are not interrupted. Notifications are sent as a result of conditions within dataflows and process flows. 

The messages can be formatted to contain context-sensitive information about the event that occurred. 


2. Expand System then click Notification. 

3. On the SMTP Settings tab, enter a valid host name or IP address in the Host field. 

4. Enter a valid port number or range in the Port field. The default is 25. 

5. Enter the user name for logging on to the SMTP server in the User Name field. 

6. Enter a password for logging on to the SMTP server in the Password field. 


7. If you completed the Password field, re-enter the password for logging on to the SMTP server in the 

Confirm Password field. 

8. Enter a valid e-mail address to where notification e-mail will be sent in the From Address field. 

9. Enter a valid e-mail address to where notification e-mail will be sent in the Test Address field. This 

is used to ensure the notification process works. 

10. Click Test to send a test message, using the current configuration, to the address you entered in 

step 7. 

For information about the Expiration Settings tab, see Configuring License Expiration Notification 

on page 281. 

Configuring License Expiration Notification 

You can have MapInfo Spatial Server send an email notification when a license is about to expire. 


2. Expand System then click Notification. 

3. Click the SMTP Settings tab. See E-mail Notification on page 280 for information about configuring 

the fields on this tab. 

4. Click the Expiration Settings tab. 

5. In the Days before expiration to send notification field, specify the number of days in advance 

that you want to be notified of a pending license or data expiration. For example, if you want to be 

notified 30 days before a license expires, specify 30. 

6. Check the Send expiration notification check box. 

7. Click Add and specify the email address you want to receive the notification. 

8. Select File > Save. 

Viewing Version Information 


2. Expand System then click Version Information. 

3. The Version Information window presents information on the configured services. Expanding the 

Server Information, System Information, Service Information, and Component Information folders 

will present the corresponding details. This includes versions numbers of the server, the operating 

system, the service software, and component versions. 

Note: 

User's Guide 

This information is view-only. 

Chapter 11:Monitoring Your System 

281

Viewing and Exporting License Information 

Viewing and Exporting License Information 

282 


2. Expand System then click Licensing. 

3. Click the Expiration Info tab to view a list of licenses that are about to expire. Only licences that are 

within the timeframe specified on in the Notification node, Expiration Settings tab, are displayed. 

4. Click the License Information tab to view a complete listing of all licenses installed on your system. 

To export your license information to a .lic file, click Export. This is helpful when resolving license 

issues with Technical Support. 


Managing User Accounts 


• User Accounts Security node . . . . . . . . . . . . . . . . . . . . .284 

• Enabling User Permissions . . . . . . . . . . . . . . . . . . . . . . .284 

• Adding a New User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .284 

• Modifying a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .284 

• Deleting a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .285 

12

User Accounts 

User Accounts 

This section tells you how to set security options and define properties for users. 

Enabling User Permissions 

MapInfo Spatial Server can enforce permissions on user accounts, providing you with additional control 

of the actions a user can take. 


2. Expand Security then click Options. 

3. Click the Limit access according to user permissions checkbox to limit access to the permissions 

established for individual users. 

For instructions on defining permissions for each user, see Adding a New User on page 284, Modifying 

a User on page 284, or Deleting a User on page 285. 

Adding a New User 


2. Expand Security then click Users. 

3. Click Add. The New User window appears. 

4. Enter the user's name in the User name field. 

5. Enter the user's password in the Password field. 

6. Confirm the user's password in the Confirm password field. 

7. Enter a description of the user in the Description field. 

8. Check the services for which you would like this user to have privileges and click OK. 

Modifying a User 

284 



3. Select the user whose permissions you want to modify and click Modify. The User Properties window 

appears in which can modify the user name, password, description, and user permissions. Note that 

the length of the password is masked by the display of 24 asterisks. 

4. Click OK to save your changes. 


Deleting a User 



3. From the User Management screen, select the user you want to delete and click Delete. 

4. Click Yes to delete or No to cancel. 

Note: 

User's Guide 

Admin and guest accounts cannot be deleted. 

Chapter 12:Managing User Accounts 

285

Part IV: Modules 


• Enterprise Geocoding Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .289 

• Enterprise Mapping Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .593

Enterprise Geocoding 

Module 


• What is the Enterprise Geocoding Module? . . . . . . . . .290 

• Geocode Address [Country Code] (Deprecated) . . . . . .300 

• Geocode Address Global . . . . . . . . . . . . . . . . . . . . . . . . .360 

• Geocode Address World . . . . . . . . . . . . . . . . . . . . . . . . .425 

• Geocode US Address . . . . . . . . . . . . . . . . . . . . . . . . . . . .447 

• GNAF PID Location Search . . . . . . . . . . . . . . . . . . . . . . .496 

• Reverse APN Lookup . . . . . . . . . . . . . . . . . . . . . . . . . . . .506 

• Reverse Geocode Address Global . . . . . . . . . . . . . . . . .519 

• Reverse Geocode US Location . . . . . . . . . . . . . . . . . . . .531 

• Geocode US Address Auxiliary Files . . . . . . . . . . . . . . .548 

• Location Codes for U.S. Geocoding . . . . . . . . . . . . . . . .554 

• Match Codes for U.S. Geocoding . . . . . . . . . . . . . . . . . .571 

• Result Codes for International Geocoding . . . . . . . . . . .577 

• Custom Databases for International Geocoding . . . . . .582 

• Encountering False Positives . . . . . . . . . . . . . . . . . . . . .588 

13

What is the Enterprise Geocoding Module? 


The Enterprise Geocoding Module performs address standardization, address geocoding, and postal 

code centroid geocoding. You can enter an address and get outputs such as geographic coordinates, 

which can be used for detailed spatial analysis and demographics assignment. You can also enter a 

geocode, a point represented by a latitude and longitude coordinate, and receive address information 

about the provided geocode. 

Note: 

The Enterprise Geocoding Module, in MapInfo Spatial Server, appears as a stage and can be 

used in the client applications (Enterprise Designer, Interactive Driver, Management Console). 

Enterprise Geocoding Components 

Enterprise Geocoding Module consists of the following components. The specific components you have 

depend on your license. 

• Geocode Address —Takes an address and returns latitude/longitude coordinates and 

other information. Each country has its own component. For example, the Canadian geocoding component 

is Geocode Address CAN. For more information, see Geocode Address [Country Code] 

(Deprecated) on page 300. 

• Geocode Address Global—Takes an address for multiple countries and returns latitude/longitude 

coordinates and other information. This component will only geocode addresses from countries you 

have licensed. For more information, see Geocode Address Global on page 360. 

• Geocode US Address—Takes an input address and returns latitude/longitude coordinates and other 

address information. For more information, see Geocode US Address on page 447. 

• Reverse APN Lookup—Takes an Assessor's Parcel Number (APN), Federal Information Processing 

Standards (FIPS) county code, and FIPS state code and returns the address of the parcel. For more 

information, see Reverse APN Lookup on page 506. 

• Reverse Geocode US Location—Takes as input a geocode (latitude and longitude coordinate) and 

returns the address of the location. For more information, see Reverse Geocode US Location on 

page 531. 

Enterprise Geocoding Databases 

290 

The following table lists the Enterprise Geocoding Module databases. The databases are installed on 

the MapInfo Spatial Server server. Some of the databases are available by subscription from Pitney 

Bowes Business Insight and are updated monthly or quarterly. Others are licensed from the USPS ® . 


Table 40: Enterprise Geocoding Module Databases 

Database Name & Description 

U.S. Geocoding Databases 

These databases contain the spatial data necessary to perform 

address standardization and geocoding. You must install 

at least one of these databases. You set the database that 

you want to match against with the processing options. Enterprise 

Geocoding tries to match to the database you indicate. 

To verify you are matching to the database you want, you 

can review the value returned in the StreetDataType output 

field. 

These databases use proprietary files called GSD files. For 

ZIP Code centroid matching, the file us.Z9 contains all the 

centroid info for all states and normally has a z9 extension. 

• Centrus Enhanced Geocoding—This database consists 

of TIGER data provided by the U.S. Geological Survey and 

address data provided by the U.S. Postal Service. 

• GDT Geocoding—This database provides more up-to-date 

data than the Centrus Enhanced Geocoding database. It 

requires an additional license. GDT data is provided by 

Tele Atlas, a third-party provider of spatial data, and postal 

data from the U.S. Postal Service. 

• NAVTEQ Geocoding—This database provides more upto-date 

data than the Centrus Enhanced Geocoding database. 

It requires an additional license. NAVTEQ data is 

provided by NAVTEQ, a third-party provider of spatial data. 

For more information about these databases, contact your 

sales representative. 

• ZIP + 4 Centroid—This database provides only address 

standardization and ZIP + 4 centroid matching. It does not 

provide street-level matching. 

Each geocoding database has an optional Statewide Intersections 

Index. The Statewide Intersection Index is designed to 

enable fast intersection identification on a statewide basis. 

For example, the Statewide Intersection Index will allow the 

database search for "1st and Main St, CO" and return a list 

of possible matches in Colorado more quickly than searching 

the entire geocoding database for each instance of the intersection. 

User's Guide 

Chapter 13:Enterprise Geocoding Module 

Required or Optional 

Required for U.S. 

geocoding 

Supplier 

Pitney Bowes Business 

Insight 

monthly subscription 

291


292 


International Geocoding Databases 

International geocoding databases contain the spatial data 

necessary to perform address standardization and geocoding 

for locations outside the U.S. Each country has its own database, 

and some countries have optional databases that 

provide enhanced geocoding. 

Australia Geocoded National Address File (G-NAF) 

This database provides enhanced geocoding for Australian 

addresses. This is the only authoritative Australian national 

index of locality, street and number, validated with geographic 

coordinates. It contains both officially recognized rural and 

urban addresses and unofficial addresses (aliases). Postal 

addresses and PO Boxes are not included. However, because 

some rural areas do not have adequate rural address information, 

roadside mail box (RMB) numbers, Lot numbers, and 

Block & Section numbers have been included in the G-NAF 

data set. 

When you install this database there will be two subfolders: 

• GNAF123—Contains the point-level dictionary. This has 

the highest precision of geocoding (characterized by Reliability 

Level 1, 2, or 3.) 

• GNAF456 —Contains the remainder of address information 

in G-NAF that does not meet high precision geocoding criteria 

(characterized by Reliability Level 4, 5, or 6.) 

You must specify each of these as separate database resources 

in the Management Console. 

We recommend that you use both databases to validate the 

existence of addresses but only use the GANF123 for parcellevel 

geocoding. If you do not require parcel-level geocodes 

you can use the GANF456 database for geocoding. 

United Kingdom Address-Point Database 

The Address-Point database contains street addresses and 

is derived from the Ordnance Survey ® . Candidate location 

will be usually to a resolution of 0.1 meters from the building/parcel 

delivery point. This database is suitable for applications 

that demand this highest available level of precision, 

including routing applications. 


Required for all licensed 

countries 

Optional 

Optional 

Supplier 


Insight 

quarterly subscription 


Insight 

quarterly subscription 


Insight 



The Address-Point database provides a greater level of geocoding 

precision than can be delivered by the CodePoint 

database. This high level of precision is reflected in S8 and 

S7 result codes. 

For more information on the Ordnance Survey Address-Point 

data source, see: 

www.ordnancesurvey.co.uk/oswebsite/products/addresspoint/ 

While the Ordnance Survey data source does not contain 

addresses for Northern Ireland, the Address-Point dataset 

from Pitney Bowes Business Insight is supplemented with 

Royal Mail ® postcode address data for Northern Ireland. This 

Northern Ireland data has postcode centroid (result code S3) 

precision only. 

United Kingdom CodePoint Database 

The CodePoint Postal Address File (PAF) database provides 

postcode centroid geocoding. The CodePoint database is 

suitable for most applications involving address matching, 

validation, etc. 

The CodePoint database is derived from Royal Mail and 

covers street addresses for the UK (Great Britain and Northern 

Ireland). The CodePoint database is licensed for the entire 

dataset, rather than by region. 

For more information on the Royal Mail data source, see: 

www.royalmail.com 

The postcode centroid precision provided by the CodePoint 

database is reflected in S3 result codes. 

Reverse Geocoding Database (U.S. Only) 

This database contains the data you need to convert a latitude/longitude 

location to an address. 

New Zealand Point Database 

The New Zealand Point Database is based on postal point 

data which has a roof top precision point of each unique street 

address. Location X and Y returned for candidates from this 

database are roof top precision. 

User's Guide 



Optional 

Supplier 


Insight 

Optional, but re- Pitney Bowes Busiquired 

for Reverse ness Insight 

Geocode US Loca- monthly subscription. 

Additional license 

required. 

tion 

Optional 


Insight 

293


294 


This data is maintained by the government authority, Land 

Information New Zealand. This database is a monthly update 

from what the local district councils supply. 


Supplier 

U.S. Points Databases 

Optional, but Re- Pitney Bowes Busi- 

Points databases contain data for locating the center of a 

parcel. These databases provides enhanced geocoding ac- 

curacy for internet mapping, property and casualty insurance, 

telecommunications, utilities, and others. 

verse APN Lookup 

requires Centrus 

Enhanced Points or 

Centrus Premium 

Points. Additional 

ness Insight 

monthlysubscription • Centrus Points—This database contains the data necessary 

to locate the center of a parcel or building. It does not 

contain assessor's parcel number (APN) or elevation data. 

license required. 

• Centrus Elevation—This database contains the same data 

as Centrus Points, plus data. 

• Centrus Enhanced Points—This database contains the 

same data as Centrus Points, plus APN data. 

• Centrus Premium Points—This database contains the 

same data as Centrus Points, plus both APN and elevation 

data. 

• Centrus Tele Atlas Points Database—The data in this 

database is provided by Tele Atlas, a third-party provider 

of spatial data. 

Auxiliary Files 

Auxiliary files contain user-defined records. You can use 

auxiliary files to provide custom data to use in address 

matching and geocode matching. For more information, see 

Auxiliary File Overview on page 548. 

Optional 

User-defined 

DPV Optional, but re- Pitney Bowes Busiquired 

for CASS ness Insight 

® Database (U.S. Only) 

The Delivery Point Validation database allows you to check 

the validity of any individual mailing address in the U.S. (over 

Certified monthly subscription 

145 million locations). The DPV database is distributed as an 

optional feature and can be installed to enhance the geocoding 

database's ability to validate mailing addresses. Each time 

an edition of the geocoding database is released, a corresponding 

edition of the optional DPV database is released. 

The date of the DPV database must match the date of the 

geocoding database for DPV processing to function. DPV 

lookups may not be performed after the expiration date of the 

DPV database. 

processing. 

Additional 

license required. 



For more information on DPV, see Delivery Point Validation 

(DPV) on page 299. 

Note: 

CASS processing requires the DPV option. The DPV 

option is also required to determine ZIP + 4 and ZIP 

+ 4 related output (DPBC, USPS record type, etc.). 

Postal Service licensing prohibits using DPV for the generation 

of addresses or address lists, and also prohibits the DPV 

database being exported outside the United States. 

EWS Database (U.S. Only) 

The Early Warning System (EWS) database contains data 

that prevents address records from miscoding due to a delay 

in postal data reaching the U.S. Postal database. For more 

information, see Early Warning System (EWS) on page 300. 

The USPS ® refreshes the EWS file on a weekly basis. Unlike 

the DPV and LACS Link databases, the EWS database does 

not need to have the same date as the geocoding database. 

You can download the EWS file from the CASS section of the 

USPS ® RIBBS website at: 

www.ribbs.usps.gov 

When you download the EWS database, you will receive a 

file named OUT. You must rename the OUT file to EWS.txt 

before using it. 


Optional 

LACS Optional, but required 

for CASS 

Link Database (U.S. Only) 

The LACS Link database allows you to correct addresses that 

Certified 

have changed as a result of a rural route address converting 

processing 

to street-style address, a PO Box renumbering, or a streetstyle 

address changing. For more information, see Locatable 

Address Conversion System (LACS) on page 299. 

The date of the LACS Link database must match the date of 

the geocoding database for LACS Link processing to function. 

The Enterprise Geocoding Module requires the 

LACS Link Note: 

option in CASS mode to receive ZIP + 4 and 

ZIP + 4 related output (delivery point barcode, USPS 

record type, etc.). 

User's Guide 


Supplier 

Download for free 

from USPS ® website 


Insight 

monthly subscription 

295



USPS licensing prohibits using LACS Link for the generation 

of addresses or address lists, and also prohibits the LACS Link 

database being exported outside the United States. 

Geocoding Concepts 

296 


Supplier 

Geocoding is the process of determining the latitude/longitude coordinates of an address. There are 

different ways that an address can be geocoded. In order of most accurate to least accurate, these 

methods are: 

• Point Level Matching on page 296 

• Street Matching on page 296 

• Centroid Matching on page 297 

Point Level Matching 

Point-level matching locates the center of the actual building footprint or parcel. This is the most accurate 

type of geocode and is used in industries such as internet mapping, insurance, telecommunications, and 

utilities. 

Centerline matching is used with point-level matching to tie a point-level geocode with its parent street 

segment. This provides you with additional data about the parent street segment that is not retrievable 

using only the point-level match. The output information also includes the bearing from the point data 

geocode to the centerline match. 

Street Matching 

Street matching identifies the approximate location of an address on a street segment. In street matching, 

the location is determined by calculating the approximate location of a house number based on the range 

of numbers in the location's street. For example, if the address is on a street segment with a range of 

addresses from 50 to 99, then it is assumed that the house number 75 would be in the middle of the 

street segment. This method assumes that the addresses are evenly spaced along the street segment. 

As a result, it is not as exact as point matching since addresses may not be evenly distributed along a 

street segment. 

For example, the following diagram shows the results of street-level matching along a segment with 

unevenly-spaced buildings. The first three buildings are fairly accurately geocoded because they are 

evenly spaced. The fourth building, however, resides on a slightly larger parcel than the others along 

this street. Since street-level matching assumes that the buildings are evenly spaced, the result is that 


fourth, fifth, and sixth houses are not as precise as the first three. If you were to use point-level geocoding, 

the results would be more accurate. 

Centroid Matching 

ZIP Code centroid matching is a center point of an area defined by either a ZIP Code or a ZIP + 4, and 

is the least accurate type of geocode. A ZIP Centroid is the center of a ZIP Code; a ZIP + 4 centroid is 

the center of a ZIP + 4. Since a ZIP + 4 represents a smaller area than a ZIP Code, a ZIP + 4 centroid 

is more accurate than a ZIP Code centroid. 

The following diagram illustrates centroid matching. All six houses would have the same geocode in this 

example because they all reside in the same ZIP + 4 code. 

Geocoding Match Strategies for Non-U.S. Locations 

The Enterprise Geocoding Module offers a variety of options for controlling geocoding precision and 

match rate. The following information describes different approaches for matching which you can apply 

to any country geocoder except the U.S. geocoder (Geocode US Address), which has a different set of 

options. 

Maximizing the Match Rate 

To generate the highest match rate possible, do not specify house number, street, and city/locality in 

the Close match criteria on settings on the Matching tab for each country geocoder. 

User's Guide 


297


Another way to maximize the match rate is by setting the fallback level to Postal centroid on the Geocoding 

tab. This means that the geocoder will fall back to the four-digit postcode centroid if a close street 

level match cannot be made. While this scenario might yield false positives, it may be the best matching 

solution when you have large databases to geocode. 

You should evaluate if the percentage of false positives will affect your analysis. To reduce the number 

of false positives without sacrificing hit rate, analyze the result codes after a geocoding session and adjust 

your settings accordingly. 

Maximizing Precision 

If your analysis requires highly precise geocoded addresses, choose a strategy in which the geocoder 

returns the maximum percentage of high precision geocodes and the lowest number of imprecise matches 

(false positives). To do this, use theClose match criteria settings on the Matching tab to require close 

matches to match on all address elements. Also, set no fallback level (do not select Postal centroid or 

Geographic centroid on the Geocoding tab. 

This technique may produce a lower percentage match rate, but will provide the best precision. 

Balancing Match Rate and Precision 

You may want to use a balanced strategy between match rate and geographic precision. That is, you 

may want to geocode as many records as possible automatically, but at the same time want to minimize 

the number of weaker matches (false positives). Some examples of false positives can occur when the 

geocoder: 

• Finds a street that sounds like the input street 

• Finds the same street in another city (if postal code is relaxed) 

• Finds the street but with a different house number (if house number is relaxed) 

To achieve a good balance between match rate and precision, use the following settings: 

• Close matches only—Select this option. 

• Close match criteria—Select House number and Street only. 

• Postal centroid—Do not select this fallback level. 

Postal Concepts 

298 

The following sections contain information on postal concepts used by the Enterprise Geocoding Module. 

• Dual Addresses on page 298 

• Locatable Address Conversion System (LACS) on page 299 

• Delivery Point Validation (DPV) on page 299 

• Early Warning System (EWS) on page 300 

Dual Addresses 

Geocode US Address can process input that contains two addresses for the same record on the same 

address line. For example, Geocode US Address can process the following input address: 

3138 HWY 371 PO BOX 120 PRESCOTT AR 71857 


Geocode US Address does not recognize dual addresses where the two addresses are both street addresses. 

For example, Geocode US Address does NOT recognize 135 Main St 4750 Walnut St Ste 200. 

Geocode US Address does recognize dual addresses where the two addresses are the same type of 

address but are not street addresses. For example, Geocode US Address does recognize PO BOX 12 

PO BOX 2000. 

After Geocode US Address parses the dual address, it searches for a match. Geocode US Address 

determines which address has preference for a match based on the processing mode. In CASS mode, 

Geocode US Address ignores the prefer PO Box and prefer street options, and attempts to find a match 

based on the following order: PO Box, Street, Rural Route, and General Delivery. In Relaxed mode, 

Geocode US Address recognizes the Address Preference (AddressPreference) input option. 

Note: 

Geocode US Address does not perform dual address processing in Exact and Close mode. 

Geocode US Address does not perform dual address processing on multi-line addresses. 

Locatable Address Conversion System (LACS) 

The USPS ® Locatable Address Conversion System (LACS) corrects addresses that have changed as 

a result of a rural route address converting to street-style address, a PO Box renumbering, or a streetstyle 

address changing. The following are examples of LACS Link conversions: 

• Rural Route Converted to Street-Style Address: Old Address: RR 3 Box 45 New Address: 1292 North 

Ridgeland Drive 

• Street Renamed and Renumbered: Old Address: 23 Main Street New Address: 45 West First Avenue 

• PO Box Renumbered: Old Address: PO Box 453 New Address: PO Box 10435 

LACS Link is required for CASS processing. 

Delivery Point Validation (DPV) 

Delivery Point Validation (DPV ® ) is a United States Postal Service ® (USPS ® ) technology that validates 

the accuracy of address information down to the individual mailing address. By using DPV ® to validate 

addresses, you can reduce undeliverable-as-addressed (UAA) mail, thereby reducing postage costs 

and other business costs associated with inaccurate address information. 

Without DPV ® , the address validation process only verifies that an individual address is within a range 

of valid addresses for the given street. For example, the USPS data indicates that the range of addresses 

on Maple Lane is 500 to 1000. You attempt to validate an address of 610 Maple Ln Without DPV ® , this 

address would appear to be valid because it is in the range of 500 to 1000. However, in reality the address 

610 Maple Ln does not exist: the house numbers in this section of the street are 608, 609, 613, and 616. 

With DPV ® processing, you would be alerted to the fact that 610 Maple Ln does not exist and you could 

take action to correct the address. 

DPV ® also provides unique address attributes to help produce more targeted mailing lists. For example, 

DPV ® can indicate if a location is vacant and can identify commercial mail receiving agencies (CMRAs) 

and private mail boxes. 

Although DPV ® can validate the accuracy of an existing address, you cannot use DPV ® to create address 

lists. For example, you can validate that 123 Elm Street Apartment 6 exists, but you cannot ask if there 

is an Apartment 7 at the same street address. To prevent the generation of address lists, the DPV ® 

database contains false positive records. False positive records are artificially manufactured addresses 

that reside in a false positive table. For each negative response that occurs in a DPV ® query, a query is 

made to the false positive table. A match to this table will stop DPV ® processing. 

User's Guide 


299

Geocode Address [Country Code] (Deprecated) 

Early Warning System (EWS) 

The Early Warning System (EWS) provides up-to-date address information for new and recently changed 

addresses that have not yet been updated in the monthly USPS database. EWS prevents address records 

from miscoding due to a delay in postal data reaching the USPS ® databases. 

The older the U.S. Postal Database, the higher potential you have for miscoding addresses. When a 

valid address is miscoded because the address it matches to in the U.S. Postal Database is inexact, it 

will result in a broken address. 

EWS data consists of partial address information limited to the ZIP Code , street name, predirectional, 

postdirectional, and a suffix. For an address record to be EWS-eligible, it must be an address not present 

on the most recent monthly production U.S. Postal Database. 

The USPS ® refreshes the EWS file on a weekly basis. You can download the EWS file from the USPS ® 

website at ribbs.usps.gov/files/CASS. 


300 

Attention: • Geocode Address [Country Code] (with the exception of GBR) is deprecated and may 

not be supported in future releases. 

• Use Geocode Address Global for geocoding. 

The Geocode Address [Country Code] components take an address and return the geographic coordinates. 

Geocode Address [Country Code] can geocode to street addresses and postal code centroids. 

Street intersection geocoding and geographic centroid geocoding is available for some countries. 

Each country has its own component, with the three-character ISO 3166-1 Alpha 3 code as the last part 

of the component name. For example, the component name for the Australian geocoding component is 

Geocode Address AUS, with AUS being the ISO code for Australia. The following countries are available. 

Each requires separate licenses. For more information on licensing, contact your sales executive. 

• ARG (Argentina) 

• AUS (Australia) 

• AUT (Austria) 

• BEL (Belgium) 

• BRA (Brazil) 

• CAN (Canada) 

• CHE (Switzerland) 

• CZE (Czech Republic) 

• DEU (Germany) 

• DNK (Denmark) 

• ESP (Spain, Andorra, and Gibraltar) 

• FIN (Finland) 

• FRA (France and Monaco) 

• GBR (United Kingdom) 

• HUN (Hungary) 


Input 

• IRL (Ireland) 

• ITA (Italy, San Marino, and Vatican City) 

• JPN (Japan) 

• LIE (Liechtenstein) 

• LUX (Luxembourg) 

• MEX (Mexico) 

• MYS (Malaysia) 

• NLD (The Netherlands) 

• NOR (Norway) 

• NZL (New Zealand) 

• POL (Poland) 

• PRT (Portugal) 

• SGP (Singapore) 

• SWE (Sweden) 

• THA (Thailand) 

• TUR (Turkey) 

• ZAF (South Africa) 

The Geocode Address [Country Code] components are an optional part of the Enterprise Geocoding 

Module. For more information about Enterprise Geocoding Module, including a listing of other components 

included with it, see What is the Enterprise Geocoding Module? on page 290. 

Geocode Address [CountryCode] takes an address or intersection as input. To obtain the best performance 

and the most possible matches, your input address lists should be as complete as possible, free of 

misspellings and incomplete addresses, and as close to postal authority standards as possible. Most 

postal authorities have websites that contain information about address standards for their particular 

country. 

Input Fields 




The following table lists the input fields used for geocoding. 

Note: 

User's Guide 


If you are using the API, specify input using the DataTable class. The fields described below are 

the valid column names in the DataTable class. For information on the DataTable class, see the 

"API Fundamentals" section of the MapInfo Spatial Server API Guide. 

301


302 

Table 41: Input Fields 

Field Name 

AddressLine1 

AddressLine2 


One of the following: 

• The address line containing the street name and building number.For 

Japanese addresses, the block and lot number. For addresses in the 

U.K., this can contain a building name. For example: 

Muldenweg 2 

71665 Vaihingen an der Enz 

9, rue Paul Lafargue 

93217 ST DENIS CEDEX 

calle naranjo 7 

89600 Altamira TAMPS 

• The full address. For more information, see Single Line Input on 

page 324 

• For all countries except Argentina, Great Britain, and Japan, a street 

intersection. To specify a street intersection, use double ampersand 

(&&) to separate the streets. For more information, see Street Intersection 

Input on page 327. 

For France, an input street address can include a numbered range. For 

example, consider an input address of 104-106 rue de Charenton. The 

returned candidate includes two address ranges, and the 104 close 

match is from the 100-106 range. Alphanumeric ranged addresses are 

also handled (for example, you could input a alphanumeric ranged address 

like 2A-4B. If the geocoding database has alphabetic values for 

the input house number, the geocoder returns the house number as it 

exists in the database (with or without the alphabetic character). If the 

geocoder cannot confirm alphabetic values for the input house number, 

it returns the alphabetic value that was provided on input (as long as 

the house number matched). 

The second address line of a two-line address. For example: 

26 WELLINGTON ST E 

SUITE 500 

TORONTO ON M5E 1S2 

This field is not used in Argentina, Australia, Austria, Belgium or Luxembourg, 

Brazil, Czech Republic, Denmark, Estonia, Finland, France, 


Field Name 

City 

County 

User's Guide 


Germany, Hungary, India, Ireland, Italy, Japan, Latvia, Lithuania, 

Malaysia, Mexico, The Netherlands, Norway, Poland, Portugal, Singapore, 

Slovenia, South Africa, Spain, Sweden, Switzerland (including 

Liechtenstein), Thailand, and Turkey. 

The city or town name. Your input address should use the official city 

name. For Argentina, Austria, the Czech Republic, Italy, Mexico, Portugal, 

Spain, Slovenia, and Switzerland, you may use the town alias. 

Note: In Argentina, Buenos Aires Federal District is not part of Buenos 

Aires province. If your input specifies only "Buenos Aires", 

MapInfo Spatial Server returns candidates in both the Federal 

District and in the region of Buenos Aires. 

For provincial capitals in Argentina, you can use the word Capital as 

well as the actual capital name. For example, input of "Capital, MZA" is 

equivalent to "Mendoza, MZA". 

Some areas in France are generally recognized as cities even though 

they are not truly administrative cities. These areas represent Artificial 

City Areas, or Virtual Towns. For a listing of supported virtual towns, 

see Address Guidelines for France on page 317. 

For Thailand, this field contains the subdistrict (tambon). 

For Japan, this field contains the municipality subdivision (oaza). 

For Lithuania, the city and county can be swapped on input. That is, if 

a city appears in either the City input field or in the County input field, 

the geocoder will still return the correct candidate. Similarly, a locality 

can be entered in either the Locality or City input field. 

The meaning of county varies by country: 

• ARG (Argentina)—Department 

• AUS (Australia)—The Local Government Authority (LGA) 

• AUT (Austria)—Not used 

• BEL (Belgium)—Province 

• BRA (Brazil)—Not used 

• CAN (Canada)—Not used 

• CHE (Switzerland)—Province 

• CHN (China)—Not used 

• CZE (Czech Republic)—District name or alias 

• DEU (Germany)—Kreis 

• DNK (Denmark)—Province 

• ESP (Spain)—Province 

• EST (Estonia)—District 


303


304 

Field Name 

FirmName 

LastLine 


• FIN (Finland)—Not used 

• FRA (France)—Department 

• GBR (Great Britain)—Not used 

• HUN (Hungary)—District 

• IND (India)—District 

• IRL (Ireland)—Province 

• ITA (Italy)—Province 

• JPN (Japan)—City (shi) 

• LTU (Lithuania)—County 

• LVA (Latvia)—District 

• MEX (Mexico)—Province 


• MYS (Malaysia)—Not used 

• NLD (The Netherlands)—Province 

• NOR (Norway)—District (fylke/counties) 

• NZL (New Zealand)—Region 

• POL (Poland)—District (poviat) 

• PRT (Portugal)—Not used 

• SGP (Singapore)—Not used 

• SVN (Slovenia)—Region 

• SWE (Sweden)—Kommun 

• THA (Thailand)—District (amphoe) 

• TUR (Turkey)—District 

• ZAF (South Africa)—District 

Note: If you enter addresses with the Andorran country code (AND), 

only Andorran addresses are returned, including the AND 

country code. If you enter an Andorran with a country code of 

Spain (ESP), you will still get Andorran candidates, but with the 

ESP country code. 

Company or place name. For example: 

Pitney Bowes 

4360 Dukes Rd 

Kalgoorlie WA 6430 

Aravali Vihar Police Station 

Alwar 301030 

The last line of the address. 


Field Name 

Locality 

User's Guide 


4360 DUKES RD 

KALGOORLIE WA 6430 



The meaning of locality varies by country: 

• ARG (Argentina)—Neighborhood or barrio 

• AUS (Australia)—Not used 


• BEL (Belgium)—Not used 

• BRA (Brazil)—Locality 

• CAN (Canada)—Dissemination Area and Enumeration Area (DA and 

EA) 

• CHE (Switzerland)—Not used 

• CHN (China)—Locality 

• CZE (Czech Republic)—Locality 

• DEU (Germany)—Not used 

• DNK (Denmark)—Not used 

• ESP (Spain)—Locality 

• EST (Estonia)—Locality 


• FRA (France)—Not used 

• GBR (Great Britain)—Locality 

• HUN (Hungary)—Locality 

• IND (India)—Locality 

• IRL (Ireland)—Not used 

• ITA (Italy)—Locality 

• JPN (Japan)—City district (chome) 

• LTU (Lithuania)—Locality 

• LVA (Latvia)—Locality 

• MEX (Mexico)—Locality 


• NLD (The Netherlands)—Not used 

• NOR (Norway)—Not used 

• NZL (New Zealand)—Suburb 

• POL (Poland)—Not used 

• PRT (Portugal)—Locality 


• SVN (Slovenia)—Locality 

• SWE (Sweden)—Not used 


305


306 

Field Name 

PostalCode 


• THA (Thailand)—Not used 

• TUR (Turkey)—Locality 

• ZAF (South Africa)—Locality 

Geocode Address Global can geocode addresses in which the Locality 

is input without the City. For example, the following addresses are 

geocoded identically: 

calle nicaragua 4705, palermo, capital federal 

calle nicaragua 4705, palermo 

The postal code in the appropriate format for the country. 

Australia uses a four-digit postal code system. In general, the first digit 

represents a state or territory, the second digit represents a region with 

a state, and digits three and four representing towns. For more information, 

see Address Guidelines for Australia on page 311. 

Austria uses a four-digit postal code system. The first two numbers indicate 

the sector and the last two numbers designate the delivery point 

within the sector. 

Belgium and Luxembourg use a four-digit postal code. The first two digits 

designate the sorting area (with the first digit usually representing the 

region) The next two digits represent the post office and delivery office. 

For Brazil, use the complete eight-digit postcode for the most accurate 

results (a single close match candidate). However, you can use a fivedigit 

postcode. 

Switzerland uses a four-digit postal code beginning with a number 

between 1 and 9. Liechtenstein postcodes range from 9480 to 9499. 

Canada uses a six-character postal code. The first three characters are 

typically separated from the second three with a space. The first three 

characters are the FSA, the second three are the LDU. Street address 

geocoding only requires the FSA while postal code geocoding requires 

the full postal code (FSALDU). Choose whether you wish to have a 

space between the first three and last three characters of the postal 

code. Keeping this consistent speeds up the geocoding process. 

China has a six-digit postcode system. The first two digits indicate the 

province. The third digit and fourth digits indicate the district and 

city/town. The final two digits represent the postal delivery zone or 

prominent location. Larger provinces or cities might be assigned more 

than one block of codes. For example, Guangdong Province is assigned 

51 and 52 as the first two digits. 

Note: 

For China, postal centroid geocoding requires the complete sixdigit 

postcode. However, when a postal code is provided as part 


Field Name 

User's Guide 


of an address for street geocoding, only four-digit postal codes 

are accepted and returned. 

Czech Republic has a five-digit postal code system. Postal codes are 

typically separated by a space between the third and fourth numbers, 

but variations in spacing or no spacing in postal codes is supported. 

Denmark uses a four-digit postal code beginning with a number between 

1 and 9. 

Spanish postcodes are composed of five digits (Andorra postcodes. are 

in the format AN###.) You must enter a complete postcode. 

Estonia uses a five-digit postal code system. 

Finland uses a five-digit postal code. The first two digits designate the 

post town or municipal area. The last three digits represent the destination 

post office. 

France uses a five-digit postal code. You must enter a complete postcode. 

The first two digits usually represent the department. The digits 

00 represent military addresses and there are also special digit for 

overseas territories. The last three digits represent the local delivery 

area. In the larger cities (Paris, Lyon Marseille), the last two digits represent 

the arrondissement. For example, in the postcode: 33380, 33 is 

the department 380 is the delivery area. 

Hungary has a four-digit postal code system. The first digit is for the 

postal region. 

India has a six-digit postal code system. 


In Ireland, postal data is available only for Dublin. For street-level geocoding, 

enter the full postcode in the format Dublin#, where # ranges 

from 1-24 (and one district known as Dublin6W). For postal centroid 

geocoding (or postal centroid fallback) use only the postal number as 

input. For example, specify the PostalCode as 3 rather than Dublin3. 

Only the postcode number is returned for postal centroid geocoding or 

fallback. 

Italy uses a five-digit postal code system. The first three numbers indicate 

the province and the last two numbers designate the delivery point. 

Japan uses a seven-digit numeric postal code system in the format: 

999-99999. 

Latvia uses a four-digit postal code system. The first two numbers indicate 

the routing area and the last two numbers designate the post office. 

Postal codes cannot begin with 0, 22-29, 35, 49, 55 or 58-99. 

Lithuania uses a five-digit postal code system. The LT prefix is allowed 

but is not required. 

307


308 

Field Name 


Malaysia uses a five-digit postal code system. 

Netherlands uses a postal code system of four digits followed by two 

letters. The first two numbers indicate the city and region. The last two 

numbers and two letters designate the specific house number range. 

The letters represent a distribution code. You can geocode using the 

four digits only or you can include the two-letter distribution code. 

Norway uses a four-digit postal code. The first two digits designate the 

geographic area. 

New Zealand uses a four-digit postal code. The first digit represents the 

geographic region. The second and third digits represent the postal sort 

area. The last digit represents a specific urban area, rural delivery or 

PO box lobby. 

Poland uses a five-digit postal code in the format 99-999. The first digit 

represents the postal district. The second digit represents a major subdivision 

of that district. The three numbers after the dash represent the 

delivery post office. For large municipalities, the last three digits can 

represent a particular street, section of a street, or sometimes a specific 

address. 

Portugal uses a four-digit postal code beginning with a number between 

1 and 9. More recently, Portugal instituted a seven-digit postcode with 

a dash and three additional digits following the first four digits. The 

geocoder ignores the additional three digits and returns the four-digit 

postal code. 

Singapore uses a six-digit postal code system. The first two numbers 

indicate the sector and the last four numbers designate the delivery 

point within the sector. Every building in Singapore has a unique postal 

code. 

Sweden uses a five-digit postal code beginning with a number between 

1 and 9. There is typically a space between the first three digits (the 

outward sorting part of the postcode) and the last two digits (the inward 

sorting part). 

Thailand uses a five-digit postal code system. 

Turkey has a five-digit postal code system. Postal codes are typically 

separated by a space between the third and fourth numbers, but the 

geocoder can handle variations in spacing or no spacing in postal codes. 

In the United Kingdom, each address is associated with an alphanumeric 

code up to seven characters in length. Each postcode includes an average 

of 15 addresses. In some cases, where a customer receives a 

substantial amount of mail, for example, a business, the postcode pertains 

to just that one address (a large-user postcode). 


Field Name 

User's Guide 

StateProvince 


The meaning of StateProvince varies by country: 

• ARG (Argentina)—Region or province 

• AUS (Australia)—State 

• AUT (Austria)—Region 


• BRA (Brazil)—State 

• CAN (Canada)—Province 


• CHN (China)—Province 

• CZE (Czech Republic)—Region name or alias. For example, the region 

HLAVNÍ MESTO PRAHA can be aliased as Prag. 

• DEU (Germany)—Bundesland 


• ESP (Spain)—Region 

• EST (Estonia)—Not used 

• FIN (Finland)—Region (län) 

• FRA (France)—Region 

• GBR (Great Britain)—Region 

• HUN (Hungary)—County 

• IND (India)—State 


• ITA (Italy)—Region 

• JPN (Japan)—Prefecture 

• LTU (Lithuania)—Not used 

• LVA (Latvia)—State 


• MYS (Malaysia)—State (negeri) 




• POL (Poland)—Province (voivodship) 

• PRT (Portugal)—Region 


• SVN (Slovenia)—Not used 

• SWE (Sweden)—Region (lan) 

• THA (Thailand)—Province (changwat) 

• TUR (Turkey)—Province 

• ZAF (South Africa)—State 


309


310 

Recommendations for Address Input 

Follow these suggestions to ensure that your street input data is in the best format possible for optimum 

geocoding. 

Address Guidelines for Argentina 


geocoding. 

• Thoroughfare types—Thoroughfare types and their common abbreviations are recognized and fully 

supported in input addresses. Examples of typical thoroughfare types are: 

Avendia 

Calle 

Lateral Ruta 

Ruta Provincia 

Avendia 

C 

Lat Ruta 

R P 

Av 

Clle 

L R 

RP 

• Numbers, numeric equivalents, and ordinals—Numbered streets are mapped to the named equivalents. 

For example, you can input Calle 5 or Calle cinco and get the same returned candidates. Ordinals 

are also recognized in input addresses. The following numbers and equivalents are recognized 

as part of a street name input: 

1,UNO,PRIMERO,PRIMER,PRIMERA 

5,CINCO,QUINTO,QUINTA 

Ave 

LR 

Avda 

For example, an input street name of "25 de Mayo" is recognized and handled the same way as 

"Veinticinco de Mayo". 

• Proper names and dates in street and town names—Proper names and dates are often used in 

Argentina addresses, and these are handled by MapMarker Argentina. For example, an input street 

name of "Juan F. Ibarra" is recognized and handled the same way as "Juan Felipe Ibarra". 

• Directionals in addresses—The following directionals are recognized in input addresses: Norte, 

Oriente, Este, Sur, Oueste, Occidente, Poniente, N, E, S, O, NE, NO, SE, SO, Noreste, Sudeste, 

Noroeste, Sudoeste. 

• Abbreviations in addresses—A number of common abbreviations can be used in input addresses. 

Geocode AddressARG will recognize the abbreviations and geocode successfully. For example, following 

is a small sample of equivalent abbreviations. This is not a complete list of address abbreviations. 

Bario 

Ciudad 

Colonia 

Doctor 

Francisco 

Manza 

BAR 

CD 

COL 

DR 

FCO 

MZA 

CD. 

COL. 


Address Guidelines for Australia 

Follow these guidelines to provide input that Geocode Address Global can successfully geocode. For 

additional information on Australia addresses, see the Australia Post website: www.auspost.com.au. 

• Required fields—Addresses must contain either a city or a postal code. 

• House numbers and apartments—Remove spaces between house number and apartment letter. 

123 A Main Street does not geocode correctly because the geocoder assumes that the name of the 

street is A. Two workaround options are available: 

• Do not include the apartment letter. 

• Delete the space between house number and apartment letter: 123A Main Street geocodes because 

the geocoder ignores the A. 

• House numbers and unit information—The house number pinpoints the location of the address. 

Unit input can be in one of two formats, as shown in the following examples: 

• Flat 2, 17 Jones St. 

• Apt 19, 123 Main St., where Apt is the unit type and 99 is the unit number. In this format, you must 

specify a valid unit type, otherwise the address will not be geocoded correctly. For a listing of valid 

unit types, see www.auspost.com.au. 

• 99-123 Main St. For an address derived from the G-NAF database, this address is a unique house 

number and is geocoded as a single delivery point, not as a range. 

• Directional suffixes—Use directional suffixes wherever possible. This is especially true in towns and 

cities that consist mainly of numbered streets. These streets can only be distinguished by their directional 

suffixes and street types. They also distinguish addresses on streets that change direction. For 

example: 123 Queen St W and 123 Queen St E would have very different coordinates. 

• Street types—These distinguish different streets of the same name. For example, Main Avenue and 

Main Street are two entirely different entities. Using types is not essential, but it adds precision to your 

data. For a listing of street types, see www.auspost.com.au. 

• City/suburb name—Enter the city/suburb name in the City field. Note that all input addresses must 

contain either a city or a postal code. If the geocoder does not make a close match on the street in 

the specified suburb, it can make a close match on the Local Government Area (LGA). Local Government 

Area (LGAs) do not encompass all of Australia. For example, LGAs do not cover extensive 

northern parts of South Australia, a large part of the Northern Territory, and the Australian Capital 

Territory. An LGA can include a number of official suburbs. It is best to use the suburb name for geocoding 

purposes, but it is possible to get a match on the LGA (or to return LGA information) in geocoded 

results. 

• Postal code—All postcodes consist of four digits. While there are exceptions, the general format of 

postcodes is as follows: 

Note: 

These are general guidelines, and there are exceptions to these postcode number ranges. 

• Digit 1 represents the state or territory, within the following general conventions: 

2 

User's Guide 

2600 and 2900 

NSW 

ACT 


311


312 

3 

4 

5 

6 

7 

0 

• Digit 2 represents a region within the state. State or territorial capitals usually have a 0 or 1 as the 

second digit. 

• Digits 3 and 4 represent towns. Major towns usually have a 0 as the last digit (or sometimes as the 

last two digits). 

Address Guidelines for Austria 


additional information on Austrian addresses, see the Austria Post website: www.post.at. 

VIC 

QLD 

SA 

WA 

TAS 


• State abbreviations—State abbreviations are supported. The following table lists the Austrian states 

and their abbreviations. 

Burgenland 

Kärnten 

Niederösterreich 

Oberösterreich 

Salzburg 

Steiermark 

Tirol 

Vorarlberg 

Wien 

NT 

Bgl 

Ktn 

NÖ 

OÖ 

Sbg 

Stm 

Tirol 

Vbg 

Wien 


• Thoroughfare types—Austrian thoroughfare types and their common abbreviations are recognized 

and fully supported on input and output. 


Ordinals are also recognized in input addresses. 

• Common words and abbreviations—Common words, directionals, house number indicators, and 

abbreviations used in addresses are recognized. 

Address Guidelines for Belgium 

The Belgium geocoder supports locations in Belgium and Luxembourg. Follow these guidelines to provide 

input that Geocode Address Global can successfully geocode. For additional information on Belgium 

and Luxembourg addresses, see the Belgium Post website: www.bpost.be. 


• Supported languages—Dutch, French, and German language aliases and address formats are 

supported. 

• Thoroughfare types—Belgian thoroughfare types and their common abbreviations are recognized 

and fully supported on input and output. Dutch, French, and German thoroughfare types are also 

supported. 




abbreviations used in addresses are supported. 

Address Guidelines for Brazil 


• Thoroughfare types—Thoroughfare types (pre and post thoroughfare types) and their common abbreviations 

are recognized and fully supported on input and output. Following is a partial list of recognized 

thoroughfare types. 

ALAMEDA=AL,ALAMEDA,ALUA LALA 

ACESSO=AC,ACESSO 

ARCO=ARCO 

AUTO-ESTRADA=AUTO-EST,AUTO-ESTRADA 

AVENIDA=AV,AVDA,AVE,AVENIDA 

AZINHAGA=AZINHAGA 

BAIRRO=BAI,BAIRRO 

BALUARTE=BALUARTE 

BECO=BECO 

Many others are also recognized. 


Ordinals are also recognized in input addresses. For example, the following are all recognized 

in an input address: 

User's Guide 

um, first, one, 1st, primera, primeiras, primeiro 

dois, second, two, 2nd, segunda, segundos 

Many other numeric designations are also recognized. 


313


314 

• Directionals in addresses—The following directionals are recognized in input addresses: norte, do 

norte, setentrional, sul, do sul, meridional, leste, este, do leste, do este, oriental, oeste, do oeste, 

ocidental 


abbreviations used in addresses are supported. This is a partial list of common words and abbreviations 

that are recognized. Many other common words are also handled. 

Articles of speech 

Common words 

Common abbreviations 

Address Guidelines for Canada 

dos, das, do, da, de, d, dom, uma, e, o, n, sn, sa, ie a, os, as, ao, em, 

no, na, nos, nas, ao, andar, andares, ander, apart, apartment, flat, 

apartmento, apto, apt, ap, ato, casa, cs, cob, unit (and many other 

common articles of speech) 

os, nova, novas, na, no, nas, nos, um 

aeroporto=aerop 

internacio=intern,int 

internacional=int 

international=int 

conselheiro=cnso 

desembargador=des 

regente=reg 

limitado=ltda,ltdo,ltd 

(and many other abbreviations) 


geocoding. 

• Post Office Box numbers—P.O. Boxes and Rural Route addresses are not geocodable. Geocode 

Address CAN will honor this user input and attempt to output Boxes and Rural Route information, but 

it will not be used for geocoding purposes. 

• Highway addresses—Highway addresses (such as Hwy 401) are geocoded. 

• House numbers and apartment letters—Remove spaces between house number and apartment 

letter. 123 A Main Street does not geocode correctly because the geocoder assumes that the name 

of the street is A. Two workaround options are available: 






• 99-123 Main St, where 99 is the unit number. In this format, do not specify the unit type. The number 

99 could be a suite, apartment, unit, floor or any valid unit type. 

• 123 Main St. Apt 99, where Apt is the unit type and 99 is the unit number. In this format, you must 

specify a valid unit type (such as Apt or Suite), otherwise the address will not be geocoded correctly. 



cities, such as Calgary, which consist mainly of numbered streets. These streets can only be distinguished 

by their directional suffixes and street types. They also distinguish addresses on streets that 

change direction. For example: 123 Main St W and 123 Main St E have very different coordinates. 



data. For a list of valid street types see www.canadapost.com. 

• City name—Do not abbreviate city names. If the city is unknown, you may leave it blank, although 

this may affect the accuracy of the geocode. 

• Province name—You may use the full province name (for example, Ontario), but using the twocharacter 

abbreviation (ON) is recommended to reduce the likelihood of input errors. 

Address Guidelines for Denmark 


additional information about the Denmark postal system, see the Post Danmark website: 

www.postdanmark.dk. 


• Supported languages—Danish and English language aliases are supported for major town/municipality 

names. For example, Copenhagen (English) is equivalent to København (Danish). 


supported on input and output. Following is a list of recognized thoroughfare types. This is not a 

complete list. Additional thoroughfare types may also be recognized. 

User's Guide 

ALLÉ=alle 

ANLAEG=anlaeg 

ANLEAG=anleag 

BAKKEN=bakken 

BANEN=banen 

BASTION=bastion 

BOUL=boulevard 

BOULEVARD=bulevardi 

BRO=bro 

BROEN=bro 

BUEN=buen 

BULEVARDI=bulevardi 

DAMMEN=dammen 

DOSSERING=dossering 

GAARD=garrd 

GADE=gade 

GANGEN=gangen 

GARD=gard 

GÂRD=gard 

GET=get 

HAVE=have 

HAVN=havn 

HOEJEN=hojen 


315


316 

HOJEN=højen 

HøJEN=højen 

HOLMEN=holmen 

HUSET=huset 

KAER=kaer 

KEAR=kear 

KRAENTEN=kraeten 

KREANTEN=kreanten 

LAENGEN=laengen 

LEANGEN=leangen 

MARKEN=marken 

PARK=parken 

PARKEN=parken 

PASSAGEN=passagen 

PLADS=plads 

SIDEN=siden 

STIEN=stien 

STRAEDE=straede 

STREADE=streade 

SVINGET=svinget 

TOFTEN=toften 

TORV=torv 

VAENGE=vaenge 

VANGEN=vangen 

VARDEN=varden 

VEANGE=veange 

VEJ=vej 





Address Guidelines for Finland 


additional information about the Finland postal system, see the Posti kuluttajille website: www.posti.fi. 

Finnish postal codes are managed by Itella Corporation. For information, see the Itella postal codes 

page. 


• Thoroughfare types—Finnish thoroughfare types and their common abbreviations are recognized 

and fully supported on input and output. Swedish thoroughfare types are also supported. 






Address Guidelines for France 


additional information about the French postal system, see the La Poste website: www.laposte.com. 


• Virtual town names—Some areas are generally recognized as cities even though they are not truly 

administrative cities. These areas represent Artificial City Areas, or Virtual Towns. Since these virtual 

town names are commonly used by the public, they are supported and treated as aliases for any of 

the encompassed towns. Returned candidates have the correct real town in place of the input virtual 

town. 

Table 42: Virtual Towns in France 

Virtual Town Alias 

Défense (La) 

Sophia Antipolis 

Cergy-Pontoise 

Marne-la-Vallée 

Saint-Quentin-en-Yvelines 

Sénart 

Evry 

User's Guide 

Etang de Berre 


Encompassed Real Towns 

Part of: Nanterre, Puteaux, Courbevoie 

Part of: Valbonne, Mougins, Vallauris, Antibes, 

Biot 

Menucourt, Courdimanche, Puiseux-Pontoise, 

Osny, Pontoise, Cergy, Vauréal, Neuville-sur-Oise, 

Saint-Ouenl'Aumône, Jouy-le-Moutier, Eragny 

Bry-sur-Marne, Villiers-sur-Marne, Noisy-le-Grand, 

Champs-sur-Marne, Emerainville, Noisiel, Lognes, 

Croissy-Beaubourg, Torcy, Collégien, Ferrières, 

Bussy- Saint-Georges, Bussy-Saint-Martin, Saint- 

Thibault-des-Vignes, Gouvernes, Conches, 

Guermantes, Jossigny, Lagny-sur-Marne, 

Montévrain, Chanteloup-en-Brie, Serris, Chessy, 

Coupvray, Magny-le-Hongre, Bailly- Romainvilliers 

Elancourt, Verrière (La), Trappes, Montigny-le- 

Bretonneux, Guyancourt, Voisins-le-Bretonneux, 

Magnyle- Hameau 

Tigery, Combs-la-Ville, Lieusaint, Moissy- 

Cramayel, Saint-Pierre-du-Perray, Savigny-le- 

Temple, Réau, Nandy, Cesson, Vert-Saint-Denis 

Evry, Bondoufle, Courcouronnes, Lisses 

Fos-sur-Mer, Miramas, Vitrolles, Istres 

317


318 


Isle-d'Abeau 


Four, Isle d’Abeau (L’), Saint-Quentin-Fallavier, 

Vaulx-le- Milieu, Villefontaine 

• Common words and abbreviations—The geocoder handles common abbreviations that are used 

in French addresses. It supports all the official French street type abbreviations plus a number of unofficial 

street types to help improve geocoding efficiency. A partial list is: 

Table 43: Common French Address Abbreviations 

Street Type or Name 

Hauts 

appartement 

Saint 

Sainte 

rue 

Charles de Gaulle 

Regiment D’Infanterie de Marine 

Division Blindée 

Abbreviation 

No abbreviation. 

APP, APT, APPART 

ST 

STE 

r 

CDG 

RIMA 

• Directionals in addresses—Abbreviated street directionals are also handled on input and the returned 

candidate displays the complete directional. 

Table 44: Street Directionals 

N 

S 

E 

O 

N. 

S. 

E. 

O. 

DB 

Nord 

Sud 

Est 

Ouest 


NE 

SE 

NO 

SO 

N.E. 

S.E. 

N.O. 

S.O. 

Nord-Est 

Sud-Est 

Nord-Ouest 

Sud-Ouest 

• Ordinals and numbered street names—Input addresses can include ordinals such as 1er, 2e, 2nd, 

2nde, 3e. All subsequent ordinal street names are designated with "e" or "ème". You can also specify 

numbers in street names or express the numbers as words. For example, the following street names 

are equivalent and can both be geocoded as part of an input address: 

Rue du 4 septembre 

Rue du quatre septembre 

• House numbers with letters—House numbers can include letters, such as 85B Ave des 

provinces. 

• Postal box (BP) addresses—The geocoder can handle Postal Box (Boite Postale) addresses. For 

the following input address, a close match candidate is returned with a result code of S5HPNTSC-A. 

AddressLine1: BP 112 2 Avenue CDG 

PostalCode: 78150 

City: Le Chesnay 

Note that in this example, the street name CDG is returned as Charles de Gaulle and the postcode 

is corrected. The BP itself is not returned. 

• CEDEX addresses—The geocoder does not use CEDEX for geocoding but CEDEX will not interfere 

with geocoding. CEDEX can be entered in AddressLine1, City, or PostalCode fields. The CEDEX itself 

is not returned but the complete postcode is returned. For the following input address, a close match 

candidate is returned with a result code of S5HPNTS--A. 

AddressLine1: 17 Rue Louise Michel 

PostalCode: 92301 CEDEX 

City: Levallois-Perret 

The postcode is returned but not a postal centroid (there is no Z in the ninth position of the return 

code). The CEDEX itself is not returned. 

• Paris address formats and arrondissements—Paris addresses typically have a different input 

format. The house number appears after the street name rather than before the street name. The 

geocoder handles this input format and geocodes correctly. Arrondissements (the last two digits of 

the postcode) can be entered and the complete locality and postcode information is returned. For the 

following input address, a close match candidate is returned with a result code of S5HPNTSCZA. 

User's Guide 

AddressLine1: 7 Rue Beranger 


City: Paris 


319


320 

The returned Locality field includes the arrondissement (district) information. The Paris region includes 

20 arrondissements, which are represented by the last two digit of the postcode (the first three digits 

are 750). A Paris address may be written with the last two digits only. For the following input address, 

a close match candidate is returned with a result code of S5HPNTSC-A 

AddressLine1: 51 Rue Lafitte 


City: Paris 

The complete postcode (75009) is returned even though 09 (representing the ninth arrondissement) 

was entered. 

• Military addresses—Military addresses (including typical military address abbreviations) are handled. 

The first two digits usually represent the department. The digits 00 represent military addresses. 

• Monaco addresses—The geocoder handles Monaco addresses. Specify Monaco in the StateProvince 

input field. All Monaco postcodes begin with the number 98. Monaco is returned in the address even 

if it was not specified on input. 

Address Guidelines for Germany 


additional information about the Hungarian postal system, see the Deutsche Post website: 

www.deutschepost.de. 

Addresses must contain either a city or a postal code. 

German addresses may contain some or all of the following address elements. 

Table 45: German Address Elements 

Address Element 

Street address 

Ort 

Kreis 

Bundesland 

Postcode 

Address Guidelines for Italy 

Field 

AddressLine1 

City 

County 

StateProvince 

PostalCode 

Example 

Muldenweg 2 

Vaihingen an der Enz 

Ludwigsburg 

Baden-Württemberg 

71665 


additional information about the Italy postal system, see the Posteitaliane website: www.poste.it. 



• German language addresses—German address formats (common in the South Tyrol area of Italy) 

are handled and geocoded correctly. Typical German thoroughfare types and abbreviations are supported. 

For example, the street name Marienstraße could be abbreviated as Marienstr, and the same 

candidate is returned. Note that regardless of whether strasse or straße is entered as input, strasse 

is returned in the output candidate. 

• Aliases for regions, localities, and provinces—Aliases can be used on input. For example, Tuscany 

is an alias for the region of Toscana. When you geocode, the returned candidate matches the user 

input. That is, if aliases were used then aliases are returned. 

• Regions and provinces—For street geocoding, region names (which are entered in the StateProvince 

field) are not used for geocoding purposes, but are returned. Province abbreviations consisting of two 

letters are returned in the County field. Italy has 20 regions and 110 provinces. 

• PO boxes—Post Office Box numbers are not used for address matching or geocoding purposes, but 

this does not interfere with matching or geocoding. The PO Box information is not returned. The following 

formats are recognized: 

Casella Postale 

CP 


are recognized and fully supported on input and output. Both Italian and German thoroughfare 

formats are supported. 

• Common words, abbreviations, and directionals—The geocoder recognizes common words, directionals, 

house number indicators, and abbreviations used in addresses and can geocode these 

addresses successfully. 


For example, if you enter the street name Via 42 Martiri, the street name QUARANTADUE 

MARTIRI is returned. Ordinals are also recognized in input addresses. 

Address Guidelines for Luxembourg 






supported. 



supported. 





User's Guide 


321


322 

Address Guidelines for New Zealand 


additional information on New Zealand addresses, see the New Zealand Post website: www.nzpost.co.nz. 


• Aliases for suburbs—The geocoder supports locally used suburb names in addition to the officially 

recognized suburb names. For example, Rosedale is an alias of the official suburb name of Hargest. 


supported on input and output. 

• Common words and abbreviations—The geocoder recognizes common words, directionals, house 

number indicators, and abbreviations used in addresses and can geocode these addresses successfully. 



Address Guidelines for Singapore 


additional information on Singapore addresses, see the Singapore Post website: www.singpost.com. 


• PO box addresses—Post Office Box numbers are not used for address matching or geocoding purposes, 

but this does not interfere with matching or geocoding. The PO Box information is not returned. 

The following formats are recognized: P O Box, Locked Bag Service. 


supported on input and output. The following table shows is a partial list of recognized thoroughfare 

types. Others may also be recognized. 

Table 46: Thoroughfare Types 

Pre-thoroughfare types 

Post-thoroughare types 

lorong=lorong, lrg, lor, lorang 

jalan=jalan, jln, jl 

lengkong=lengkong, lkg 

kallang=kallang 

mount=mount, mt 

upper=upper, upp 

track=trk,tck 

street=st 

road=rd 

drive=dr 

crescent=cr,cres,crescent,cresent 

boulevard=bvd,blvd,bouleyard,boulvard 


hill=hill 

gate=gate 

mall=mall 

avenue=ave,av,avnue 

link=lk 

lane=l 

walk=wk 

green=grn 

highway=hwy 

quay=quay, qy 

parkway=pwy 



This is a partial list of common words, abbreviations, and directionals that are recognized. Other 

common words may also be recognized. 

User's Guide 

Table 47: Common Words 

Category 

Common words 


Building identifiers 

Words 


and, ltd, international, industrial, plc, group, co, 

front, by, bay 

the, at, a, an, blk 

center, centre, building, house, place, court, galleria, 

hotel, park, complex, mart, temple, bank, 

exchange, station, community, area, mosque, 

depertment, department, post office, shrine, 

chambers, masjid, apartments, complex, bureau, 

resort, lodge, harbour 

monastery, convent, restaurant, golf course, estate, 

campus, institute, university, facility, tunnel, 

libraray, society, mansion, hub, beach, church, 

park, kiosk, mission, condominium, warehouse, 

hall, laboratories, hospital, corporation, fire post, 

terminal, workshop, headquarters, cemetery 

plaza, villa, garden, gardens, tower, station, hall, 

lodge, cottages, cottage, village, gurdwara, place 

323


324 

Category 


Directionals in addresses 

Single Line Input 

Words 

AYE=Ayer Rajah Expressway 

BKE=Bukit Timah Expressway 

CTE=Central Expressway 

ECP=East Coast Parkway 

KJE=Kranji Expressway 

KPE=Kallang-Paya Lebar Expressway 

PIE=Pan Island Expressway 

SLE=Seletar Expressway 

TPE=Tampines Expressway 

Ctrl=Central 

E=East 

S=South 

W=West 

N=North 

JLN=Jalan 

CR=Crescent 

GR=Grove 

L=Lane 

WK=Walk 

LRG=Lorong 

TG.=TANJONG 

North, N, Nth, South, S, Sth, East, E, Est, West, 

W, Wst, NE, NW, SE, SW, T1, T2 

Instead of entering each address element in separate fields, you may enter the entire address in the 

AddressLine1 input field. 

For all countries except Japan, you can enter addresses in one or more of these single-line formats. 

Note: 

Not all formats work for all countries. 

StreetAddress;PostalCode;City 


StreetAddress;City;PostalCode 

StreetAddress;PostalCode 

StreetAddress;City 

StreetAddress,PostalCode,City,StateProvince 

StreetAddress,PostalCode,City,County,StateProvince 

StreetAddress;City;StateProvince;PostalCode 

Note: 

Australia addresses must be in this format. You must include either a city plus state/province or 

a postal code as the last address element. 

StreetAddress;City;StateProvince 

StreetAddress;City;County;PostalCode 

StreetAddress;County;City 

StreetAddress;County 

StreetAddress,City,PostalCode,StateProvince 

PostalCode,City,StateProvince,StreetAddress 

PostalCode;City;StreetAddress 

PostalCode;StreetAddress 

PostalCode;StreetAddress;City 

PostalCode;City 

City;StreetAddress 

City;PostalCode;StreetAddress 

City,StateProvince,StreetAddress 

City,PostalCode,StateProvince,StreetAddress 

City;StreetAddress;Locality 

StreetAddress;Locality 

StreetAddress;Locality;City 

StreetAddress;Locality;City;PostalCode 

Note: 

U.K. addresses must be in this format. You must include either a city plus state/province or a 

postal code as the last address element. 

StreetAddress;City;Locality 

Where: 

• StreetAddress can be house number and street name in either order (with street type immediately 

before or after the street name). 

• City is the town. For Thailand, this is the subdistrict. 

User's Guide 


325


326 

• Locality is the locality name. 

• County is the county name. For Thailand, this is the district. 

• StateProvince is the postal abbreviation for the state or province. 

• PostalCode is the complete postcode. For Brazil, PostalCode should be the complete eight-digit 

postcode for the most accurate results. However, you can use a five-digit postcode. 

The matching accuracy for single line input is comparable to that of structured address input. The performance 

of single line input addresses may be slightly slower than that of structured address input. 

For best results, use delimiters (comma, semicolon, or colon) between each component of the address. 

For example, 

26 Wellington Street East;Toronto;ON;M5E 1S2 

schulstrasse 22,Dresden,01328 

Urión 30,Col. Tlatilco,02860,Mexico,D.F. 

If the input address is missing delimiters, spaces are recognized as separators and internal parsing rules 

identify address components. In the example above, the address would still successfully geocode even 

if some or all of the delimiters were missing in the input. 

Note: Non-delimited or partially-delimited single line addresses may take longer to geocode and may 

not produce the same results as delimited single line input. This is especially true for addresses 

with multi-word street names or cities. To optimize single line geocoding, use delimiters between 

address components (particularly between street name and city). 

Punctuation is ignored for geocoding purposes. 

Format for Japan 

Japanese addresses are typically written in single line format, without any delimiters to separate address 

fields. The typical format is: 

 

where: 

• prefecture = ken 

• city = shi 

• municipality subdivision = oaza 

• city district = chome 

• block = numbered city block (ban) 

• lot = sub blocks or building number (go) 

• other = building names, flat numbers, or other identifiers. This information is ignored by the Japan 

geocoder. 

Note: 

Block and lot numbers are the most specific address elements in Japan. Japanese addresses 

typically do not have street names. 


Table 48: Example Japanese Addresses 

Address 

Guidelines for Single Line Input 

Description 

Chome, block, and lot separated by a hyphens. 

Block and lot separated by hyphen, chome indicated 

by chome identifier. 

Chome, block, and lot separated by their identifiers. 

• For Germany, France, and New Zealand, you must specify a value in either the PostalCode field or 

the City field in order for single line input to successfully geocode. 

• For Canada, if you omit the postal code and country, the geocoder still geocodes the address based 

on street address, city, and province. 

• The country is not required. Each country geocoder assumes that the address is in its country. 

• Firm information (placename, building name, or government building) is returned if available. 

Street Intersection Input 

If you enter a street intersection as input, the geocoder will provide the coordinates of the intersection. 

Note: 

Intersection geocoding is not available for the United Kingdom (GBR). 

To enter an intersection, specify the two street names separated by a double ampersand (&&) in Address- 

Line1. For example: 

AddressLine1: Ocean Ave && New South Head Rd 

City: Woollahra 

AddressLine1: AVENIDA VINTE E OITO DE MARÇO && AVENIDA JOSÉ ALVES AZEVEDO 


AddressLine1: Chemin du Prieuré && Rue de la Montcient 

City: Seraincourt 

Note: 

Options 

Do not use /, _, -, or any other separator. Intersections must be delimited using a double ampersand 

(&&) as a separator. 

All close match criteria are enforced for intersection geocoding, just as for any street level geocoding. 

Geocode Address [CountryCode] allows you to set default processing options through the Management 

Console. You can override certain settings for individual calls to Geocode Address Global using the API 

or MapInfo Spatial Server client tools, such as Enterprise Designer. 

User's Guide 


327


328 

Geocoding Options 




The following table lists the options that control how a location's coordinates are determined. 

Table 49: Geocoding Options 

Option Name 

Geocode level 

Address point interpolation 


Specifies how precisely you want to geocode addresses. One of the 

following: 


Postal 

centroid 

Geographic 

centroid 

The geocoder attempts to geocode addresses to a street 

address, but some matches may end up at a less precise 

location such as a postal code centroid, intersection, or 

shape path. 

The geocoder attempts to geocode addresses to the 

most precise postal code it finds. The advantage of 

postal code centroid matching is the speed of the operation. 

The disadvantage of postal code matching is that 

the geocoder only examines the PostalCode field. If you 

use street address precision, the geocoder looks at both 

the street name and the PostalCode field and attempts 

to return street-level coordinates and optionally fall back 

to postal code coordinates. Postal centroid geocoding 

is not available for this country. 


geographic centroid of a city or state. This option is not 

available for the United Kingdom (GBR). 

Specifies whether to perform address point interpolation. This option 

only works if you have a point database, such as ParcelPrecision, installed. 

This option is not available for all countries. 

This option is only available for Australia, Canada, Germany, and 

Switzerland (including Liechtenstein). 

Address point interpolation uses point data to refine geocode results. 

By default, the geocoding process estimates the location of an address 

based on the street numbers at either end of street segment. For example, 

if a street segment runs from 100 Main St. to 200 Main St., then 

a request for 150 Main St. will return a location in the middle of the 

segment. With interpolation, the geocoder finds the position of 180 Main 


User's Guide 

Option Name 

Geographic centroid 

Postal centroid 

Offset from street 


St. in the point data, and it is about two-thirds of the way down the street. 

Using this information, the geocoder can estimate the position of 150 

Main St. based on 100 and 180 Main St. In this case, the geocoder estimates 

the location of the address slightly away from the center of the 

segment. 

Specifies whether to attempt to determine a geographic region centroid 

when an address-level geocode cannot be determined. This option is 

not available for the United Kingdom (GBR). 

Specifies whether to attempt to determine a postal code centroid when 

an address-level geocode cannot be determined. This option is not 

available for Argentina and South Africa. 

Indicates the offset distance from the street segments to use in streetlevel 

geocoding. The distance is specified in the units you specify in the 

Units field. 

Note: 

Offset is not supported for the United Kingdom (GBR) or Japan 

(JPN). 

The default value varies by country: 


• 10 meters—Australia (AUS), Austria (AUT), Germany (DEU). 

• 7 meters—Argentina (ARG), Belgium and Luxembourg (BEL), Brazil 

(BRA), Canada (CAN), Switzerland and Liechtenstein (CHE), Czech 

Republic (CZE), China (CHN), Denmark (DNK), Spain (ESP), Estonia 

(EST), Finland (FIN), France (FRA), Hungary (HUN), India (IND), 

Ireland (IRL), Italy (ITA), Latvia (LVA), Lithuania (LTU), Mexico (MEX), 

Malaysia (MYS), The Netherlands (NLD), Norway (NOR), New Zealand 

(NZL), Poland (POL), Portugal (PRT), Singapore (SGP), Slovenia 

(SVN), Sweden (SWE), Thailand (THA), Turkey (TUR), South Africa 

(ZAF). 

The offset distance is used in street-level geocoding to prevent the 

geocode from being in the middle of a street. It compensates for the 

fact that street-level geocoding returns a latitude and longitude point in 

the center of the street where the address is located. Since the building 

represented by an address is not on the street itself, you do not want 

the geocode for an address to be a point on the street. Instead, you 

want the geocode to represent the location of the building which sits 

next to the street. For example, an offset of 50 feet means that the 

geocode will represent a point 50 feet back from the center of the street. 

The distance is calculated perpendicular to the portion of the street 

segment for the address. Offset is also used to prevent addresses across 

329


330 

Option Name 

Offset from corner 


the street from each other from being given the same point. The following 

diagram shows an offset point in relation to the original point. 

Street coordinates are accurate to 1/10,000 of a degree and interpolated 

points are accurate to the millionths of a degree. 

Specifies the distance to offset the street end points in street-level 

matching. The distance is specified in the units you specify in the Units 

field.This value is used to prevent addresses at street corners from being 

given the same geocode as the intersection. 

Note: 


(JPN). 


• 12 meters—Australia (AUS), Austria (AUT), Germany (DEU) 


(BRA), Canada (CAN), Switzerland and Liechtenstein (CHE), China 

(CHN), Czech Republic (CZE), Denmark (DNK), Spain (ESP), Estonia 






(ZAF). 

The following diagram compares the end points of a street to offset end 

points. 


Option Name 

Units 

Point type 

User's Guide 


Specifies the unit of measurement for the street offset and corner offset 

options. One of the following: 

Note: 

• Feet 

• Miles 

• Meters 

• Kilometers 


(JPN). 

The default is Meters. 

This option is available for Australia only. 

For street address matching, specifies whether to return the parcel latitude/longitude 

or the street frontage latitude/longitude. This option is 

available only if you have the G-NAF database installed, and the database 

selected in the Database list on the Data tab includes the G-NAF 

database. This option only affects addresses matched to the G-NAF 

database. 


Parcel 

Street 

frontage 


In a street address match, return the exact location of 

the parcel. This is the standard G-NAF point which is 

the exact authoritative point returned by the G-NAF 

database. Default. 

In a street address match, return the street frontage point 

for the parcel. The street frontage point is 12.5 metres 

from the front boundary of the parcel. Street frontage 

points are more suitable for routing applications. 

331


332 

Option Name 

Return 8 decimal places of 

parcel latitude/longitude 

Coordinate system 

Matching Options 



Specifies whether to return the original latitude and longitude, precise 

up to eight digits after the decimal. This is the latitude/longitude that the 

candidate matched to in the G-NAF database. These are the original 

coordinates directly from the G-NAF data prior to truncation or rounding. 

This option is available only if you have the G-NAF database installed, 

and the database selected in the Database list on the Data tab includes 

the G-NAF database. This option only affects addresses matched to 

the G-NAF database. 

A coordinate system is a reference system for the unique location of a 

point in space. Cartesian (planar) and Geodetic (geographical) coordinates 

are examples of reference systems based on Euclidean geometry. 

MapInfo Spatial Server supports systems recognized by the European 

Petroleum Survey Group (EPSG). 

Each country supports different coordinate systems. Depending on the 

country, you have one or more of the following options: 

EPSG:4230 

EPSG:4283 

EPSG:4301 

EPSG:4326 

EPSG:27200 

EPSG:27700 

Also known as the GDA94 coordinate system. 

Also known as the Tokyo coordinate system. 

Also known as the WGS84 coordinate system. 

Also known as the NZGD49 coordinate system. 

Also known as the British National Grid system. 




Matching options let you set match restrictions, fallback, and multiple match settings so that the matching 

can be as strict or relaxed as you need. The strictest matching conditions require an exact match on 

house number, street name, postal code and no fallback to postal code centroids. The geocoder looks 

for an exact street address match within the postal code in the input address. Relaxing the conditions 

broadens the area in which it searches for a match. For example, by relaxing the postal code, the geocoder 

searches for candidates outside the postal code but within the city of your input address. 


For guidelines on how to balance match rate and precision, see Balancing Match Rate and Precision 

on page 298. 

Table 50: Matching Options 

Option Name 

Keep multiple matches 

Expand candidates 

Close matches only 

Match mode 

All input 

User's Guide 


Specifies whether to return results when the address matches to multiple 

candidates in the database. If this option is not selected, an address 

that results in multiple candidates will fail to geocode. 

If you select this option, specify the maximum number of candidates to 

return next to the check box. 

This option applies to U.K. addresses only. 

Specifies whether to return multiple close matches (one for each delivery 

point on the street). By default, if a street has multiple addresses/delivery 

points, Geocode Address GBR returns a single close match, with each 

individual delivery point available as a range. 

Specifies whether to return only those geocoded results that are close 

match candidates. For example, if there are 10 candidates and two of 

them are close candidates, and you enable this option, only the two 

close matching candidates would be returned instead of all 10. To specify 

what is considered a close match, use the Close match criteria options. 

Address candidates are ranked according to how closely the input address 

matches these preferences. 

Specifies how to determine whether a candidate is a close match. One 

of the following: 

Custom 

Exact 

Close 

Relaxed 


This option allows you to specify which parts of a candidate 

address must match the input address to be considered 

a close match. Use the Close match criteria 

check boxes to specify the address elements you want. 

This is the default value for most countries. 

All address elements must match. 

Only the house number must match. For China, Estonia, 

India, Latvia, Lithuania, Slovenia, and South Africa, only 

the street name and town must match. 

All candidates are considered close. This is the default 

value for Japan. 

Specifies whether candidates must match all non-blank input fields to 

be considered a close match. For example, if an input address contains 

333


334 

Option Name 

House number 

Street 

Locality 


a city and postal code, then candidates for this address must match the 

city and postal code to be considered a close match. 

Specifies whether candidates must match the house number to be 

considered a close match. 

This option is not used for China, India, and Japan. 

If you select this option you should also require an exact match on street 

name. This option does not significantly affect performance. It does, 

however, affect the type of match if the candidate address corresponds 

to a segment that does not contain any ranges. The type of match can 

also be affected when the house number range for a candidate does 

not contain the input house number. 

Specifies whether candidates must match the street name to be considered 

a close match. 

This option is not used for Japan. 

If a close match is found, the geocoder attempts expanded street name 

manipulation, which looks for candidates with names that sound like the 

input address or that are spelled improperly. For example, "Muller 

Strasse" for "Mueller Strasse". This slows down performance but increases 

the match rate . If the geocoding database is indexed, the performance 

impact is reduced. 

Specifies whether candidates must match the locality to be considered 


If you do not require exact matches on locality, the geocoder searches 

on the street address matched to the particular postal code, and considers 

other localities that do not match the name, but do match the 

postal code. 


• Not used—Australia (AUS), Austria (AUT), Belgium and Luxembourg 

(BEL), Germany (DEU), Denmark (DNK), Spain (ESP), Estonia (EST), 

Finland (FIN), France (FRA), Italy (ITA), Lithuania (LTU), Malaysia 

(MYS), The Netherlands (NLD), Norway (NOR), Portugal (PRT), 

Slovenia (SVN), Sweden (SWE), Thailand (THA) 

• Locality—Brazil (BRA), Switzerland (CHE), China (CHN), Czech 

Republic (CZE), The United Kingdom (GBR), Hungary (HUN), India 

(IND), Ireland (IRL), Latvia (LVA), Mexico (MEX), Singapore (SGP), 

Turkey (TUR), South Africa (ZAF) 

• Dissemination Area and Enumeration Area (DA and EA)—Canada 

(CAN) 


Option Name 

City 

County 

User's Guide 


• Suburb—New Zealand (NZL) 

• Minor town, village, or locality—Poland (POL) 

• Neighborhood or barrio—Argentina (ARG) 

• City district (chome)—Japan (JPN) 

This option is not available if you select Geographic cenroid on the 

Geocoding tab. 

Specifies whether candidates must match the city to be considered a 

close match. For Japan, this field specifies whether the candidate must 

match the municipality subdivision (oaza). If you do not require exact 

matches on city, the geocoder searches on the street address matched 

to the particular postal code, and considers other cities that do not match 

the name, but do match the postal code. 

For Argentina, the city name is not always available in the source data. 

In those cases, the department (County field) is used for matching purposes 

and the department is returned in the City output field. Candidates 

matched in this manner are considered close matches. 

Specifies whether candidates must match the county to be considered 

a close match. The meaning of county varies by country: 


• AUS (Australia)—Local Government Authority (LGA) 







• CZE (Czech Republic)—District 







• GBR (Great Britain)—County 

• HUN (Hungary)—Not used 

• IND (India)—Not used 




335


336 

Option Name 

State/Province 




• LVA (Latvia)—County 

• MEX (Mexico)—Not used 


• NZL (New Zealand)—Not used 

• NLD (The Netherland)—Province 

• NOR (Norway)—Fylke 








• ZAF (South Africa—District 

Specifies whether candidates must match the state or province to be 


The meaning of state/province varies by country: 

• ARG (Argentina)—Province or region 








• CZE (Czech Republic)—Region 



• ESP (Spain)—Not used 









Option Name 

Postal code 

Candidate must have LDU 

Postal district 

User's Guide 



• JPN (Japan)—Not used 

• LTU(Lithuania)—Not used 

• LVA (Latvia)—Not used 








• SGP (Singapore)—Region 


• SWE (Sweden)—Lan 



• ZAF (South Africa)—Not used 

Specifies whether candidates must match the postal code to be considered 

a close match. If you do not require exact match on postal codes, 

the geocoder searches a wider area for a match. While this results in 

slower performance, the match rate is higher because the request does 

not need to match exactly when it compares match candidates. 

This option is not available for Argentina, Japan, and South Africa. 

This option applies only to Canadian addresses. 

Specifies whether a candidate address must have a full postal code 

(FSA and LDU) to be considered a close match. 

Canadian postal codes are divided into two sections: the Forward 

Sortation Area (FSA) and the Local Delivery Unit (LDU). For example, 

the postal code M6H 2P8 has an FSA of M6H and an LDU of 2P8. Some 

candidate addresses may contain only the FSA. This option allows you 

to prevent such addresses from being classified a close match. 

This option applies only to U.K. addresses. 


Specifies whether the postal district portion of the postcode must match 

in order for the match to be considered a close match. 

UK postcodes are divided into two sections: the outward code, which 

is to the left of the space, and the inward code, which is to the right. The 

337


338 

Option Name 

First two postal code digits 


outward code represents the postal district. For example, in the postcode 

CB3 OHH, the postal district is CB3, which is Cambridge. 

This option applies only to Spanish addresses. 

Specifies whether the first two digits of the postcode must match in order 

for the match to be considered a close match. 

Return point of interest This option applies only to Indian addresses. 

matches with street matches 

Specifies whether to return both point of interest (POI) matches and 

street matches when both street and POI information are provided in 

the input. If you select this option, POI information is returned with candidates 

that matched on street name. If you do not select this option, 

only street information is returned. 

Prefer point of interest 

matches 

This option applies only to Indian addresses. 

If you enable the Return point of interest matches with street 

matches option, the default behavior is to list the street name matches 

first in the list of candidates (in other words, preferring the street 

matches). However you can choose to return POI candidates first using 

this option. Consider the following example: 

FirmName: India Gate 

AddressLine1: Lodi Road 

City: Delhi 

If POIs are returned and street names preferred (the default settings), 

the following candidates are returned in the order listed. Note that the 

street name candidates are at the top with the India Gate POI candidate 

(S8 result code) listed last. If POIs were preferred over street candidates, 

the India Gate candidate would be listed first. 

Street- 

Name 

Lodi Road 

Lodi Road 

Lodi road 

Firm- 

Name 

India Gate 

PostalCode 

100003 

100013 

100013 

Locality 

Lodi 

Colony 

Nizamuddin 

West 

India Gate 

City 

Delhi 

Delhi 

Delhi 

Result- 

Code 

S4- 

PNTSC-A 

S4- 

PNTSC-A 

S8H----C- 

A 


Data Options 




The Data tab allows you to specify which databases to use in geocoding. Databases contain the address 

and geocode data necessary to determine the geocode for a given address. There are two kinds of 

databases: standard databases and custom databases. Standard databases are those supplied by Pitney 

Bowes Business Insight and based on address and geocoding data from postal authorities and suppliers 

of geographical data. Custom databases are databases you create to enhance or augment standard 

databases for your particular needs. For more information on custom databases, see What Is a Custom 

Database? on page 582. 

For Australian geocoding, to achieve the best geocoding spatial precision use the G-NAF database. This 

provides point-level geocoding that places points within the land parcel boundary for a given address. 

The G-NAF database requires an additional license. Contact your sales representative for more information. 

The following table lists the options available for specifying which databases to use and the search order 

of databases. 

Table 51: Data Options 

Option Name 

Database 

User's Guide 

Database preference 


Specifies the database to be used for geocoding. Only databases that 

have been defined in the Databases Resources panel in the Management 

Console are available. 

Specifies which geocoding databases to use. One of the following: 

Prefer custom database 

Prefer standard database 

Use custom databases 

only 

Use standard databases 

only 

Use both custom and 

standard databases 


Use both standard databases and custom 

databases, but give preference to candidates 

from custom databases. Use this option if you 

feel your custom database is superior to the 

standard database. 



from standard databases. 

Use only custom databases. Ignore standard 

databases. 

Use only standard databases. Ignore custom 

databases. 


databases. In cases where candidates are 

339


340 

Option Name 

Override the default database 

search list 

Database search list 


Note: 

returned from both, the standard database is 

preferred. Default. 

This option is not available for Great Britain (GBR) because the 

GBR geocoder does not support custom databases. 

The results from a custom database have a "U" at the end of the result 

code. Results from an address database have an "A" at the end of the 

match score. For example: S5HPNTSCZA is a match score that comes 

from an address database, while S5HPNTSCZU comes from a custom 

database. For more information, see Introduction on page 577. 

Specifies whether to use the database search list specified in the Management 

Console under the database resources tools ( Modules > 

Enterprise Geocoding > Tools ). If you choose to override the default 

database search list you may change the search order of the databases 

in the Database search list field. You may also remove databases from 

the search list. 

If you override the default database search list, changes to the database 

resources will not be reflected in the database search list, which may 

cause geocoding to fail. However, if you do not override the default 

database search order, any changes to the database resources will be 

automatically reflected by the geocoder. For example, if a database resource 

is moved from one directory to another and you update the 

database resources accordingly ( Modules > Enterprise Geocoding 

> Tools ) the database location will be automatically updated in the 

geocoder. 

The name of one or more database resources to use in the search 

process. Use the database name specified in the Management Console's 

Database Resources tool. For more information, see Adding an Enterprise 

Geocoding Module International Database Resource on page 

248. 

You can specify multiple database resources. If you specify more than 

one database, list them in order of preference. 

The order of the databases has an effect when there are close match 

candidates from different databases. The close matches that are returned 

come from the database that is first in the search list. Close matches 

from lower ranked databases are demoted to non-close matches. 

You can also use the order of the databases to perform fallback processing 

if you have an both an address point database and a streetlevel 

database installed for the country. List the address point database 

first and the street database second. If the address cannot be geocoded 


Output 

Option Name 

Output Data Options 


to the address point level, the geocoder will attempt to geocode it to the 

street level. 




The following table lists the options that control which data is returned in the output. 

Table 52: Output Data Options 

Option Name 

Return only similar firm names 


This option applies to the U.K. only. 

Specifies whether to return firm names only when the input firm name 

is similar to the firm name in the geocoding database. For example, if 

the input firm name is "Group 1 Software" but the geocoding database 

returns "Pitney Bowes Software, Inc.", these two firm names are not 

similar. In most cases the input firm name must match the firm name in 

the database exactly. Some differences in abbreviations are considered 

similar enough to result in the firm name being returned. 

Y 

N 

Yes, return only firm names that are similar to the input firm 

name. 

No, return firm names regardless of whether they are close 

to the input firm name. Default. 

The geocoder returns the latitude/longitude, standardized address, and result indicators. Result indicators 

describe how well the geocoder matched the input address to a known address and assigned a location; 

they also describe the overall status of a match attempt. If you are using the API, t T he output returned 

is in the DataTable class. For information on the DataTable class, see the "API Fundamentals" section 

of the MapInfo Spatial Server API Guide . 

Address Output 



User's Guide 



341


342 

The address may be identical to the input address if the input address was accurate, or it may be a 

standardized version of the input address, or it may be a candidate address when multiple matches are 

found. 

Table 53: Address Output 

Field Name 

AddressLine1 

AddressLine2 

ApartmentLabel 

ApartmentNumber 

City 

Country 

County 

Description 

First line of the address. 

Second line of the address. 

The type of unit, such as apartment, suite, or lot. 

Unit number. 

The municipality name. 

For Japan, the municipality subdivision (oaza). 

The three-letter ISO 3166-1 Alpha 3 country code. 

Addresses from countries that do not have a dedicated geocoding stage 

contain the country code for the country of the geocoder. For example, 

Vatican City addresses have ITA in the Country field instead of VAT 

because Vatican City addresses are geocoded by Geocode Address 

ITA. 

AND (Andorra)—Addresses from Andorra contain ESP (Spain) in the 

Country field. 

GIB (Gibraltar)—Addresses from Gibraltar contain ESP (Spain) in the 


MCO (Monaco)—Addresses from Monaco contain FRA (France) in the 


SMR (San Marino)—Addresses from San Marino contain ITA (Italy) in 

the Country field. 

VAT (Vatican City)—Addresses from Vatican City contain ITA (Italy) 

in the Country field. 








Field Name 

FirmName 

User's Guide 

Description 






































Name of the company or a place name. 


343


344 

Field Name 

HouseNumber 

HouseNumberHigh 

HouseNumberLow 

HouseNumberParity 

LastLine 

LeadingDirectional 

Locality 

Description 

The building number for the matched location. 

For Japan, this field contains the lot number. 

The highest house number of the range in which the address resides. 

The lowest house number of the range in which the address resides. 

Indicates if the house number range contains even or odd numbers or 

both. 

E 

O 

B 

U 

Even 

Odd 

Both 

Unknown 

Complete last address line (city, state/province, and postal code). 

Street directional that precedes the street name. For example, the N in 

138 N Main Street. 








EA) 













Field Name 

User's Guide 

NumberOfCandidateRanges 

NumberOfRangeUnits 

Description 

























Indicates whether the address has a house number. One of the following: 

0 

1 

The address has no house number. Examples of addresses that 

have no house number are P.O. box addresses and general 

delivery addresses. 

The address has a house number. For information about the 

range in which the house number falls, see the HouseNumber- 

High, HouseNumberLow, and HouseNumberParity fields. 

Indicates whether or not the address has a unit number, such as a suite 

number or apartment number. One of the following: 

0 

The address has no unit number. 


345


346 

Field Name 

PostalCode 

PostalCode.Addon 

PreAddress 

PrivateMailbox 

SegmentCode 

SegmentParity 

StateProvince 

Description 

1 

The address has a unit number. For information about the 

range in which the unit number falls, see the UnitNumberHigh 

and UnitNumberLow. 

The postcode for the address. The format of the postcode varies by 

country. 

The second part of a postcode. For example, for Canadian addresses 

this will be the LDU. This field is not used by most countries. 

Miscellaneous information that appears before the street name. 

This field is not currently used. 

A unique ID that identifies a street segment. In Japan, this is the Jusho 

code. A Jusho Code is a point ID that represents a unique address. 

Indicates which side of the street has odd numbers. 

L 

R 

B 

U 

Left side of the street 

Right side of the street 

Both sides of the street 

Undetermined 

















Field Name 

StreetDataType 

StreetName 

StreetPrefix 

StreetSuffix 

User's Guide 

Description 
























The default search order rank of the database used to geocode the 

address. A value of "1" indicates that the database is first in the default 

search order, "2" indicates that the database is second in the default 

search order, and so on. 

The default database search order is specified in the Management 

Console with the Database Resources tool. 

The street name. 

In Japan, this contains the block. Japanese addresses typically do not 

have street names. 

The type of street when the street type appears before the base street 

name. For example, AVENUE: 

12 AVENUE B KALGOORLIE WA 6430 


The street type of the matched location. For example, AVE for Avenue. 

347


348 

Field Name 

TrailingDirectional 

UnitNumberHigh 

UnitNumberLow 

Geocode Output 

Description 

Street directional that follows the street name. For example, the N in 

456 Washington N. 

The highest unit number of the range in which the unit resides. 

The lowest unit number of the range in which the unit resides. 






Option Name 

Geocode level 



following: 


Postal 

centroid 

Geographic 

centroid 




shape path. 















User's Guide 

Option Name 





















segment. 









Units field. 

Note: 


(JPN). 












(ZAF). 

349


350 

Option Name 






















Note: 


(JPN). 









Option Name 

Units 

Point type 

User's Guide 





(ZAF). 


points. 



Note: 

• Feet 

• Miles 

• Meters 



(JPN). 








database. 


Parcel 






351


352 

Option Name 




Result Codes 


Street 

frontage 





















EPSG:4230 

EPSG:4283 

EPSG:4301 

EPSG:4326 

EPSG:27200 

EPSG:27700 










Result codes contain information about the success or failure of the geocoding attempt, as well as information 

about the accuracy of the geocode. 

Table 55: Result Code Output 

Field Name 

Geocoder.MatchCode 

IsCloseMatch 

MultiMatchCount 

Status 

Status.Code 

User's Guide 

Status.Description 

Description 

Indicates how closely the input address matches the candidate address. 

For more information, see Introduction on page 577. 

Indicates whether or not the address is considered a close match. An 

address is considered close based on the "Close match criteria" options 

on the Matching tab. 

Y 

N 

Yes, the address is a close match. 

No, the address is not a close match. 

For street address geocoding, the number of matching address positions 

found for the specified address. 

For intersection geocoding, the number of matching street intersection 

positions found for the specified addresses. 

Reports the success or failure of the match attempt 

null 

F 

Success 

Failure 

If the geocoder could not process the address, this field will show the 

reason. 

• Internal System Error 

• No Geocode Found 

• Insufficient Input Data 

• Multiple Matches Found 

• Exception occurred 

• Unable to initialize Geocoder 

• No Match Found 

If the geocoder could not process the address, this field will show a description 

of the failure. 

Problem + explanation 


Returned when Status.Code = Internal 

System Error. 

353


354 

Field Name 

LocationPrecision 

Description 

Geocoding Failed 

No location returned 

No Candidates Returned 

Returned when Status.code = No Geocode 

Found. 


Found. 

The geocoder could not identify any candidate 

matches for the address. 

Multiple Candidates Re- The address resulted in multiple candidturned 

and Keep Multiple ates. In order for the candidate address 

Matches not selected to be returned, you must select the Keep 

multiple matches option. 

A code describing the precision of the geocode. One of the following: 

0 

1 

2 

3 

4 

5 

6 

7 

8 

9 

10 

11 

12 

13 

14 

15 

16 

17 

No coordinate information is available for this candidate 

address. 

Interpolated street address. 

Street segment midpoint. 

Postal code 1 centroid. 

Partial postal code 2 centroid. 


Intersection. 

Point of interest. 

State/province centroid. 

County centroid. 

City centroid. 

Locality centroid. 

Additional point precision for unspecified custom item. 




The result is an Address Point. 

The result was generated by using address point data to 

modify the candidates segment data. 


Country-Specific Output 

The following topics describe output that's unique to specific countries. 

• Australia G-NAF Database Output on page 355 

• Canada-Specific Output on page 358 

• New Zealand Output on page 359 

• United Kingdom Output on page 359 

Australia G-NAF Database Output 

The following table lists output fields that are unique to the Australian Geocoded National Address File 

(G-NAF ® ) database. G-NAF is an optional database that is available for all six states and two territories. 

G-NAF is the only authoritative Australian national index of locality, street and number, validated with 

geographic coordinates. 

Table 56: Austraila G-NAF Output 

Field Name 

User's Guide 

AUS.GNAF_Confidence 

AUS.GNAF_Eight_Decimal_Place_Latitude 

Description 

A number indicating how many G-NAF datasets 

the address is found in. A higher confidence level 

means that the same address was found in more 

data contributor sources. One of the following: 

 

-1 


The number of datasets the address was 

found in, minus 1. For example, a value 

of 0 indicates that the address was found 

in one contributor's dataset, a value of 1 

indicates that the address was found in 

two contributors' datasets, a value of 2 


three contributors' datasets, and so forth. 

The address could not be found in any G- 

NAF dataset. 

The parcel latitude, precise to eight digits after the 

decimal. This is the latitude that the candidate 

matched to in the G-NAF database. These are the 

original coordinates directly from the G-NAF data 

prior to truncation or rounding. 

This field is only returned if you check the Return 

eight decimal places for parcel latitude/longitude 

box on the Geocoding tab. 

355


356 

Field Name 

AUS.GNAF_Eight_Decimal_Place_Longitude 

AUS.GNAF_Geocode_Level 

AUS.GNAF_PID 

Description 

The parcel longitude, precise to eight digits after 

the decimal. This is the longitude that the candidate 







A number indicating the level o f geocode for the 

address. Every principal address within the G-NAF 

database has at least a locality level geocode. They 

may also have a street level geocode and a point 

level geocode. 


0 

1 

2 

3 

4 

5 

6 

7 

No geocode. 

Parcel level geocode only (no locality or 

street level geocode). 

Street level geocode only (no locality or 

parcel level geocode). 

Street and parcel level geocodes (no locality 

geocode). 

Locality level geocode only (no street or 


Locality and parcel level geocodes (no 


Locality and street level geocodes (no 

parcel level geocodes). 

Locality, street and parcel level geocodes. 

The G-NAF Persistent Identifier (G-NAF PID) is a 

14-character alphanumeric string that uniquely 

identifies each G-NAF address. The PID is constructed 

from a combination of the major address fields 

of the G-NAF Dictionary. An example of a G-NAF 

PID is: 

GAVIC411711441 


Field Name 

User's Guide 

AUS.GNAF_Reliability 

Description 

A number indicating the geocode precision. Reliability 

is related to the dictionary used to determine 

the geocode. Data with geocoded reliability levels 

1, 2, and 3 is contained in the GNAF123 Dictionary. 

This is point (parcel) level geocoded data. Data 

with geocoded reliability levels 4, 5, and 6 is contained 

in the GNAF456 Dictionary. This contains 

non-parcel centroid geocoded data. 

1 

2 

3 

4 

5 

6 


Geocode accuracy recorded to appropriate 

surveying standard. For example, this could 

apply to an address level geocode that was 

manually geocoded. Geocode resolution is 

sufficient to place the centroid within address 

site boundary with a GPS. 

Geocode accuracy sufficient to place centroid 

within address site boundary. For example, 

this could apply to an address level geocode 

that was automatically calculated as the 

centroid of the corresponding cadastre parcel. 


near (or possibly within) address site boundary. 

For example, this could apply to an address 

level geocode that was automatically 

calculated by calculating where on the road 

the address was likely to appear based upon 

other bounding geocoded addresses. 

Geocode accuracy sufficient to associate address 

site with a unique road feature. For example, 

this could apply to a street level geocode 

that was automatically calculated by using 

the road centerline reference data. 

Geocode resolution sufficient to associate 

address site with a unique locality or neighborhood. 

For example, this could apply to a locality 

level geocode that was automatically calculated 

as the centroid of the locality. 


address site with a unique region. For example, 

this could apply to a locality level geocode 

that was derived from topographic feature. 

357


358 

Field Name 

AUS.Mesh_Block_ID 

Canada-Specific Output 

Description 

The following table lists output fields that are unique to Canada. 

Table 57: Canada-Specific Output 

Field Name 

CAN.Census_CD 

CAN.Census_CMA 

CAN.Census_CSD 

CAN.Census_CT 

CAN.Census_DA 

A Meshblock is the smallest geographic unit for 

which statistical data is collected by the Australian 

Bureau of Statistics (ABS). Meshblocks usually 

contain a minimum of 20 to 50 households. This is 

about one fifth the size of a Collection District (CD). 

You can use the Meshblock ID to do additional attributions 

against your own data. 

Description 

The Census Division (CD) in which the address is 

located. For more information, see the Census 

Division definition available on the Statistics 

Canada website. 

The Census Metropolitan Area (CMA) in which the 

address is located. For more information, see the 

Census Metropolitan Area definition on the 

Statistics Canada website. 

The Census Subdivision (CSD) in which the address 

is located. For more information, see the 

Census Subdivision definition on the Statistics 


The Census Tract (CT) in which the address is 


Tract definition on the Statistics Canada website. 

The Dissemination Area (DA) in which the address 

is located. For more information, see the Dissemination 

Area definition available on the Statistics 



New Zealand Output 

The following table lists output fields that are unique to New Zealand. 

Table 58: New Zealand-Specific Output 

Field Name 

NZL.NZL_MESHBLOCK_ID 

NZL.ALIASED_SUBURB 

United Kingdom Output 

Description 

The following table lists output fields that are unique to the United Kingdom. 

Table 59: United Kingdom Output 

Field Name 

User's Guide 

GBR.AP_STATUS_FLAG 

GBR.DEPENDENT_STREET_NAME 

GBR.DEPENDENT_LOCALITY 

GBR.DOUBLE_DEPENDENT_LOCALITY 



which statistical data is collected by Statistics New 

Zealand. Meshblocks vary in size from part of a 

city block to large areas of rural land. 

An alternative to the officially-recognized suburb 

name. 

Description 

AddressPoint status flag. This field is only returned 

if you are using the Address Point database. This 

status flag defines the quality and accuracy of each 

address in the Address Point database. For example, 

0354. For more information, see the Address 

Point User Guide available at www.ordnancesurvey.co.uk. 

Addresses in the United Kingdom may contain two 

street names: a main street name and dependent 

street name. Some addresses may not contain a 

street name at all. 

Dependent locality name. A dependent locality is 

a large village or district, for example, Wimbledon. 

Double dependent locality name. A double dependnet 

locality is a small village or subdistrict. 

359

Geocode Address Global 

Field Name 

GBR.HISTORIC_POSTCODE 

GBR.ALIASED_LOCALITY 

GBR.OSAPR 


Input 

360 

Description 

If the input address contained an old postal code 

that has been replaced by a new postal code, this 

field contains the old postal code. 

A locality that is not part of the postal address. 

Ordnance Survey AddressPoint Reference (OS- 

APR). Each address from the Address Point database 

has a unique OSAPR. OSAPRs are always 

18 characters long and start with the letters AP. 

For example, APMM918D7LQ65VG005. 

Geocode Address Global provides street-level geocoding for many countries. It can also determine city 

or locality centroids, as well as postal code centroids. Geocode Address Global handles street addresses 

in the native language and format. For example, a typical French formatted address might have a street 

name of Rue des Remparts. A typical German formatted address could have a street name Bahnhofstrasse. 

Note: 

Geocode Address Global does not support U.S. or U.K. addresses. To geocode U.S. addresses, 

use Geocode US Address. To geocode U.K. addresses, use Geocode Address GBR. 

The countries available to you depends on which country databases you have installed. For example, 

if you have databases for Canada, Italy, and Australia installed, Geocode Address Global would be able 

to geocode addresses in these countries in a single stage. Before you can work with Geocode Address 

Global, you must define a global database resource containing a database for one or more countries. 

Once you create the database resource, a Geocode Address Global will become available in the Management 

Console, Enterprise Designer, and Interactive Driver. For information on creating a Geocode 

Address Global database resource, see Adding an Enterprise Geocoding Module Global Database 

Resource on page 246. 

Geocode Address Global is an optional component of the Enterprise Geocoding Module. For more information 

on the Enterprise Geocoding Module, see What is the Enterprise Geocoding Module? on 

page 290. 

Geocode Address Global takes an address or intersection as input. To obtain the best performance and 

the most possible matches, your input address lists should be as complete as possible, free of misspellings 

and incomplete addresses, and as close to postal authority standards as possible. Most postal authorities 

have websites that contain information about address standards for their particular country. 


Input Fields 

The following table lists the input fields used for geocoding. 

Note: 

If you are using the API, specify input using the DataTable class. The fields described below are 

the valid column names in the DataTable class. For information on the DataTable class, see the 

"API Fundamentals" section of the MapInfo Spatial Server API Guide. 

Table 60: Input Fields 

Field Name 

User's Guide 

AddressLine1 



• The address line containing the street name and building number.For 

Japanese addresses, the block and lot number. For addresses in the 

U.K., this can contain a building name. For example: 

Muldenweg 2 

71665 Vaihingen an der Enz 



calle naranjo 7 

89600 Altamira TAMPS 


• The full address. For more information, see Single Line Input on 

page 324 

• For all countries except Argentina, Great Britain, and Japan, a street 

intersection. To specify a street intersection, use double ampersand 

(&&) to separate the streets. For more information, see Street Intersection 

Input on page 327. 

For France, an input street address can include a numbered range. For 

example, consider an input address of 104-106 rue de Charenton. The 

returned candidate includes two address ranges, and the 104 close 

match is from the 100-106 range. Alphanumeric ranged addresses are 

also handled (for example, you could input a alphanumeric ranged address 

like 2A-4B. If the geocoding database has alphabetic values for 

the input house number, the geocoder returns the house number as it 

exists in the database (with or without the alphabetic character). If the 

geocoder cannot confirm alphabetic values for the input house number, 

it returns the alphabetic value that was provided on input (as long as 

the house number matched). 

361


362 

Field Name 

AddressLine2 

City 

County 


The second address line of a two-line address. For example: 

26 WELLINGTON ST E 

SUITE 500 

TORONTO ON M5E 1S2 

This field is not used in Argentina, Australia, Austria, Belgium or Luxembourg, 

Brazil, Czech Republic, Denmark, Estonia, Finland, France, 

Germany, Hungary, India, Ireland, Italy, Japan, Latvia, Lithuania, 

Malaysia, Mexico, The Netherlands, Norway, Poland, Portugal, Singapore, 

Slovenia, South Africa, Spain, Sweden, Switzerland (including 

Liechtenstein), Thailand, and Turkey. 

The city or town name. Your input address should use the official city 

name. For Argentina, Austria, the Czech Republic, Italy, Mexico, Portugal, 

Spain, Slovenia, and Switzerland, you may use the town alias. 

Note: In Argentina, Buenos Aires Federal District is not part of Buenos 

Aires province. If your input specifies only "Buenos Aires", 

MapInfo Spatial Server returns candidates in both the Federal 

District and in the region of Buenos Aires. 

For provincial capitals in Argentina, you can use the word Capital as 

well as the actual capital name. For example, input of "Capital, MZA" is 

equivalent to "Mendoza, MZA". 

Some areas in France are generally recognized as cities even though 

they are not truly administrative cities. These areas represent Artificial 

City Areas, or Virtual Towns. For a listing of supported virtual towns, 

see Address Guidelines for France on page 317. 


For Japan, this field contains the municipality subdivision (oaza). 

For Lithuania, the city and county can be swapped on input. That is, if 

a city appears in either the City input field or in the County input field, 

the geocoder will still return the correct candidate. Similarly, a locality 

can be entered in either the Locality or City input field. 









Field Name 

FirmName 

User's Guide 






































Company or place name. For example: 


363


364 

Field Name 

LastLine 

Locality 


Pitney Bowes 

4360 Dukes Rd 

Kalgoorlie WA 6430 

Aravali Vihar Police Station 

Alwar 301030 

The last line of the address. 

4360 DUKES RD 

KALGOORLIE WA 6430 










EA) 





















Field Name 

PostalCode 

User's Guide 




















Australia uses a four-digit postal code system. In general, the first digit 

represents a state or territory, the second digit represents a region with 

a state, and digits three and four representing towns. For more information, 

see Address Guidelines for Australia on page 311. 

Austria uses a four-digit postal code system. The first two numbers indicate 

the sector and the last two numbers designate the delivery point 

within the sector. 

Belgium and Luxembourg use a four-digit postal code. The first two digits 

designate the sorting area (with the first digit usually representing the 

region) The next two digits represent the post office and delivery office. 

For Brazil, use the complete eight-digit postcode for the most accurate 

results (a single close match candidate). However, you can use a fivedigit 

postcode. 

Switzerland uses a four-digit postal code beginning with a number 

between 1 and 9. Liechtenstein postcodes range from 9480 to 9499. 

Canada uses a six-character postal code. The first three characters are 

typically separated from the second three with a space. The first three 

characters are the FSA, the second three are the LDU. Street address 

geocoding only requires the FSA while postal code geocoding requires 

the full postal code (FSALDU). Choose whether you wish to have a 

space between the first three and last three characters of the postal 

code. Keeping this consistent speeds up the geocoding process. 

365


366 

Field Name 


China has a six-digit postcode system. The first two digits indicate the 

province. The third digit and fourth digits indicate the district and 

city/town. The final two digits represent the postal delivery zone or 

prominent location. Larger provinces or cities might be assigned more 

than one block of codes. For example, Guangdong Province is assigned 

51 and 52 as the first two digits. 

Note: For China, postal centroid geocoding requires the complete sixdigit 

postcode. However, when a postal code is provided as part 

of an address for street geocoding, only four-digit postal codes 

are accepted and returned. 

Czech Republic has a five-digit postal code system. Postal codes are 

typically separated by a space between the third and fourth numbers, 

but variations in spacing or no spacing in postal codes is supported. 

Denmark uses a four-digit postal code beginning with a number between 

1 and 9. 

Spanish postcodes are composed of five digits (Andorra postcodes. are 

in the format AN###.) You must enter a complete postcode. 

Estonia uses a five-digit postal code system. 

Finland uses a five-digit postal code. The first two digits designate the 

post town or municipal area. The last three digits represent the destination 

post office. 

France uses a five-digit postal code. You must enter a complete postcode. 

The first two digits usually represent the department. The digits 

00 represent military addresses and there are also special digit for 

overseas territories. The last three digits represent the local delivery 

area. In the larger cities (Paris, Lyon Marseille), the last two digits represent 

the arrondissement. For example, in the postcode: 33380, 33 is 

the department 380 is the delivery area. 

Hungary has a four-digit postal code system. The first digit is for the 

postal region. 

India has a six-digit postal code system. 

In Ireland, postal data is available only for Dublin. For street-level geocoding, 

enter the full postcode in the format Dublin#, where # ranges 

from 1-24 (and one district known as Dublin6W). For postal centroid 

geocoding (or postal centroid fallback) use only the postal number as 

input. For example, specify the PostalCode as 3 rather than Dublin3. 

Only the postcode number is returned for postal centroid geocoding or 

fallback. 

Italy uses a five-digit postal code system. The first three numbers indicate 

the province and the last two numbers designate the delivery point. 


Field Name 

User's Guide 


Japan uses a seven-digit numeric postal code system in the format: 

999-99999. 

Latvia uses a four-digit postal code system. The first two numbers indicate 

the routing area and the last two numbers designate the post office. 

Postal codes cannot begin with 0, 22-29, 35, 49, 55 or 58-99. 

Lithuania uses a five-digit postal code system. The LT prefix is allowed 

but is not required. 

Malaysia uses a five-digit postal code system. 

Netherlands uses a postal code system of four digits followed by two 

letters. The first two numbers indicate the city and region. The last two 

numbers and two letters designate the specific house number range. 

The letters represent a distribution code. You can geocode using the 

four digits only or you can include the two-letter distribution code. 

Norway uses a four-digit postal code. The first two digits designate the 

geographic area. 

New Zealand uses a four-digit postal code. The first digit represents the 

geographic region. The second and third digits represent the postal sort 

area. The last digit represents a specific urban area, rural delivery or 

PO box lobby. 

Poland uses a five-digit postal code in the format 99-999. The first digit 

represents the postal district. The second digit represents a major subdivision 

of that district. The three numbers after the dash represent the 

delivery post office. For large municipalities, the last three digits can 

represent a particular street, section of a street, or sometimes a specific 

address. 

Portugal uses a four-digit postal code beginning with a number between 

1 and 9. More recently, Portugal instituted a seven-digit postcode with 

a dash and three additional digits following the first four digits. The 

geocoder ignores the additional three digits and returns the four-digit 

postal code. 

Singapore uses a six-digit postal code system. The first two numbers 

indicate the sector and the last four numbers designate the delivery 

point within the sector. Every building in Singapore has a unique postal 

code. 

Sweden uses a five-digit postal code beginning with a number between 

1 and 9. There is typically a space between the first three digits (the 

outward sorting part of the postcode) and the last two digits (the inward 

sorting part). 

Thailand uses a five-digit postal code system. 


367


368 

Field Name 

StateProvince 


Turkey has a five-digit postal code system. Postal codes are typically 

separated by a space between the third and fourth numbers, but the 

geocoder can handle variations in spacing or no spacing in postal codes. 

In the United Kingdom, each address is associated with an alphanumeric 

code up to seven characters in length. Each postcode includes an average 

of 15 addresses. In some cases, where a customer receives a 

substantial amount of mail, for example, a business, the postcode pertains 

to just that one address (a large-user postcode). 

































Field Name 

Address Input Guidelines 










geocoding. 

Address Guidelines for Argentina 


geocoding. 


supported in input addresses. Examples of typical thoroughfare types are: 

Avendia 

Calle 

Lateral Ruta 

Ruta Provincia 

Avendia 

C 

Lat Ruta 

R P 

Av 

Clle 

L R 

RP 



are also recognized in input addresses. The following numbers and equivalents are recognized 

as part of a street name input: 

1,UNO,PRIMERO,PRIMER,PRIMERA 

5,CINCO,QUINTO,QUINTA 

Ave 

LR 

Avda 

For example, an input street name of "25 de Mayo" is recognized and handled the same way as 

"Veinticinco de Mayo". 

• Proper names and dates in street and town names—Proper names and dates are often used in 

Argentina addresses, and these are handled by MapMarker Argentina. For example, an input street 

name of "Juan F. Ibarra" is recognized and handled the same way as "Juan Felipe Ibarra". 

• Directionals in addresses—The following directionals are recognized in input addresses: Norte, 

Oriente, Este, Sur, Oueste, Occidente, Poniente, N, E, S, O, NE, NO, SE, SO, Noreste, Sudeste, 

Noroeste, Sudoeste. 

User's Guide 


369


370 

• Abbreviations in addresses—A number of common abbreviations can be used in input addresses. 

Geocode AddressARG will recognize the abbreviations and geocode successfully. For example, following 

is a small sample of equivalent abbreviations. This is not a complete list of address abbreviations. 

Bario 

Ciudad 

Colonia 

Doctor 

Francisco 

Manza 

BAR 

CD 

COL 

DR 

FCO 

MZA 

Address Guidelines for Australia 

CD. 

COL. 


additional information on Australia addresses, see the Australia Post website: www.auspost.com.au. 


• House numbers and apartments—Remove spaces between house number and apartment letter. 

123 A Main Street does not geocode correctly because the geocoder assumes that the name of the 

street is A. Two workaround options are available: 






• Flat 2, 17 Jones St. 

• Apt 19, 123 Main St., where Apt is the unit type and 99 is the unit number. In this format, you must 

specify a valid unit type, otherwise the address will not be geocoded correctly. For a listing of valid 

unit types, see www.auspost.com.au. 

• 99-123 Main St. For an address derived from the G-NAF database, this address is a unique house 

number and is geocoded as a single delivery point, not as a range. 


cities that consist mainly of numbered streets. These streets can only be distinguished by their directional 

suffixes and street types. They also distinguish addresses on streets that change direction. For 

example: 123 Queen St W and 123 Queen St E would have very different coordinates. 



data. For a listing of street types, see www.auspost.com.au. 

• City/suburb name—Enter the city/suburb name in the City field. Note that all input addresses must 

contain either a city or a postal code. If the geocoder does not make a close match on the street in 

the specified suburb, it can make a close match on the Local Government Area (LGA). Local Government 

Area (LGAs) do not encompass all of Australia. For example, LGAs do not cover extensive 


northern parts of South Australia, a large part of the Northern Territory, and the Australian Capital 

Territory. An LGA can include a number of official suburbs. It is best to use the suburb name for geocoding 

purposes, but it is possible to get a match on the LGA (or to return LGA information) in geocoded 

results. 

• Postal code—All postcodes consist of four digits. While there are exceptions, the general format of 

postcodes is as follows: 

Note: 

These are general guidelines, and there are exceptions to these postcode number ranges. 

• Digit 1 represents the state or territory, within the following general conventions: 

2 

2600 and 2900 

3 

4 

5 

6 

7 

0 

NSW 

• Digit 2 represents a region within the state. State or territorial capitals usually have a 0 or 1 as the 

second digit. 

• Digits 3 and 4 represent towns. Major towns usually have a 0 as the last digit (or sometimes as the 

last two digits). 

Address Guidelines for Austria 


additional information on Austrian addresses, see the Austria Post website: www.post.at. 

ACT 

VIC 

QLD 

SA 

WA 

TAS 


• State abbreviations—State abbreviations are supported. The following table lists the Austrian states 

and their abbreviations. 

Burgenland 

Kärnten 

User's Guide 

NT 

Bgl 

Ktn 


371


372 

Niederösterreich 

Oberösterreich 

Salzburg 

Steiermark 

Tirol 

Vorarlberg 

Wien 

NÖ 

OÖ 

Sbg 

Stm 

Tirol 

Vbg 

Wien 

• Thoroughfare types—Austrian thoroughfare types and their common abbreviations are recognized 

and fully supported on input and output. 




abbreviations used in addresses are recognized. 

Address Guidelines for Belgium 






supported. 



supported. 





Address Guidelines for Brazil 




thoroughfare types. 


ALAMEDA=AL,ALAMEDA,ALUA LALA 

ACESSO=AC,ACESSO 

ARCO=ARCO 

AUTO-ESTRADA=AUTO-EST,AUTO-ESTRADA 

AVENIDA=AV,AVDA,AVE,AVENIDA 

AZINHAGA=AZINHAGA 

BAIRRO=BAI,BAIRRO 

BALUARTE=BALUARTE 

BECO=BECO 

Many others are also recognized. 



in an input address: 

um, first, one, 1st, primera, primeiras, primeiro 

dois, second, two, 2nd, segunda, segundos 

Many other numeric designations are also recognized. 

• Directionals in addresses—The following directionals are recognized in input addresses: norte, do 

norte, setentrional, sul, do sul, meridional, leste, este, do leste, do este, oriental, oeste, do oeste, 

ocidental 


abbreviations used in addresses are supported. This is a partial list of common words and abbreviations 

that are recognized. Many other common words are also handled. 


Common words 


Address Guidelines for Canada 

dos, das, do, da, de, d, dom, uma, e, o, n, sn, sa, ie a, os, as, ao, em, 

no, na, nos, nas, ao, andar, andares, ander, apart, apartment, flat, 

apartmento, apto, apt, ap, ato, casa, cs, cob, unit (and many other 

common articles of speech) 

os, nova, novas, na, no, nas, nos, um 

aeroporto=aerop 

internacio=intern,int 

internacional=int 

international=int 

conselheiro=cnso 

desembargador=des 

regente=reg 

limitado=ltda,ltdo,ltd 

(and many other abbreviations) 


geocoding. 

User's Guide 


373


374 

• Post Office Box numbers—P.O. Boxes and Rural Route addresses are not geocodable. Geocode 

Address CAN will honor this user input and attempt to output Boxes and Rural Route information, but 

it will not be used for geocoding purposes. 

• Highway addresses—Highway addresses (such as Hwy 401) are geocoded. 

• House numbers and apartment letters—Remove spaces between house number and apartment 

letter. 123 A Main Street does not geocode correctly because the geocoder assumes that the name 

of the street is A. Two workaround options are available: 






• 99-123 Main St, where 99 is the unit number. In this format, do not specify the unit type. The number 

99 could be a suite, apartment, unit, floor or any valid unit type. 

• 123 Main St. Apt 99, where Apt is the unit type and 99 is the unit number. In this format, you must 

specify a valid unit type (such as Apt or Suite), otherwise the address will not be geocoded correctly. 


cities, such as Calgary, which consist mainly of numbered streets. These streets can only be distinguished 

by their directional suffixes and street types. They also distinguish addresses on streets that 

change direction. For example: 123 Main St W and 123 Main St E have very different coordinates. 



data. For a list of valid street types see www.canadapost.com. 

• City name—Do not abbreviate city names. If the city is unknown, you may leave it blank, although 

this may affect the accuracy of the geocode. 

• Province name—You may use the full province name (for example, Ontario), but using the twocharacter 

abbreviation (ON) is recommended to reduce the likelihood of input errors. 

Address Guidelines for Czech Republic 

Follow these guidelines to provide input that Geocode Address Global can successfully geocode. 


• Aliases for town, district, and region names—Aliases for town, district, and region names are 

supported. 


are recognized and fully supported on input and output. 

Address Guidelines for Denmark 


additional information about the Denmark postal system, see the Post Danmark website: 

www.postdanmark.dk. 


• Supported languages—Danish and English language aliases are supported for major town/municipality 

names. For example, Copenhagen (English) is equivalent to København (Danish). 



supported on input and output. Following is a list of recognized thoroughfare types. This is not a 

complete list. Additional thoroughfare types may also be recognized. 

User's Guide 

ALLÉ=alle 

ANLAEG=anlaeg 

ANLEAG=anleag 

BAKKEN=bakken 

BANEN=banen 

BASTION=bastion 

BOUL=boulevard 

BOULEVARD=bulevardi 

BRO=bro 

BROEN=bro 

BUEN=buen 

BULEVARDI=bulevardi 

DAMMEN=dammen 

DOSSERING=dossering 

GAARD=garrd 

GADE=gade 

GANGEN=gangen 

GARD=gard 

GÂRD=gard 

GET=get 

HAVE=have 

HAVN=havn 

HOEJEN=hojen 

HOJEN=højen 

HøJEN=højen 

HOLMEN=holmen 

HUSET=huset 

KAER=kaer 

KEAR=kear 

KRAENTEN=kraeten 

KREANTEN=kreanten 

LAENGEN=laengen 

LEANGEN=leangen 

MARKEN=marken 

PARK=parken 

PARKEN=parken 

PASSAGEN=passagen 

PLADS=plads 

SIDEN=siden 

STIEN=stien 

STRAEDE=straede 

STREADE=streade 

SVINGET=svinget 

TOFTEN=toften 

TORV=torv 


375


376 

VAENGE=vaenge 

VANGEN=vangen 

VARDEN=varden 

VEANGE=veange 

VEJ=vej 





Address Guidelines for Finland 


additional information about the Finland postal system, see the Posti kuluttajille website: www.posti.fi. 

Finnish postal codes are managed by Itella Corporation. For information, see the Itella postal codes 

page. 


• Thoroughfare types—Finnish thoroughfare types and their common abbreviations are recognized 

and fully supported on input and output. Swedish thoroughfare types are also supported. 





Address Guidelines for France 


additional information about the French postal system, see the La Poste website: www.laposte.com. 


• Virtual town names—Some areas are generally recognized as cities even though they are not truly 

administrative cities. These areas represent Artificial City Areas, or Virtual Towns. Since these virtual 

town names are commonly used by the public, they are supported and treated as aliases for any of 

the encompassed towns. Returned candidates have the correct real town in place of the input virtual 

town. 

Table 61: Virtual Towns in France 


Défense (La) 

Sophia Antipolis 


Part of: Nanterre, Puteaux, Courbevoie 

Part of: Valbonne, Mougins, Vallauris, Antibes, 

Biot 



Cergy-Pontoise 

Marne-la-Vallée 

Saint-Quentin-en-Yvelines 

Sénart 

Evry 

Etang de Berre 

Isle-d'Abeau 


Menucourt, Courdimanche, Puiseux-Pontoise, 

Osny, Pontoise, Cergy, Vauréal, Neuville-sur-Oise, 

Saint-Ouenl'Aumône, Jouy-le-Moutier, Eragny 

Bry-sur-Marne, Villiers-sur-Marne, Noisy-le-Grand, 

Champs-sur-Marne, Emerainville, Noisiel, Lognes, 

Croissy-Beaubourg, Torcy, Collégien, Ferrières, 

Bussy- Saint-Georges, Bussy-Saint-Martin, Saint- 

Thibault-des-Vignes, Gouvernes, Conches, 

Guermantes, Jossigny, Lagny-sur-Marne, 

Montévrain, Chanteloup-en-Brie, Serris, Chessy, 

Coupvray, Magny-le-Hongre, Bailly- Romainvilliers 

Elancourt, Verrière (La), Trappes, Montigny-le- 

Bretonneux, Guyancourt, Voisins-le-Bretonneux, 

Magnyle- Hameau 

Tigery, Combs-la-Ville, Lieusaint, Moissy- 

Cramayel, Saint-Pierre-du-Perray, Savigny-le- 

Temple, Réau, Nandy, Cesson, Vert-Saint-Denis 

Evry, Bondoufle, Courcouronnes, Lisses 

Fos-sur-Mer, Miramas, Vitrolles, Istres 

Four, Isle d’Abeau (L’), Saint-Quentin-Fallavier, 

Vaulx-le- Milieu, Villefontaine 

• Common words and abbreviations—The geocoder handles common abbreviations that are used 

in French addresses. It supports all the official French street type abbreviations plus a number of unofficial 

street types to help improve geocoding efficiency. A partial list is: 

Table 62: Common French Address Abbreviations 


Hauts 

appartement 

Saint 

User's Guide 

Abbreviation 

No abbreviation. 

APP, APT, APPART 

ST 


377


378 


Sainte 

rue 

Charles de Gaulle 

Regiment D’Infanterie de Marine 

Division Blindée 

Abbreviation 

STE 

r 

CDG 

RIMA 

• Directionals in addresses—Abbreviated street directionals are also handled on input and the returned 

candidate displays the complete directional. 

Table 63: Street Directionals 

N 

S 

E 

O 

NE 

SE 

NO 

SO 

N. 

S. 

E. 

O. 

N.E. 

S.E. 

N.O. 

S.O. 

DB 

Nord 

Sud 

Est 

Ouest 

Nord-Est 

Sud-Est 

Nord-Ouest 

Sud-Ouest 

• Ordinals and numbered street names—Input addresses can include ordinals such as 1er, 2e, 2nd, 

2nde, 3e. All subsequent ordinal street names are designated with "e" or "ème". You can also specify 

numbers in street names or express the numbers as words. For example, the following street names 

are equivalent and can both be geocoded as part of an input address: 

Rue du 4 septembre 

Rue du quatre septembre 

• House numbers with letters—House numbers can include letters, such as 85B Ave des 

provinces. 


• Postal box (BP) addresses—The geocoder can handle Postal Box (Boite Postale) addresses. For 

the following input address, a close match candidate is returned with a result code of S5HPNTSC-A. 

AddressLine1: BP 112 2 Avenue CDG 


City: Le Chesnay 

Note that in this example, the street name CDG is returned as Charles de Gaulle and the postcode 

is corrected. The BP itself is not returned. 

• CEDEX addresses—The geocoder does not use CEDEX for geocoding but CEDEX will not interfere 

with geocoding. CEDEX can be entered in AddressLine1, City, or PostalCode fields. The CEDEX itself 

is not returned but the complete postcode is returned. For the following input address, a close match 

candidate is returned with a result code of S5HPNTS--A. 

AddressLine1: 17 Rue Louise Michel 

PostalCode: 92301 CEDEX 

City: Levallois-Perret 

The postcode is returned but not a postal centroid (there is no Z in the ninth position of the return 

code). The CEDEX itself is not returned. 

• Paris address formats and arrondissements—Paris addresses typically have a different input 

format. The house number appears after the street name rather than before the street name. The 

geocoder handles this input format and geocodes correctly. Arrondissements (the last two digits of 

the postcode) can be entered and the complete locality and postcode information is returned. For the 

following input address, a close match candidate is returned with a result code of S5HPNTSCZA. 

AddressLine1: 7 Rue Beranger 


City: Paris 

The returned Locality field includes the arrondissement (district) information. The Paris region includes 

20 arrondissements, which are represented by the last two digit of the postcode (the first three digits 

are 750). A Paris address may be written with the last two digits only. For the following input address, 

a close match candidate is returned with a result code of S5HPNTSC-A 

AddressLine1: 51 Rue Lafitte 


City: Paris 

The complete postcode (75009) is returned even though 09 (representing the ninth arrondissement) 

was entered. 

• Military addresses—Military addresses (including typical military address abbreviations) are handled. 

The first two digits usually represent the department. The digits 00 represent military addresses. 

• Monaco addresses—The geocoder handles Monaco addresses. Specify Monaco in the StateProvince 

input field. All Monaco postcodes begin with the number 98. Monaco is returned in the address even 

if it was not specified on input. 

User's Guide 


379


380 

Address Guidelines for Germany 


additional information about the Hungarian postal system, see the Deutsche Post website: 

www.deutschepost.de. 

Addresses must contain either a city or a postal code. 

German addresses may contain some or all of the following address elements. 

Table 64: German Address Elements 



Ort 

Kreis 

Bundesland 

Postcode 

Field 

AddressLine1 

City 

County 

Address Guidelines for Hungary 

StateProvince 

PostalCode 

Example 

Muldenweg 2 

Vaihingen an der Enz 

Ludwigsburg 

Baden-Württemberg 

71665 


additional information about the Hungarian postal system, see the Magyar Posta website: www.posta.hu. 




• House number, floor number, and apartment numbers—The geocoder supports street addresses 

with house number, floor, and apartment information. For example: 

AddressLine1: Kavics utca 13 II/3 


City: Budapest 

This is interpreted as house number 13, floor Roman numeral 2, apartment number 13. This could 

also be input as: Kavics utca 13 II em 3 ajtó. 

Address Guidelines for Ireland 


additional information about the Ireland postal system, see the An Post website: www.anpost.ie. 





thoroughfare types. Many others are also recognized. 

Table 65: Thoroughfare Types in Ireland 

Pre Thoroughfare Types 

Áirse 

Ard 

Arda 

Ardán 

Ascaill 

Barra 

Bealach 

Bogha 

Bóithrín 

Bóthar 

Brí 

Bruach 

Búlbhard 

Post Thoroughfare Types 

Street (Also: St.,ST,STR) 

Terrace (Also: TCE) 

Third 

Track (Also: TRK,TCK) 

Vale 

Valley 

View 

Village 

Walk (Also: WK) 

Way (Also: WY) 

Wood(s) 

Yard (Also: Yd.) 

• Common words and directionals—The geocoder recognizes common words and directionals used 

in addresses and can geocode these addresses successfully. This is a partial list of common words 

and directionals that are understood by the geocoder. Many other common words are also handled. 

User's Guide 

an, na, a 

Cuar, Circular 

Cros, Cross 

Thoir, East 

Tosaigh, Front 

Laistigh, Inner 

Beag, Little 


381


382 

Lower 

Main 

Middle 

Military 

Nua, New 

Thuaidh, North 

Sean, Old 

Lasmuigh, Outer 

ear 

Dara, Second 

Theas, South 

Third 

Uachtarach, Uacht, Upper 

Thiar, West 

Iartharach, Western 

Saint, St, Naomh 

retail, park, business, center, centre, shopping, office, mills, 

shop, service, outlet 

saint, station 

The 

Park 

House 

Building, Blgs 

House, Hse, Hses 

branch 

• Directionals—The geocoder recognizes the following directionals: North, N, Nth, South, S, Sth, East, 

E, Est, West, W, Wst, NE, NW Sea SW Lower, LW, LR, Upper, UP, Upp, Uppe, upr, Thuaidh, Thoirm, 

Thiar, Theas 

• Common abbreviations—The geocoder recognizes common abbreviations used in addresses and 

can geocode these addresses successfully. This is a partial list of abbreviations that are understood 

by the geocoder. Many other common abbreviations are also handled. 

Table 66: Common Abbreviations 

Word 

saint 

great 

north 

south 

east 

Abbreviation 

st., st 

gt., gt 

n, nth 

s, sth 

e, est 


Word 

west 

northeast 

northwest 

southeast 

southwest 

lower 

upper 

mount 

and 

football 

club 

limited 

park 

estate 

gardens 

building 

industrial 

industries 

number 

center 

centre 

User's Guide 

Abbreviation 

w, wst 

ne 

nw 

se 

sw 

lw, lr 

up, upp, uppe 

mnt, mt 

& 

f 

c 

ltd 

pk 

est 

gdns 

bld 

ind 

ind 

num 


cnt, centre 

cnt, center 

383


384 

Word 

country 

market 

square 

o+connell 

Abbreviation 

co 

mrkt 

s 

oconnell 



in an input address: um, first, one, 1st, primera, primeiras, primeiro dois, second, two, 2nd, segunda, 

segundos. 

Address Guidelines for Italy 


additional information about the Italy postal system, see the Posteitaliane website: www.poste.it. 


• German language addresses—German address formats (common in the South Tyrol area of Italy) 

are handled and geocoded correctly. Typical German thoroughfare types and abbreviations are supported. 

For example, the street name Marienstraße could be abbreviated as Marienstr, and the same 

candidate is returned. Note that regardless of whether strasse or straße is entered as input, strasse 

is returned in the output candidate. 

• Aliases for regions, localities, and provinces—Aliases can be used on input. For example, Tuscany 

is an alias for the region of Toscana. When you geocode, the returned candidate matches the user 

input. That is, if aliases were used then aliases are returned. 

• Regions and provinces—For street geocoding, region names (which are entered in the StateProvince 

field) are not used for geocoding purposes, but are returned. Province abbreviations consisting of two 

letters are returned in the County field. Italy has 20 regions and 110 provinces. 

• PO boxes—Post Office Box numbers are not used for address matching or geocoding purposes, but 

this does not interfere with matching or geocoding. The PO Box information is not returned. The following 

formats are recognized: 

Casella Postale 

CP 


are recognized and fully supported on input and output. Both Italian and German thoroughfare 

formats are supported. 



addresses successfully. 



For example, if you enter the street name Via 42 Martiri, the street name QUARANTADUE 

MARTIRI is returned. Ordinals are also recognized in input addresses. 

Address Guidelines for Japan 

A typical Japanese address looks like this: 

The elements of this address are described in the following table. 

Table 67: Japanese Address Elements 


Prefecture 

City (Shi) 

Municipality Subdivision (Oaza) 

City District (Chome) 

Block/lot number 

MapInfo Spatial Server Field 

Name 

StateProvince 

County 

City 

Locality 

Address Guidelines for Malaysia 

AddressLine1 

Example 

Block and lot numbers are the 

most specific address elements. 

Japanese addresses do not typically 


For information on Malaysian addresses, see the Pos Malaysia website: www.pos.com.my. 

Some Malaysian addresses do not require a city or a postal code. For certain addresses, the geocoder 

can obtain a geocode by using only street information, which can be a combination of address number 

and street name, without any town or postal code. 

User's Guide 


385


386 

Address Guidelines for Mexico 


geocoding. 


• Aliases for cities—You can input aliases for city names and still get a close match. For instance, you 

could enter "Coyoacán" or "Miguel Hidalgo" and it would match to Mexico city. 

Table 68: Aliases for Mexican Cities 

Alias 

Mexico City/Ciudad de Mexico 

Ciudad López Mateos 

Las Tortugas 

Naucalpan 

San Bernardo 

Town 

La Magdalena Contreras 

Álvaro Obregón 

Azcapotzalco 

Benito Juárez 

Ciudad Madero 

Coyoacán 

Cuajimalpa de Morelos 

Cuauhtémoc 

Gustavo A. Madero 

Iztacalco 

Iztapalapa 

Miguel Hidalgo 

Milpa Alta 

Tláhuac 

Tlalpan 

Venustiano Carranza 

Xochimilco 

Atizapán de Zaragoza 

Emiliano Zapata 

Naucalpan de Juárez 

San Bernardo Mixtepec 

• Aliases for states—You can use state aliases and get a close match. For example, if you enter "YUC" 

it would match to Yucatán. 


Table 69: Aliases for Mexican States 

State 

Aguascalientes 

Baja California 

Baja California Sur 

Campeche 

Chiapas 

Chihuahua 

Colima 

Coahuila de Zaragoza 

Distrito Federal 

Durango 

Guanajuato 

Guerrero 

Hidalgo 

Jalisco 

México 

Michoacán de Ocampo 

Morelos 

Nayarit 

User's Guide 

Nuevo León 

Alias 

AGS/AG/AGU 

Bassa California/Neder-Californië/BC/BJ/BN/ 

BAJ/B C 

Bassa California del Sud/BCS/BS/BAS/B C S 

CAM/CP/CM 

CHIS/CH/CU/CHP 

CHIH/CI/CL/CHU 

COL/CL/CH 

COAH/CU/CS/COA/CZ/C Z/Coahuila 

Distretto Federale/DF/MDF/D F 

DGO/DG/DUR 

GTO/GJ/GT/GUA 

GRO/GR/GUE 

HGO/HG/HID 

JAL/JA 

Mexico/Mexiko/Meksiko/Messico/MEX/EM/MX 

MICH/MH/MC/MIC/MO/M O/Michoacan 

MOR/MR 

NAY/NA 


NL/NUE/N L 

387


388 

State 

Oaxaca 

Puebla 

Querétaro Arteaga 

Quintana Roo 

San Luis Potosí 

Sinaloa 

Sonora 

Tabasco 

Tamaulipas 

Tlaxcala 

Veracruz de Ignacio de la Llave 

Yucatán 

Zacatecas 

Alias 

OAX/OA 

PUE/PU/PUB 

QRO/QA/QE/QDA/Q A/Queretaro 

QROO/QR/QI/QRO/Q R/Q Roo 

San Luis Potosí 

SIN/SI 

SON/SO 

TAB/TA/TB 

TAMPS/TM/TAM 

TLAX/TL/TLX 

VER/VZ/VE/VCL/Veracruz 

Yucatan/YUC/YC/YU 

ZAC/ZT/ZA 

• Numbers, numeric equivilants, and ordinals—Numbered streets are mapped to the named equivalents. 


are also recognized in input addresses. For example, the following are all recognized in an input address: 

5, CINCO, QUINTO, and QUINTA. 

• Directionals—The following directionals are recognized in input addresses: Norte, Oriente, Este, Sur, 

Oueste, Occidente, Poniente, N, E, S, O, NE, NO, SE, SO, Noreste, Sudeste, Noroeste, and Sudoeste. 

Address Guidelines for Netherlands 


additional information on Netherlands addresses, see the TNT Post website: www.tntpost.nl. 


• Aliases for cities—Locality, town, and province aliases can be used on input. When you geocode, 

the better matched input name (the official name or alias) is returned with the candidate. 


• Post office box numbers—Post Office Box numbers are not used for address matching or geocoding 

purposes, but this does not interfere with matching or geocoding. The PO Box information is not returned. 

The following formats are recognized: Postbus, PostFach. 







Address Guidelines for New Zealand 


additional information on New Zealand addresses, see the New Zealand Post website: www.nzpost.co.nz. 


• Aliases for suburbs—The geocoder supports locally used suburb names in addition to the officially 

recognized suburb names. For example, Rosedale is an alias of the official suburb name of Hargest. 







Address Guidelines for Norway 


additional information on Norway addresses, see the Posten Norge website: www.posten.no. 




addresses successfully. Following is a list of common words that are recognized. Other other common 

words and abbreviations may also be recognized. 

User's Guide 

Common words 


Directionals 


av, bak, bakerst de, dei, den, det e, ei, ein, eit, en, 

et for, foran, fra, gammel i, imellom, Industriebygget, 

inntil, kort lang, lille, lita, lite, liten. med, mellom 

nær, nærmest, nest, ny og, over, overfor, på 

små, stor, til, under ved, ved siden av 

Sankt=St 

nord, øst, syd, vest 

389


390 

• Numbers, equivalents, and ordinals—Numbered streets are mapped to the named equivalents. 

Ordinals are also recognized in input addresses 

Address Guidelines for Poland 


additional information on Poland addresses, see the Polish Post website: www.poczta-polska.pl. 








Address Guidelines for Portugal 


additional information on Portugal addresses, see the CTT Portugal Post website: www.ctt.pt. 








Address Guidelines for Singapore 


additional information on Singapore addresses, see the Singapore Post website: www.singpost.com. 


• PO box addresses—Post Office Box numbers are not used for address matching or geocoding purposes, 

but this does not interfere with matching or geocoding. The PO Box information is not returned. 

The following formats are recognized: P O Box, Locked Bag Service. 


supported on input and output. The following table shows is a partial list of recognized thoroughfare 

types. Others may also be recognized. 

Table 70: Thoroughfare Types 

Pre-thoroughfare types 

lorong=lorong, lrg, lor, lorang 

jalan=jalan, jln, jl 

lengkong=lengkong, lkg 


Post-thoroughare types 

kallang=kallang 

mount=mount, mt 

upper=upper, upp 

track=trk,tck 

street=st 

road=rd 

drive=dr 

crescent=cr,cres,crescent,cresent 

boulevard=bvd,blvd,bouleyard,boulvard 

hill=hill 

gate=gate 

mall=mall 

avenue=ave,av,avnue 

link=lk 

lane=l 

walk=wk 

green=grn 

highway=hwy 

quay=quay, qy 

parkway=pwy 



This is a partial list of common words, abbreviations, and directionals that are recognized. Other 

common words may also be recognized. 

User's Guide 


Category 

Common words 


Building identifiers 

Words 


and, ltd, international, industrial, plc, group, co, 

front, by, bay 

the, at, a, an, blk 

center, centre, building, house, place, court, galleria, 

hotel, park, complex, mart, temple, bank, 

391


392 

Category 


Words 

exchange, station, community, area, mosque, 

depertment, department, post office, shrine, 

chambers, masjid, apartments, complex, bureau, 

resort, lodge, harbour 

monastery, convent, restaurant, golf course, estate, 

campus, institute, university, facility, tunnel, 

libraray, society, mansion, hub, beach, church, 

park, kiosk, mission, condominium, warehouse, 

hall, laboratories, hospital, corporation, fire post, 

terminal, workshop, headquarters, cemetery 

plaza, villa, garden, gardens, tower, station, hall, 

lodge, cottages, cottage, village, gurdwara, place 

AYE=Ayer Rajah Expressway 

BKE=Bukit Timah Expressway 

CTE=Central Expressway 

ECP=East Coast Parkway 

KJE=Kranji Expressway 

KPE=Kallang-Paya Lebar Expressway 

PIE=Pan Island Expressway 

SLE=Seletar Expressway 

TPE=Tampines Expressway 

Ctrl=Central 

E=East 

S=South 

W=West 

N=North 

JLN=Jalan 

CR=Crescent 

GR=Grove 

L=Lane 

WK=Walk 

LRG=Lorong 

TG.=TANJONG 


Category 

Directionals in addresses 

Address Guidelines for Spain 

Words 

North, N, Nth, South, S, Sth, East, E, Est, West, 

W, Wst, NE, NW, SE, SW, T1, T2 


additional information about the Denmark postal system, see the Spanish postal service website: 

www.correos.es. 


• Supported languages—If a street has a Spanish name and Basque or Catalan alternate name, the 

returned candidate street name will match the input. That is, if a Basque or Catalan street name is 

used on input, then the Basque or Catalan alternate street name is returned as a close match candidate. 

If the Spanish street name is input, the Spanish street name is returned. 

• Abbreviations in addresses—The geocoder handles common abbreviations that are used in Spanish 

addresses. This includes abbreviations for building types, floor indicators, titles, and articles of speech. 

The geocoder also supports all the official Spanish street type abbreviations plus a number of unofficial 

street types to help improve geocoding efficiency. Abbreviated street directionals are also handled on 

input and the returned candidate displays the complete directional. For example, input of Arroya 

Guadalpia N returns the street Arroya Guadalpia Norte. 

N,Norte, Nort 

S,Sur, Sud 

E,Este, Est 

O,Oeste, Oest 

Address Guidelines for Sweden 

North 

South 

East 

West 


additional information on Sweden addresses, see the Post Norden website: www.posten.se. 



supported on input and output. Following is a list of recognized thoroughfare types. Other types may 

also be recognized. 

User's Guide 

ALLE, ALLÉ, BACKE, BULEVARDI, BULEVARD 

DALLEN, ESPLANADI, GATAN, GATTAN, GATA 

GATE, GATEN, GRANDEN, GRAND, GRÄND 

GÅRD, GARD, KATU, KUJA, LERIG 

LIDEN, PARKEN, PARK, PLAN, PORTTI 

PROMENADEN, PROMENADER, RACE, RÅDE, RADE 

RINNE, STIGEN, STIG, STRAND, SKOG 


393


394 

TIE, TORG, VAG, VAGEN, VÄGEN 

VÄG, VAGAN, VÄGAN 



Following is a list of common words that are recognized. Other other common words and abbreviations 

may also be recognized. 

andra, at, åt, av, bak, bakom, de, del 

den, dens, emellan, en, for, för, fore, för 

framfor, framföre, framme, fran, från, gamla, gammal, gammalt 

i, in, infor, införe, intill, kort, lang, lång 

liten, litens, med, mellan, motliggande, narheten, närheten 

narmast, närmast, nord, Norra, ny, nya, och, ost 

Ostra, Östra, over, över, pa, på, sidan, sma 

små, Sodra, Södra, stor, syd, till, till, under 

vast, väst, Vastra, Västra, via 



Address Guidelines for Switzerland 

The Switzerland geocoder supports locations in Switzerland and Liechtenstein. Follow these guidelines 

to provide input that Geocode Address Global can successfully geocode. For additional information on 

Swiss addresses, see the Swiss Post website: www.swisspost.ch. For additional information on the 

Liechtenstein postal system, see the Liechtenstein Post Corp website: www.post.li. 


• Thoroughfare types—German, French, and Italian thoroughfare types and their common abbreviations 

are recognized and fully supported on input and output. Over 300 thoroughfare types are recognized. 

• Common words and abbreviations—You can use German, French, and Italian common words, 

directionals, house number indicators, and abbreviations that are typically used in addresses. 

• Numbers, numeric equivalents, and ordinals—Numbered streets are mapped to the named equivalents 

in German, French, or Italian. Ordinals are also recognized in input addresses. 

Address Guidelines for Thailand 


additional information on Thailand addresses, see the Thailand Post website: www.thailandpost.com. 









Address Guidelines for Turkey 


additional information on Turkey addresses, see the Turkey PTTt website: www.ptt.gov.tr. 



supported on input and output. Examples of typical thoroughfare types and their abbreviations are: 

Bulvar, Bulvari (boulevard) Cadde, Caddesi, Cd, Cad (avenue, lane) Mahalle, Mahallesi, Mah (neighborhood, 

quarter) Sokak, Sk, Sokagi (street) Yolu, Yol (way, road) This is not a complete list. Other 

thoroughfare types are also recognized. 



This is a partial list of common words and abbreviations that are recognized. Many other common 

words are also handled. 


Category 


Directionals 

Buildings 

Area names 

Levels or positions 

House number indicators 


Single Line Input 

Words 

ve 

Words representing north, south, east, west, 

northwest, northeast, southeast, southwest 

bina, binasi, apartman ,kurma, yap; ev, konut, 

mesken ,ev halki, yurt;zemin, taban, pist, kat 

semt, semti, ent, sehir, kasaba, sehir halki, büyük 

kasaba 

yukarida, asagida, asagi, altta, üzerinde, altinda, 

arkasinda, içinde, moda, ön, yanindaki, arasinda, 

sol, sag 

hayir., rakam, sayi, numara, miktar 

DR (Doctor), Prof (Professor), IST (Istanbul) 

Instead of entering each address element in separate fields, you may enter the entire address in the 

AddressLine1 input field. 

For all countries except Japan, you can enter addresses in one or more of these single-line formats. 

User's Guide 


395


396 

Note: 

Not all formats work for all countries. 

StreetAddress;PostalCode;City 

StreetAddress;City;PostalCode 

StreetAddress;PostalCode 

StreetAddress;City 

StreetAddress,PostalCode,City,StateProvince 

StreetAddress,PostalCode,City,County,StateProvince 

StreetAddress;City;StateProvince;PostalCode 

Note: 

Australia addresses must be in this format. You must include either a city plus state/province or 

a postal code as the last address element. 

StreetAddress;City;StateProvince 

StreetAddress;City;County;PostalCode 

StreetAddress;County;City 

StreetAddress;County 

StreetAddress,City,PostalCode,StateProvince 

PostalCode,City,StateProvince,StreetAddress 

PostalCode;City;StreetAddress 

PostalCode;StreetAddress 

PostalCode;StreetAddress;City 

PostalCode;City 

City;StreetAddress 

City;PostalCode;StreetAddress 

City,StateProvince,StreetAddress 

City,PostalCode,StateProvince,StreetAddress 

City;StreetAddress;Locality 

StreetAddress;Locality 

StreetAddress;Locality;City 

StreetAddress;Locality;City;PostalCode 

Note: 

U.K. addresses must be in this format. You must include either a city plus state/province or a 

postal code as the last address element. 

StreetAddress;City;Locality 

Where: 


• StreetAddress can be house number and street name in either order (with street type immediately 

before or after the street name). 

• City is the town. For Thailand, this is the subdistrict. 

• Locality is the locality name. 

• County is the county name. For Thailand, this is the district. 

• StateProvince is the postal abbreviation for the state or province. 

• PostalCode is the complete postcode. For Brazil, PostalCode should be the complete eight-digit 

postcode for the most accurate results. However, you can use a five-digit postcode. 

The matching accuracy for single line input is comparable to that of structured address input. The performance 

of single line input addresses may be slightly slower than that of structured address input. 

For best results, use delimiters (comma, semicolon, or colon) between each component of the address. 

For example, 

26 Wellington Street East;Toronto;ON;M5E 1S2 

schulstrasse 22,Dresden,01328 

Urión 30,Col. Tlatilco,02860,Mexico,D.F. 

If the input address is missing delimiters, spaces are recognized as separators and internal parsing rules 

identify address components. In the example above, the address would still successfully geocode even 

if some or all of the delimiters were missing in the input. 

Note: Non-delimited or partially-delimited single line addresses may take longer to geocode and may 

not produce the same results as delimited single line input. This is especially true for addresses 

with multi-word street names or cities. To optimize single line geocoding, use delimiters between 

address components (particularly between street name and city). 

Punctuation is ignored for geocoding purposes. 

Format for Japan 

Japanese addresses are typically written in single line format, without any delimiters to separate address 

fields. The typical format is: 

 

where: 

• prefecture = ken 

• city = shi 

• municipality subdivision = oaza 

• city district = chome 

• block = numbered city block (ban) 

• lot = sub blocks or building number (go) 

• other = building names, flat numbers, or other identifiers. This information is ignored by the Japan 

geocoder. 

Note: 

User's Guide 


Block and lot numbers are the most specific address elements in Japan. Japanese addresses 

typically do not have street names. 

397


Table 73: Example Japanese Addresses 

Address 

Guidelines for Single Line Input 

Description 

Chome, block, and lot separated by a hyphens. 

Block and lot separated by hyphen, chome indicated 

by chome identifier. 

Chome, block, and lot separated by their identifiers. 

• For Germany, France, and New Zealand, you must specify a value in either the PostalCode field or 

the City field in order for single line input to successfully geocode. 

• For Canada, if you omit the postal code and country, the geocoder still geocodes the address based 

on street address, city, and province. 

• The country is not required. Each country geocoder assumes that the address is in its country. 

• Firm information (placename, building name, or government building) is returned if available. 

Street Intersection Input 

If you enter a street intersection as input, the geocoder will provide the coordinates of the intersection. 

Note: 

Intersection geocoding is not available for the United Kingdom (GBR). 

To enter an intersection, specify the two street names separated by a double ampersand (&&) in Address- 

Line1. For example: 

AddressLine1: Ocean Ave && New South Head Rd 

City: Woollahra 

AddressLine1: AVENIDA VINTE E OITO DE MARÇO && AVENIDA JOSÉ ALVES AZEVEDO 


AddressLine1: Chemin du Prieuré && Rue de la Montcient 

City: Seraincourt 

Note: 

Options 

398 

Do not use /, _, -, or any other separator. Intersections must be delimited using a double ampersand 

(&&) as a separator. 

All close match criteria are enforced for intersection geocoding, just as for any street level geocoding. 

Geocode Address Global allows you to set default processing options through the Management Console. 

You can override certain settings for individual calls to Geocode Address Global using the API or MapInfo 

Spatial Server client tools, such as Enterprise Designer. 





User's Guide 

Option Name 

Geocode level 




following: 


Postal 

centroid 

Geographic 

centroid 





shape path. 





























segment. 

399


400 

Option Name 













Units field. 

Note: 


(JPN). 











(ZAF). 















User's Guide 

Option Name 









Note: 


(JPN). 












(ZAF). 


points. 

401


402 

Option Name 

Units 

Point type 




Note: 

• Feet 

• Miles 

• Meters 



(JPN). 








database. 


Parcel 

Street 

frontage 










Option Name 






















EPSG:4230 

EPSG:4283 

EPSG:4301 

EPSG:4326 

EPSG:27200 

EPSG:27700 






Matching options let you set match restrictions, fallback, and multiple match settings so that the matching 

can be as strict or relaxed as you need. The strictest matching conditions require an exact match on 

house number, street name, postal code and no fallback to postal code centroids. The geocoder looks 

for an exact street address match within the postal code in the input address. Relaxing the conditions 

broadens the area in which it searches for a match. For example, by relaxing the postal code, the geocoder 

searches for candidates outside the postal code but within the city of your input address. 

For guidelines on how to balance match rate and precision, see Balancing Match Rate and Precision 

on page 298. 

User's Guide 


403


404 


Option Name 


Expand candidates 


Match mode 

All input 







This option applies to U.K. addresses only. 

Specifies whether to return multiple close matches (one for each delivery 

point on the street). By default, if a street has multiple addresses/delivery 

points, Geocode Address GBR returns a single close match, with each 

individual delivery point available as a range. 








Specifies how to determine whether a candidate is a close match. One 


Custom 

Exact 

Close 

Relaxed 

This option allows you to specify which parts of a candidate 

address must match the input address to be considered 

a close match. Use the Close match criteria 

check boxes to specify the address elements you want. 

This is the default value for most countries. 

All address elements must match. 

Only the house number must match. For China, Estonia, 

India, Latvia, Lithuania, Slovenia, and South Africa, only 

the street name and town must match. 

All candidates are considered close. This is the default 

value for Japan. 

Specifies whether candidates must match all non-blank input fields to 

be considered a close match. For example, if an input address contains 

a city and postal code, then candidates for this address must match the 

city and postal code to be considered a close match. 


Option Name 

House number 

Street 

Locality 

User's Guide 


Specifies whether candidates must match the house number to be 


This option is not used for China, India, and Japan. 

If you select this option you should also require an exact match on street 

name. This option does not significantly affect performance. It does, 

however, affect the type of match if the candidate address corresponds 

to a segment that does not contain any ranges. The type of match can 

also be affected when the house number range for a candidate does 

not contain the input house number. 

Specifies whether candidates must match the street name to be considered 


This option is not used for Japan. 

If a close match is found, the geocoder attempts expanded street name 

manipulation, which looks for candidates with names that sound like the 

input address or that are spelled improperly. For example, "Muller 

Strasse" for "Mueller Strasse". This slows down performance but increases 

the match rate . If the geocoding database is indexed, the performance 

impact is reduced. 

Specifies whether candidates must match the locality to be considered 


If you do not require exact matches on locality, the geocoder searches 

on the street address matched to the particular postal code, and considers 

other localities that do not match the name, but do match the 

postal code. 


• Not used—Australia (AUS), Austria (AUT), Belgium and Luxembourg 

(BEL), Germany (DEU), Denmark (DNK), Spain (ESP), Estonia (EST), 

Finland (FIN), France (FRA), Italy (ITA), Lithuania (LTU), Malaysia 

(MYS), The Netherlands (NLD), Norway (NOR), Portugal (PRT), 

Slovenia (SVN), Sweden (SWE), Thailand (THA) 

• Locality—Brazil (BRA), Switzerland (CHE), China (CHN), Czech 

Republic (CZE), The United Kingdom (GBR), Hungary (HUN), India 

(IND), Ireland (IRL), Latvia (LVA), Mexico (MEX), Singapore (SGP), 

Turkey (TUR), South Africa (ZAF) 

• Dissemination Area and Enumeration Area (DA and EA)—Canada 

(CAN) 

• Suburb—New Zealand (NZL) 

• Minor town, village, or locality—Poland (POL) 

• Neighborhood or barrio—Argentina (ARG) 


405


406 

Option Name 

City 

County 


• City district (chome)—Japan (JPN) 

This option is not available if you select Geographic cenroid on the 

Geocoding tab. 

Specifies whether candidates must match the city to be considered a 

close match. For Japan, this field specifies whether the candidate must 

match the municipality subdivision (oaza). If you do not require exact 

matches on city, the geocoder searches on the street address matched 

to the particular postal code, and considers other cities that do not match 

the name, but do match the postal code. 

For Argentina, the city name is not always available in the source data. 

In those cases, the department (County field) is used for matching purposes 

and the department is returned in the City output field. Candidates 

matched in this manner are considered close matches. 

Specifies whether candidates must match the county to be considered 

a close match. The meaning of county varies by country: 


• AUS (Australia)—Local Government Authority (LGA) 







• CZE (Czech Republic)—District 







• GBR (Great Britain)—County 

• HUN (Hungary)—Not used 

• IND (India)—Not used 





• LVA (Latvia)—County 


User's Guide 

Option Name 



• MEX (Mexico)—Not used 


• NZL (New Zealand)—Not used 

• NLD (The Netherland)—Province 

• NOR (Norway)—Fylke 








• ZAF (South Africa—District 

Specifies whether candidates must match the state or province to be 


The meaning of state/province varies by country: 

• ARG (Argentina)—Province or region 








• CZE (Czech Republic)—Region 



• ESP (Spain)—Not used 









• JPN (Japan)—Not used 

• LTU(Lithuania)—Not used 


407


408 

Option Name 

Postal code 

Candidate must have LDU 

Postal district 

First two postal code digits 


• LVA (Latvia)—Not used 








• SGP (Singapore)—Region 


• SWE (Sweden)—Lan 



• ZAF (South Africa)—Not used 

Specifies whether candidates must match the postal code to be considered 

a close match. If you do not require exact match on postal codes, 

the geocoder searches a wider area for a match. While this results in 

slower performance, the match rate is higher because the request does 

not need to match exactly when it compares match candidates. 

This option is not available for Argentina, Japan, and South Africa. 

This option applies only to Canadian addresses. 

Specifies whether a candidate address must have a full postal code 

(FSA and LDU) to be considered a close match. 

Canadian postal codes are divided into two sections: the Forward 

Sortation Area (FSA) and the Local Delivery Unit (LDU). For example, 

the postal code M6H 2P8 has an FSA of M6H and an LDU of 2P8. Some 

candidate addresses may contain only the FSA. This option allows you 

to prevent such addresses from being classified a close match. 

This option applies only to U.K. addresses. 

Specifies whether the postal district portion of the postcode must match 

in order for the match to be considered a close match. 

UK postcodes are divided into two sections: the outward code, which 

is to the left of the space, and the inward code, which is to the right. The 

outward code represents the postal district. For example, in the postcode 

CB3 OHH, the postal district is CB3, which is Cambridge. 

This option applies only to Spanish addresses. 


Option Name 


Specifies whether the first two digits of the postcode must match in order 

for the match to be considered a close match. 

Return point of interest This option applies only to Indian addresses. 

matches with street matches 

Specifies whether to return both point of interest (POI) matches and 

street matches when both street and POI information are provided in 

the input. If you select this option, POI information is returned with candidates 

that matched on street name. If you do not select this option, 

only street information is returned. 

Prefer point of interest 

matches 

Data Options 

This option applies only to Indian addresses. 

If you enable the Return point of interest matches with street 

matches option, the default behavior is to list the street name matches 

first in the list of candidates (in other words, preferring the street 

matches). However you can choose to return POI candidates first using 

this option. Consider the following example: 

FirmName: India Gate 

AddressLine1: Lodi Road 

City: Delhi 

If POIs are returned and street names preferred (the default settings), 

the following candidates are returned in the order listed. Note that the 

street name candidates are at the top with the India Gate POI candidate 

(S8 result code) listed last. If POIs were preferred over street candidates, 

the India Gate candidate would be listed first. 

Street- 

Name 

Lodi Road 

Lodi Road 

Lodi road 

Firm- 

Name 

India Gate 

PostalCode 

100003 

100013 

100013 

Locality 

Lodi 

Colony 

Nizamuddin 

West 

India Gate 

City 

Delhi 

Delhi 

Delhi 

Result- 

Code 

S4- 

PNTSC-A 

S4- 

PNTSC-A 

S8H----C- 

A 


and geocode data necessary to determine the geocode for a given address. There are two kinds of 

databases: standard databases and custom databases. Standard databases are those supplied by Pitney 

Bowes Business Insight and based on address and geocoding data from postal authorities and suppliers 

User's Guide 


409


410 

of geographical data. Custom databases are databases you create to enhance or augment standard 

databases for your particular needs. For more information on custom databases, see What Is a Custom 

Database? on page 582. 

For Australian geocoding, to achieve the best geocoding spatial precision use the G-NAF database. This 

provides point-level geocoding that places points within the land parcel boundary for a given address. 

The G-NAF database requires an additional license. Contact your sales representative for more information. 

The following table lists the options available for specifying which databases to use and the search order 

of databases. 


Option Name 

Database 

Database preference 


Specifies the database to be used for geocoding. Only databases that 

have been defined in the Databases Resources panel in the Management 

Console are available. 

Specifies which geocoding databases to use. One of the following: 

Prefer custom database 

Prefer standard database 

Use custom databases 

only 

Use standard databases 

only 

Use both custom and 

standard databases 

Note: 



from custom databases. Use this option if you 

feel your custom database is superior to the 

standard database. 



from standard databases. 

Use only custom databases. Ignore standard 

databases. 

Use only standard databases. Ignore custom 

databases. 


databases. In cases where candidates are 

returned from both, the standard database is 

preferred. Default. 

This option is not available for Great Britain (GBR) because the 

GBR geocoder does not support custom databases. 

The results from a custom database have a "U" at the end of the result 

code. Results from an address database have an "A" at the end of the 

match score. For example: S5HPNTSCZA is a match score that comes 

from an address database, while S5HPNTSCZU comes from a custom 

database. For more information, see Introduction on page 577. 


Option Name 


search list 


Output Data Options 
















geocoder. 





248. 












street level. 

The following table lists the options that control which data is returned in the output. 

User's Guide 


411


Output 

412 

Table 77: Output Data Options 

Option Name 

Return only similar firm names 


This option applies to the U.K. only. 

Specifies whether to return firm names only when the input firm name 

is similar to the firm name in the geocoding database. For example, if 

the input firm name is "Group 1 Software" but the geocoding database 

returns "Pitney Bowes Software, Inc.", these two firm names are not 

similar. In most cases the input firm name must match the firm name in 

the database exactly. Some differences in abbreviations are considered 

similar enough to result in the firm name being returned. 

Y 

N 

Yes, return only firm names that are similar to the input firm 

name. 

No, return firm names regardless of whether they are close 

to the input firm name. Default. 

The geocoder returns the latitude/longitude, standardized address, and result indicators. Result indicators 

describe how well the geocoder matched the input address to a known address and assigned a location; 

they also describe the overall status of a match attempt. If you are using the API, t T he output returned 

is in the DataTable class. For information on the DataTable class, see the "API Fundamentals" section 

of the MapInfo Spatial Server API Guide . 


The address may be identical to the input address if the input address was accurate, or it may be a 

standardized version of the input address, or it may be a candidate address when multiple matches are 

found. 


Field Name 

AddressLine1 

AddressLine2 



Description 




Unit number. 


Field Name 

City 

Country 

County 

User's Guide 

Description 








ITA. 

AND (Andorra)—Addresses from Andorra contain ESP (Spain) in the 


GIB (Gibraltar)—Addresses from Gibraltar contain ESP (Spain) in the 


MCO (Monaco)—Addresses from Monaco contain FRA (France) in the 


SMR (San Marino)—Addresses from San Marino contain ITA (Italy) in 


VAT (Vatican City)—Addresses from Vatican City contain ITA (Italy) 






















413


414 

Field Name 

FirmName 

HouseNumber 




Description 































both. 

E 

O 

Even 

Odd 


Field Name 

LastLine 


Locality 

User's Guide 

Description 

B 

U 

Both 

Unknown 











EA) 

























415


416 

Field Name 



PostalCode 


PreAddress 


Description 














0 

1 









0 

1 






country. 






Field Name 

User's Guide 

SegmentCode 

SegmentParity 

StateProvince 

Description 




L 

R 

B 

U 




Undetermined 































417


418 

Field Name 


StreetName 

StreetPrefix 

StreetSuffix 



UnitNumberLow 

Description 





























Table 79: Geocode Output 

Field Name 

CoordinateSystem 

Latitude 

Longitude 

Result Codes 

Description 

The coordinate system used to determine the latitude and longitude 

coordinates. A coordinate system specifies a map projection, coordinate 

units, etc. An example is EPSG:4326. EPSG stands for European Petroleum 

Survey Group. 

Seven-digit number in degrees and calculated to four decimal places 

(in the format specified). 






Field Name 


IsCloseMatch 


Status 

User's Guide 

Description 






Y 

N 









419


420 

Field Name 

Status.Code 



Description 

null 

F 

Success 

Failure 


reason. 















System Error. 


Found. 


Found. 








0 

1 

2 

3 

4 


address. 






Field Name 

Country-Specific Output 

Description 

5 

6 

7 

8 

9 

10 

11 

12 

13 

14 

15 

16 

17 


Intersection. 











The following topics describe output that's unique to specific countries. 

Australia G-NAF Database Output 








Field Name 

User's Guide 


Description 





 





421


422 

Field Name 




Description 

-1 







NAF dataset. 























0 

1 

2 

3 

No geocode. 






geocode). 


Field Name 

User's Guide 

AUS.GNAF_PID 


Description 

4 

5 

6 

7 













PID is: 

GAVIC411711441 









1 

2 

3 


















423


424 

Field Name 


Canada-Specific Output 

Description 

The following table lists output fields that are unique to Canada. 

Table 82: Canada-Specific Output 

Field Name 

CAN.Census_CD 

CAN.Census_CMA 

4 

5 

6 
























Description 

The Census Division (CD) in which the address is 


Division definition available on the Statistics 


The Census Metropolitan Area (CMA) in which the 

address is located. For more information, see the 


Field Name 

CAN.Census_CSD 

CAN.Census_CT 

CAN.Census_DA 

New Zealand Output 

Description 

The following table lists output fields that are unique to New Zealand. 

Table 83: New Zealand-Specific Output 

Field Name 

NZL.NZL_MESHBLOCK_ID 

NZL.ALIASED_SUBURB 

Geocode Address World 

Census Metropolitan Area definition on the 

Statistics Canada website. 

The Census Subdivision (CSD) in which the address 

is located. For more information, see the 

Census Subdivision definition on the Statistics 


The Census Tract (CT) in which the address is 


Tract definition on the Statistics Canada website. 

The Dissemination Area (DA) in which the address 

is located. For more information, see the Dissemination 

Area definition available on the Statistics 


Description 


which statistical data is collected by Statistics New 

Zealand. Meshblocks vary in size from part of a 

city block to large areas of rural land. 

An alternative to the officially-recognized suburb 

name. 

The Geocode Address World component takes an address located in any of the supported countries 

and returns the city centroid or, for some countries, postal centroid. Geocode Address World can geocode 

to the city centroid level, and for some counties the postal centroid level. It cannot geocode to the street 

address level. If you require address-level geocoding, use Geocode Address Global. 

User's Guide 


425


Input 

426 

The Geocode Address World component is an optional part of the Enterprise Geocoding Module. For 

more information about Enterprise Geocoding Module, including a listing of other components included 

with it, see What is the Enterprise Geocoding Module? on page 290. 

Geocode Address World takes an address as input. To obtain the best performance and the most possible 

matches, your input address lists should be as complete as possible, free of misspellings and incomplete 

addresses, and as close to postal authority standards as possible. Most postal authorities have websites 

that contain information about address standards for their particular country. 

Note: 

You must include the country code in the input. 

Input Fields 

The following table provides information on the format and layout of Geocode Address World input. 

Note: 

If you are using the API, you specify input using the DataTable class. The fields described below 

are the valid column names in the DataTable class. For information on the DataTable class, see 

the "API Fundamentals" section of the MapInfo Spatial Server API Guide. 

Table 84: Geocode Address World Input Data 

Field Name 

AddressLine1 

AddressLine2 

City 

County 

Format 

String 

String 

String 

String 


The first address line. For example, 4360 DUKES RD: 

4360 DUKES RD KALGOORLIE WA 6430 

The second address line of a two-line address. For example, 

Level 6 51 Jacobson St: 

26 WELLINGTON ST E SUITE 500 TORONTO ON M5E 1S2 

This field is not used in Australia, Austria, Belgium, Brazil, 

Denmark, Finland, France, Germany, Ireland, Italy, Liechtenstein, 

Luxembourg, Malaysia, The Netherlands, Poland, Portugal, 

Spain, Sweden, Switzerland, and Thailand. 

The city or town name. Your input address should use the 

official city name. This will produce the best geocoding results. 


The name of one of the following depending on the country: 

• Not used—AUT, BRA, CAN, FIN, GBR, MYS, PRT, SGP. 

• Department—FRA 

• District (amphoe)—THA 


Field Name 

FirmName 

LastLine 

Locality 

PostalCode 

User's Guide 

StateProvince 

Format 

String 

String 

String 

String 

String 


• District (fylke/counties)—NOR 

• District (poviat)—POL 

• Kommun—SWE 

• Kreis—DEU 

• Local Government Authority (LGA)—AUS 

• Province—BEL, CHE, DNK, ESP, IRL, ITA, LIE, LUX, NLD 

• Region—NZL 

Company or name or place name. For example, PITNEY 

BOWES. 

PITNEY BOWES 4360 DUKES RD KALGOORLIE WA 6430 

The last line of the address. For example, KALGOORLIE WA 

6430: 

4360 DUKES RD KALGOORLIE WA 6430 


• Not used—AUS, AUT, BEL, CHE, DEU, DNK, FIN, FRA, 

IRL, LIE, LUX, MYS, NLD, NOR, POL, SGP, SWE, THA 

• Dissemination Area and Enumeration Area (DA and 

EA)—CAN 

• Locality—BRA, GBR, ITA, PRT 

• Suburb—NZL 



• Not used—BEL, CHE, DNK, IRL, LIE, LUX, NLD, NOR, 

SGP 

• Bundesland—DEU 

• Province—CAN 

• Province (changwat)—THA 

• Province (voivodship)—POL 

• Region—AUT, ESP, FRA, GBR, NZL, PRT 

• Region (län)—FIN 

• Region (lan)—SWE 

• State—AUS, BRA 

• State (negeri)—MYS 


427


Field Name 

Country 

Options 

428 

Format 

String 

Recommendations for Address Input 


The two-character ISO country code. This field is required. 

For a list of the ISO codes see Country Names and ISO 

Codes on page 602. 

Follow these suggestions to ensure that your input data is in the best format possible for optimum geocoding. 

• Addresses must contain the country code. 

Geocode Address World allows you to set default processing options through the Management Console. 

You can override certain settings for individual calls to Geocode Address World using the API or MapInfo 

Spatial Server client tools, such as Enterprise Designer. 


Table 85: Geocoding Options on page 428 lists the options that control how a location's coordinates 

are determined. 


Option Name 








One the following: 

EPSG:4283 

EPSG:4326 



Default. 




Option Name 



Data Options 















and geocode data necessary to determine the geocode for a given address. The data is based on address 

and geocoding data from postal authorities and suppliers of geographical data. 

Table 87: Data Options on page 429 lists the options available for specifying which databases to use 

and the search order of databases. 


Option Name 


search list 

User's Guide 




Console under the database resources tools (Modules > Enterprise 

Geocoding > Tools). If you choose to override the default 








automatically reflected by the geocoder. For example, if a database re- 

429


Output 

430 

Option Name 



source is moved from one directory to another and you update the 

database resources accordingly (Modules > Enterprise Geocoding > 

Tools) the database location will be automatically updated in the geocoder. 





248. 


one database, list them in order of preference. The order of the database 

has an effect when there are close match candidates from different 

databases. The close matches that are returned come from the database 

that is first in the search list. Close matches from lower ranked databases 

are demoted to non-close matches. 

Geocode Address World returns the latitude/longitude, city, county, and result indicators. Result indicators 

describe how well the geocoder matched the input to a known location and assigned a latitude/longitude; 

they also describe the overall status of a match attempt. If you are using the API, the output returned is 

in the DataTable class. For information on the DataTable class, see the "API Fundamentals" section of 

the MapInfo Spatial Server API Guide. 



Field Name 

City 

Country 

Description 

Municipality name. 






ITA. 

• AND (Andorra)—Addresses from Andorra contain ESP (Spain) in 



Field Name 

County 

PostalCode 

User's Guide 

StateProvince 

Description 

• GIB (Gibraltar)—Addresses from Gibraltar contain ESP (Spain) in 


• MCO (Monaco)—Addresses from Monaco contain FRA (France) in 


• SMR (San Marino)—Addresses from San Marino contain ITA (Italy) 


• VAT (Vatican City)—Addresses from Vatican City contain ITA (Italy) 


This field contains an area that is smaller than a state/province but larger 

than a city. The specific area varies by country: 

• AUS—Local Government Authority (LGA) 

• AUT—Province 

• BEL—Province 

• BRA—Not used 

• CAN—Not used 

• CHE—Province 

• DEU—Kreis 

• DNK—Province 

• FIN—Province (kommune) 

• FRA—Department 

• GBR—County 

• ITA—Province 

• LIE—Province 

• LUX—Province 

• MYS—District (daerah) 

• NLD—Province 

• NZL—Not used 

• POL—District (poviat) 

• PRT—Not used 

• SGP—District 

• SWE—Region (kommun) 

• THA—District (amphoe) 


country. 


• AUS—State 

• AUT—Region 


431


432 

Field Name 




Field Name 


Description 

• BEL—Not used 

• BRA—State 

• CAN—Province 

• CHE—State 

• DEU—Bundesland 

• DNK—Not used 

• ESP—Region 

• FIN—Region (län) 

• FRA—Region 

• GBR—Region 

• IRL—Not used 

• ITA—Region 

• LIE—State 

• LUX—Not used 

• MYS—State (negeri) 

• NLD—Not used 

• NOR—Not used 

• NZL—Region 

• POL—Province (voivodship) 

• PRT—Region 

• SGP—Not used 

• SWE—Region (lan) 

• THA—Province (changwat) 







Description 




Field Name 

Latitude 

Longitude 

Result Codes 

Description 


Survey Group. 








Field Name 


IsCloseMatch 


Status 

Status.Code 

User's Guide 

Description 






Y 

N 








null 

F 


Success 

Failure 


reason. 

433


434 

Field Name 



Description 















System Error. 


Found. 


Found. 








0 

1 

2 

3 

4 

5 

6 

7 

8 

9 


address. 






Intersection. 





Field Name 

Fallback Behavior 

Description 

10 

11 

12 

13 

14 

15 

16 

17 










Geocode Address World automatically provides the best geocode possible based on the data you provide 

on input. If you provide a city and valid postal code, you will receive a postal code centroid. If you provide 

a city and an invalid postal code, or a city and no postal code, Geocode Address World will automatically 

fall back to the geographic centroid, providing the centroid for the city. The postal code returned in this 

case will be the postal code of the city centroid. 

Supported Countries 

The countries supported by Geocode Address World and the supported geocode levels for each country 

are listed in the following table. 

Table 91: Countries Supported by Geocode Address World 

Country Name 

Afghanistan 

Albania 

Algeria 

American Samoa 

Andorra 

Angola 

User's Guide 

Country Code 

AFG 

ALB 

DZA 

ASM 

AND 

AGO 

City Level 

yes 

yes 

yes 

yes 

yes 

yes 


Postal Level 

yes 

yes 

yes 

435


436 

Country Name 

Anguilla 

Antarctica 

Antigua and Barbuda 

Argentina 

Armenia 

Aruba 

Australia 

Austria 

Azerbaijan 

Bahamas 

Bahrain 

Bangladesh 

Barbados 

Belarus 

Belgium 

Belize 

Benin 

Bermuda 

Bhutan 

Bolivia 

Bosnia and Herzegovina 

Country Code 

AIA 

ATA 

ATG 

ARG 

ARM 

ABW 

AUS 

AUT 

AZE 

BHS 

BHR 

BGD 

BRB 

BLR 

BEL 

BLZ 

BEN 

BMU 

BTN 

BOL 

BIH 

City Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

Postal Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 


Country Name 

Botswana 

Brazil 

British Indian Ocean 

Territory 

Brunei Darussalam 

Bulgaria 

Burkina Faso 

Burundi 

Cambodia 

Cameroon 

Canada 

Cape Verde 

Cayman Islands 

Central African Republic 

Chad 

Chile 

China 

Christmas Island 

Cocos (Keeling) Islands 

Colombia 

Comoros 

User's Guide 

Country Code 

BWA 

BRA 

IOT 

BRN 

BGR 

BFA 

BDI 

KHM 

CMR 

CAN 

CPV 

CYM 

CAF 

TCD 

CHL 

CHN 

CXR 

CCK 

COL 

COM 

City Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 


Postal Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

437


438 

Country Name 

Congo 

Congo, the Democratic 

Republic of the 

Cook Islands 

Costa Rica 

Côte d'Ivoire 

Croatia 

Cuba 

Cyprus 

Czech Republic 

Denmark 

Djibouti 

Dominica 

Dominican Republic 

Ecuador 

Egypt 

El Salvador 

Equatorial Guinea 

Eritrea 

Estonia 

Ethiopia 

Country Code 

COG 

COD 

COK 

CRI 

CIV 

HRV 

CUB 

CYP 

CZE 

DNK 

DJI 

DMA 

DOM 

ECU 

EGY 

SLV 

GNQ 

ERI 

EST 

ETH 

City Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

Postal Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 


Country Name 

Falkland Islands (Malvinas) 

Faroe Islands 

Fiji 

Finland 

France 

French Guiana 

French Polynesia 

French Southern Territories 

Gabon 

Gambia 

Georgia 

Germany 

Ghana 

Gibraltar 

Greece 

Greenland 

Grenada 

Guadeloupe 

Guam 

Guatemala 

User's Guide 

Country Code 

FLK 

FRO 

FJI 

FIN 

FRA 

GUF 

PYF 

ATF 

GAB 

GMB 

GEO 

DEU 

GHA 

GIB 

GRC 

GRL 

GRD 

GLP 

GUM 

GTM 

City Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 


Postal Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

439


440 

Country Name 

Guernsey 

Guinea 

Guinea-Bissau 

Guyana 

Haiti 

Heard Island and McDonald 

Islands 

Holy See (Vatican City 

State) 

Honduras 

Hong Kong 

Hungary 

Iceland 

India 

Indonesia 

Iran, Islamic Republic of 

Iraq 

Ireland 

Isle of Man 

Israel 

Italy 

Jamaica 

Country Code 

GGY 

GIN 

GNB 

GUY 

HTI 

HMD 

VAT 

HND 

HKG 

HUN 

ISL 

IND 

IDN 

IRN 

IRQ 

IRL 

IMN 

ISR 

ITA 

JAM 

City Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

Postal Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 


Country Name 

Japan 

Jersey 

Jordan 

Kazakhstan 

Kenya 

Kiribati 

Korea, Democratic 

People's Republic of 

Korea, Republic of 

Kuwait 

Kyrgyzstan 

Lao People's Democratic 

Republic 

Latvia 

Lebanon 

Lesotho 

Liberia 

Libyan Arab Jamahiriya 

Liechtenstein 

Lithuania 

Luxembourg 

Macao 

User's Guide 

Country Code 

JPN 

JEY 

JOR 

KAZ 

KEN 

KIR 

PRK 

KOR 

KWT 

KGZ 

LAO 

LVA 

LBN 

LSO 

LBR 

LBY 

LIE 

LTU 

LUX 

MAC 

City Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 


Postal Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

441


442 

Country Name 

Macedonia, the former 

Yugoslav Republic of 

Madagascar 

Malawi 

Malaysia 

Maldives 

Mali 

Malta 

Marshall Islands 

Martinique 

Mauritania 

Mauritius 

Mayotte 

Mexico 

Micronesia, Federated 

States of 

Moldova, Republic of 

Monaco 

Mongolia 

Montserrat 

Morocco 

Mozambique 

Country Code 

MKD 

MDG 

MWI 

MYS 

MDV 

MLI 

MLT 

MHL 

MTQ 

MRT 

MUS 

MYT 

MEX 

FSM 

MDA 

MCO 

MNG 

MSR 

MAR 

MOZ 

City Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

Postal Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 


Country Name 

Myanmar 

Namibia 

Nauru 

Nepal 

Netherlands 

Netherlands Antilles 

New Caledonia 

New Zealand 

Nicaragua 

Niger 

Nigeria 

Niue 

Norfolk Island 

Northern Mariana Islands 

Norway 

Oman 

Pakistan 

Palau 

Palestinian Territory, 

Occupied 

Panama 

User's Guide 

Country Code 

MMR 

NAM 

NRU 

NPL 

NLD 

ANT 

NCL 

NZL 

NIC 

NER 

NGA 

NIU 

NFK 

MNP 

NOR 

OMN 

PAK 

PLW 

PSE 

PAN 

City Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 


Postal Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

443


444 

Country Name 

Papua New Guinea 

Paraguay 

Peru 

Philippines 

Pitcairn 

Poland 

Portugal 

Puerto Rico 

Qatar 

Réunion 

Romania 

Russian Federation 

Rwanda 

Saint Helena 

Saint Kitts and Nevis 

Saint Lucia 

Saint Pierre and 

Miquelon 

Saint Vincent and the 

Grenadines 

Samoa 

San Marino 

Country Code 

PNG 

PRY 

PER 

PHL 

PCN 

POL 

PRT 

PRI 

QAT 

REU 

ROU 

RUS 

RWA 

SHN 

KNA 

LCA 

SPM 

VCT 

WSM 

SMR 

City Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

Postal Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 


Country Name 

Sao Tome and Principe 

Saudi Arabia 

Senegal 

Serbia and Montenegro 

Seychelles 

Sierra Leone 

Singapore 

Slovakia 

Slovenia 

Solomon Islands 

Somalia 

South Africa 

South Georgia and the 

South Sandwich Islands 

Spain 

Sri Lanka 

Sudan 

Suriname 

Swaziland 

Sweden 

Switzerland 

User's Guide 

Country Code 

STP 

SAU 

SEN 

SCG 

SYC 

SLE 

SGP 

SVK 

SVN 

SLB 

SOM 

ZAF 

SGS 

ESP 

LKA 

SDN 

SUR 

SWZ 

SWE 

CHE 

City Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 


Postal Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

445


446 

Country Name 

Syrian Arab Republic 

Taiwan, Province of 

China 

Tajikistan 

Tanzania, United Republic 

of 

Thailand 

Timor-Leste 

Togo 

Tokelau 

Tonga 

Trinidad and Tobago 

Tunisia 

Turkey 

Turkmenistan 

Turks and Caicos Islands 

Tuvalu 

Uganda 

Ukraine 

United Arab Emirates 

United Kingdom 

Country Code 

SYR 

TWN 

TJK 

TZA 

THA 

TLS 

TGO 

TKL 

TON 

TTO 

TUN 

TUR 

TKM 

TCA 

TUV 

UGA 

UKR 

ARE 

GBR 

City Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

Postal Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 


Country Name 

United States 

United States Minor 

Outlying Islands 

Uruguay 

Uzbekistan 

Vanuatu 

Venezuela 

Viet Nam 

Virgin Islands, British 

Virgin Islands, U.S. 

Wake Island 

Wallis and Futuna 

Western Sahara 

Yemen 

Zambia 

Zimbabwe 

Country Code 

USA 

UMI 

URY 

UZB 

VUT 

VEN 

VNM 

VGB 

VIR 

WAK 

WLF 

ESH 

YEM 

ZMB 

ZWE 

Geocode US Address 

City Level 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

Postal Level 

Geocode US Address takes an address and returns latitude/longitude coordinates. Geocode US Address 

also standardizes and validates addresses using data from the U.S. Postal Service. 

Geocode US Address can also geocode intersections. Instead of entering a mailing address, you can 

enter and intersection such as "Pearl St. and 28th" and obtain the coordinates of the intersection. 

User's Guide 

yes 

yes 

yes 


yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

yes 

447


Input 

448 

Geocode US Address is part of the Enterprise Geocoding Module. For more information on the Enterprise 

Geocoding Module, including a listing of other components included with it, see What is the Enterprise 

Geocoding Module? on page 290. 

Geocode US Address takes an address as input. To obtain the best performance with Geocode US 

Address and the most possible matches, your input address should be as complete as possible and free 

of misspellings and incomplete information. Input addresses should be as close to USPS standards as 

possible for the highest match rate. For information on USPS standards, see the USPS website http://www.usps.com 

. 

Input addresses should contain a street address line and a lastline, or a single line with both address 

and lastline elements. This helps Geocode US Address accurately identify an area in which to search 

for a match candidate, based on the city, state, and ZIP Code. 

Geocode US Address also accepts a street address line with individual city, state, and ZIP Code lines 

instead of a last line. You should only use this type of input if you are confident that the input address is 

free of misspellings and incomplete information. 

If you are using Geocode US Address for address standardization, input addresses must have at least 

a street name, and either a city and state or a ZIP Code to obtain a match. If you are using Geocode 

US Address to obtain geocoding information, input addresses only need to contain a ZIP + 4 Code to 

receive geocoding information. 

The following table provides information on the format and layout of Geocode US Address input. 

Note: 




Table 92: Geocode US Address Input Data 

Field Name 

AddressLine1 

AddressLine2 

Format 

String 

String 


The first address line or a street intersection. 

To specify a street intersection, use and, &, at, or @. For example, 

PEARL & 28th. Geocode US Address does not match 

intersections when processing in CASS mode. 

You may enter an address range instead of an individual address 

number. For example, 10-12 FRONT ST. For additional 

information, see Address Range Matching on page 451. 

The second address line or a street intersection. 

To specify a street intersection, use and, &, at, or @. For example, 

PEARL & 28th.L Geocode US Address does not match 

intersections when processing in CASS mode. 


Field Name 

AddressLine3 

AddressLine4 

AddressLine5 

AddressLine6 

City 

FirmName 

LastLine 

PostalCode 

StateProvince 

Format 

String 

String 

String 

String 

String 

String 

String 

String 

String 


Third address line. 

Fourth address line. 

Fifth address line. 

Sixth address line. 

The name of the municipality, such as a city or town. 

Note: If there is any data in the input fields AddressLine3, 

AddressLine4, AddressLine5, or AddressLine6, Geocode 

US Address will ignore data in the City input 

field. 

The name of a business. Geocode US Address attempts to 

match the input firm name to the recognized firm names in 

the USPS data for a higher quality match. If the firm name is 

not in the USPS data, Geocode US Address ignores the firm 

name when matching and returns the firm name with the 

output. 

The last line of an address containing the city, state, and ZIP 

Code. 

The 5-digit ZIP Code or the 9-digit ZIP + 4 code. 



US Address will ignore data in the PostalCode 

input field. 

The name or abbreviation of the state. 

How Geocode US Address Processes Addresses 

Geocode US Address processes addresses in the following order: 

User's Guide 




US Address will ignore data in the StateProvince 

input field. 

449


450 

1. Parses the address elements. 

Geocode US Address parses input address data into single elements. Parsing occurs on data in the 

order in which you load the data. Even if a valid address is missing an element, Geocode US Address 

can find a match. Some elements, such as predirectionals, may not be critical elements of some 

addresses. By comparing an address as input against all known addresses in a search area, Geocode 

US Address can usually determine if any of these elements are missing or incorrect. 

2. Finds possible matches within the search area. 

Geocode US Address uses the last line elements of an address to determine a search area. You 

can specify if you want the search area based on a finance area or on an area defined by the city, 

state, and ZIP Code. (A Finance Area is a collection of ZIP Codes within a contiguous geographic 

region.) If the city and state are not in the ZIP Code, Geocode US Address performs separate searches 

for the ZIP Code and city. 

After Geocode US Address has determined the search area, it tries to match the elements from the 

street address line to the records in the standardized data files and does the following: 

• Checks input address ranges for missing or misplaced hyphens, and alpha-numeric ranges for 

proper sequence. 

• Searches for any misspellings and standard abbreviations. For example, the Geocode US Address 

can recognize Mane for Main and KC for Kansas City. 

• Searches for any alias matches to the USPS and Spatial data (TIGER and GDT). For example, 

Geocode US Address recognizes that in Boulder, CO Highway 36 is know as 28th Street. 

• Searches for any USPS recognized firm names for additional match verification. 

• Searches for street intersection matches. Matching to an intersection is extremely useful when you 

are using address matching to obtain a geocode. 

• Searches for addresses lines that contain a house number and unit number as the same element. 

For example, Geocode US Address recognizes the input 4750-200 Walnut Street and performs 

recombination to output 4750 WALNUT ST STE 200. 

Note: 

The USPS does not consider intersections valid addresses for postal delivery. Therefore, the 

Geocode US Address does not match intersections when processing in CASS mode. 

3. Scores each possible match against the parsed input. 

Geocode US Address compares each element in the input address to the corresponding element in 

the match candidates, and assigns a confidence level. Geocode US Address weighs the confidence 

level for all of the elements within a match candidate, and assigns a final score to the sum. 

Note: 

Geocode US Address uses a penalty scoring system. If an element does not exactly match 

an element in the match candidate, the Geocode US Address adds a penalty to the score of 

the match candidate. Therefore, scores with lower numbers are better matches. 

4. Determines the match. 

Geocode US Address prioritizes each match candidate based on the assigned confidence score and 

returns as a match the candidate that has the lowest score. 

The match mode you choose determines the range that Geocode US Address allows for a match. 

Geocode US Address only returns a match if the score of the target address falls within the range 

designated by the selected match mode. 

In some cases, more than one match candidate may have the lowest score. In this instance, Geocode 

US Address cannot determine on its own which record is correct, and returns a status indicating 

multiple matches. 


Note: 

If you have enabled Delivery Point Validation (DPV) processing, Geocode US Address 

automatically attempts to resolve multiple matches using DPV. 

Along with a standardized address, Geocode US Address also returns the following: 

• Geocode—Longitude and latitude for the address 

• Match code—Information about the match of the input address to the reference data 

• Location code—Precision level of a geocode 

• Parity—The side of the street on which the match resides. 

Geocode US Address does not return parity when processing in relaxed mode. For more information 

on Geocode US Address output, see Output on page 464. 

Address Range Matching 

Some business locations are identified by address ranges. For example, a shopping plaza could be addressed 

as 10-12 Front St. This is how business mail is typically addressed to such a business location. 

These address ranges can be geocoded to the interpolated mid-point of the range. 

Address ranges are different from hyphenated (dashed) addresses that occur in some metropolitan 

areas. For example, a hyphenated address in Queens County (New York City) could be 243-20 147 

Ave. This represents a single residence (rather than an address range) and is geocoded as a single 

address. If a hyphenated address returns as an exact match, Geocode US Address does not attempt 

to obtain an address range match. 

Address range matching is not available in Exact or CASS modes, since an address range is not an 

actual, mailable USPS ® address. The following fields are not returned by address range geocoding: 

• ZIP + 4 ® (in multiple segment cases) 

• Delivery point 

• Check digit 

• Carrier route 

• Record type 

• Multi-unit 

• Default flag 

Address range matching works within the following guidelines: 

• There must be two numbers separated by a hyphen. 

• The first number must be lower than the second number. 

• Both numbers must be of the same parity (odd or even) unless the address range itself has mixed odd 

and even addresses. 

• Numbers can be on the same street segment or can be on two different segments. The segments do 

not have to be contiguous. 

• If both numbers are on the same street segment, the geocoded point is interpolated to the approximate 

mid-point of the range. 

• If the numbers are on two different segments, the geocoded point is based on the last valid house 

number of the first segment. The ZIP Code and FIPS Code are based on the first segment. 

• In all cases, odd/even parity is evaluated to place the point on the correct side of the street. 

User's Guide 


451


Options 

452 

Geocode US Address allows you to set default processing options through the Management Console. 

You can override certain settings for individual calls to Geocode US Address using the Client API or 

MapInfo Spatial Server client tools, such as Enterprise Designer. 

If you do not specify system-level defaults through the Management Console or a custom interface, and 

you do not pass any processing options in the job, MapInfo Spatial Server uses the default options. 


Table 93: Geocode US Address Geocoding Options 

Option Name 

Database 

Offset 


The name of the database resource that contains the data to use in the search 



Geocoding Module U.S. Database Resource on page 247. 

Specifies the offset distance from the street segments, in feet. The range is 

0 to 5280. The default value is 50. 

The offset distance is used in street-level geocoding to prevent the geocode 

from being in the middle of a street. It compensates for the fact that streetlevel 

geocoding returns a latitude and longitude point in the center of the 

street where the address is located. Since the building represented by an 

address is not on the street itself, you do not want the geocode for an address 

to be a point on the street. Instead, you want the geocode to represent the 

location of the building which sits next to the street. For example, an offset 

of 50 feet means that the geocode will represent a point 50 feet back from 

the center of the street. The distance is calculated perpendicular to the portion 

of the street segment for the address. Offset is also used to prevent addresses 

across the street from each other from being given the same point. The following 



Option Name 

Squeeze 

User's Guide 



Street coordinates are accurate to 10,000ths of a degree and interpolated 


Specifies the distance, in feet, to move the street segment end points toward 

the middle of the segment. Squeeze is used in street-level matching. Use 

the squeeze setting to prevent address points from residing in an intersection 

or too close to the end of a street. 

The range is 0 to 2147483647. The default value is 50. 

The following diagram compares the end points of a street to squeezed end 

points. 

Squeezing the street segment endpoints affects street-level matching by reducing 

the length of a street segment, thereby reducing the spacing between 

address points along the segment. For example, if the length of a street 

segment is 1,000 feet and there are 10 addresses along the segent, streetlevel 

matching would result in each address being spaced 100 feet apart 

(1,000 ÷ 10). If you were to set a squeeze value of 100 feet, moving each 

street segment endpoint 100 feet torward the center of the street segment, 

the length of the street segment would be reduced to 800 feet (reduced by 

453


454 

Option Name 

Latitude/Longitude 

format 

Centroid preference 

Street centroid 


100 feet on each end). Street-level matching would then result in addresses 

beging spaced 80 feet apart (800 ÷ 10). 

Specifies the format of the latitude/longitude returned by Geocode US Address. 

Decimal 

Integer 

The latitude/longitude is returned in decimal format (default). 

For example: 90.000000-180.000000 

The latitude/longitude is returned in integer format. For 

example: 90000000-180000000 

Determines the type of centroids returned by Geocode US Address. A centroid 

is the center of an area. The centroid coordinates are the average of the sets 

of coordinates that describe the area. 

No Centroids 

Return ZIP Code 

centroids 

Fallback centroids 

Do not return centroids. If an address-level geocode 

cannot be determined, do not attempt to determine 

a centroid. 

Return ZIP Code centroids only. If you select this 

option, address-level geocodes will not be returned. 

Attempt to determine a centroid when an addresslevel 

geocode cannot be determined. The centroid 

options are described below. 

Specifies whether to attempt to return a street centroid when an addresslevel 

geocode cannot be determined. To determine a street centroid, Geocode 

US Address searches the input ZIP Code or city for the closest match. If 

Geocode US Address is able to locate the street, it returns a geocode along 

the matched street segment. 

For example, if the input address is 5000 Walnut Street, Boulder 80301, and 

there is no 5000 Walnut Street, Geocode US Address searches for the closest 

match to that address within the ZIP Code 80301. If there were no input ZIP 

Code, Geocode US Address would search for the closest match to the input 

address within Boulder. 

If the input address is Walnut Street, Boulder 80301, since there is no house 

number, Geocode US Address searches for the street within the input ZIP 

Code. 

Street centroid geocodes are indicated by value in the LocationCode output 

field that begins with "C". For more information, see Street Centroid Location 


Note: 

This option is not available if you set Match mode to CASS. 


User's Guide 

Option Name 

ZIP Code centroid 


Return coordinates in 

Centerline offset 


Specifies whether to attempt to return a ZIP Code centroid when an addresslevel 

geocode cannot be determined. 

ZIP Code centroid geocodes are indicated by value in the LocationCode 

output field that begins with "Z". For more information, see ZIP + 4 Centroid 

Location Codes on page 566. 

Note: 


Specifies whether to attempt to return a city, county, or state centroid when 

an address-level geocode cannot be determined. The geocoder returns the 

most precise geographic centroid that it can based on the input. For example, 

if the input contains a valid city and state, a city centroid would be returned. 

Note: 

There are approximately 300 major cities that can be geocoded to a 

city centroid level even if a valid state is not provided in the input. 

Geographic centroid geocodes are indicated by value in the LocationCode 

output field that begins with "G". For more information, see Geographic 

Centroid Location Codes on page 571. 

Note: 


Determines the North American Datum to use when geocoding datum on the 

input value. Datum is the mathematical model of the Earth used to calculate 

the coordinates on any map, chart, or survey system. 

NAD27 

NAD83 


This datum does not include the Alaskan Islands or Hawaii. 

Latitudes and longitudes that are surveyed in the NAD27 system 

are valid only in reference to NAD27 and are not valid for maps 

outside the U.S. 

This datum is earth-centered and defined with satellite and terrestrial 

data. NAD83 is compatible with the World Geodetic 

System 1984 (WGS84), which is the terrestrial reference frame 

associated with the NAVSTAR Global Positioning System (GPS) 

used extensively for navigation and surveying. This is the default 

setting. 

The offset distance, in feet, used to calculate the street centerline coordinates. 

The default is 0. 

If you specify a value other than 0, Geocode US Address calculates the street 

centerline coordinates by offsetting the centerline point by the distance you 

specify in the direction of the parcel centroid. 

455


456 

Option Name 

Determine elevation 



In an interpolated match, the centerline offset cannot be greater than the 

distance from the centerline to the interpolated address point. If you specify 

a centerline offset distance that is greater than this distance, the offset will 

be limited to the distance to the interpolated point. In effect, the centerline 

coordinates would be the same as the coordinates for the interpolated point. 

Specifies whether Geocode US Address returns the elevation of the address. 

Elevation is the distance above or below sea level of a given location. The 

elevation is returned in the Elevation output field, which is part of the Latitude/Longitude 

output group. 

Note: 

This option requires that you have licensed and installed the Centrus 

Premium Points database. Elevation data is not available for all addresses. 

See the coverage map included with the points database. 

Specifies whether to perform address point interpolation when an exact match 

for the address cannot be found in the geocoding database. Address point 

interpolation is a patented process that results in a more accurate interpolated 

point. It improves upon regular street segment interpolation by using point 

data in the interpolation process, as opposed to using street segments alone. 

Note: 

Address point interpolation is only available when using a point-level 

geocoding database. It is not available when using point addresses 

in an auxiliary file. 

The following illustration shows how address point interpolation works. In the 

example, the input house number is 71. The geocoding database contains 

address points for 67 and 77. The street segment has a range of 11 to 501. 

With address point interpolation, Geocode US Address performs the interpolation 

for the input house number 71 using the points of 67 and 77. Without 


Option Name 



address point interpolation, Geocode US Address performs the interpolation 

with the street segment end points of 11 and 501, resulting in a far less accurate 

result. 

Table 94: Geocode US Address Matching Options 

User's Guide 

Option Name 

Address preference 

Firm name search 


Determines which address to use when more than one address is 

present in the address block. 

Prefer 2nd line 

Prefer P.O. Box 

Prefer Street Address 

Uses the second line entered (default). You 

must select this value if you select CASS 

in the Match mode field. 

Uses the P.O Box. 

Uses the street address. 

Specifies whether Geocode US Address should use firm name matching 

logic to enhance address matching. Firm matching logic matches a 

business name in the input to recognized business names. The input 

firm name does not need to be spelled correctly to obtain a match. 

Geocode US Address uses a soundex algorithm to match the firm name. 

A suite or unit number is not required to make the match. 

Note: 

This type of match is not available when processing in CASS 

mode. 


Never attempt 


Do not use firm matching (default). Note that 

Geocode US Address may correct the firm name 

even if you specify Never attempt if it can find 

a match using the address line data. 

457


458 

Option Name 

Perform first letter search 

Perform building search 


Attempt if address 

line matching fails 

Always attempt 

Use firm matching only if a match cannot be determined 

using address matching. 

Always attempt to match using firm name 

matching. If firm name matching fails, attempt to 

match using address matching. 

Specifies whether to look for the correct first letter of a street name if 

the first letter is missing or incorrect. If enabled, Geocode US Address 

searches through the alphabet looking for the correct first letter to 

complete the street address. 

Note: 

This option is not available if the match mode is set to exact. 

This example includes an incorrect first letter: 

Input: 4750 nalnut boulder co 80301 

Output: 4750 Walnut St Boulder CO 80301-2532 

This example excludes a first letter: 

Input: 4750 alnut boulder co 80301 


This example includes an extra first letter: 

Input: 4750 wwalnut boulder co 80301 


Specifies whether Geocode US Address attempts to obtain a street 

address when the input address contains a building name with no suite 

or unit number. 

When this option is disabled, Geocode US Address is able to match to 

building names only if there is a unit number in the input. For example, 

if the building search option were disabled and you entered this input: 

5001 Chrysler Bldg 

New York, NY 10174 

Geocode US Address would successfully return the street address: 

405 Lexington Ave 

RM 5001 

New York, NY 10174-5002 

With this option enabled, Geocode US Address is also able to obtain a 

street address when only a building name with no unit number is 

provided. For example, if you enable this option and provide this address: 


Option Name 

Determine Assessor's Parcel 

Number 

Perform Delivery Point Validation 

(DPV) 

Perform LACS/Link conversion 

User's Guide 


Chrysler Bldg 

New York, NY 10174 

You will get the street address: 

405 Lexington Ave 

New York, NY 10174-00 

Note: 


This type of match is not available when processing in CASS 

mode. 

Specifies whether Geocode US Address should determine the address's 

APN (assessor's parcel number). The APN is an ID number assigned 

to a property by the local property tax authority. The APN is returned in 

the APN output field, which is part of the Census output group. 

Note: This option requires that you have licensed and installed the 

Cenrus Enhanced Points or Centrus Premium Points database. 

APN data is not available for all addresses. See the coverage 

map included with the points database. 

Specifies whether Geocode US Address should process addresses 

using Delivery Point Validation (DPV). DPV is a United States Postal 

Service (USPS) technology that validates the accuracy of address information 

down to the physical delivery point. You must have licensed 

the optional DPV processing option to use this feature. You must also 

install the DPV database. 

If you use DPV, Geocode US Address automatically resolves multiple 

matches. 

False-positive addresses, also known as seed records, are addresses 

the USPS monitors to ensure users are not attempting to create a 

mailing list from the DPV data. If Geocode US Address matches an 

address in your input data to a false-positive address, you receive a 

message indicating you have encountered a false-positive address. 

Processing continues to the end of your job, but DPV processing is not 

available for this job and subsequent jobs until you have reported the 

false-positive address encounter to technical support and have received 

a new security key. 

Specifies whether Geocode US Address should process addresses 

using LACS Link . 

If you use LACS Link , be sure to choose to choose Postal Data and 

Qualifiers in the Include data field so that the fields USLACS, 

USLACS.ReturnCode, and LACSADDRESS are included in the output. 

459


460 

Option Name 

Prefer ZIP Code over city 

Do not return candidates 

Return ambiguous matches 

Return all candidates 


For more information, see Locatable Address Conversion System 

(LACS) on page 299. 

Specifies whether to prefer candidates that match the input ZIP over 

candidates that match to input city. 

Note: 

This option is not available when processing in CASS mode. 

For example, consider this input address: 

301 BRYANT ST 

SAN FRANCISCO CA 94301 

Without this option enabled, the best match would be the one that 

matches the input city name: 

301 BRYANT ST 

SAN FRANCISCO CA 94107-4167 

With this option enabled, the best match would be the one that matches 

the input ZIP Code: 

301 BRYANT ST 

PALO ALTO CA 94301-1408 

Select this option if you want to have only the best match returned. If 

the match attempt results in an ambiguous match no addresses are 

returned. If the match attempt results in a match to a single address, 

just that address is returned. 

Note: 

The best match is not necessarily a high-quality match. You 

should always check the values in the output fields MatchCode 

and LocationCode to determine the quality of the match. 

Select this option to return the list of possible matches when Geocode 

US Address finds more than one possible match for the input address 

and cannot identify a single best match. 

Select this option to return candidate addresses whenever the match 

attempt produces candidates. If you enable this option, the geocoder 

will return candidates both when the input address matches to a single 

address and when the input address matches multiple addresses. 

This option differs from Return ambiguous matches in that the Return 

ambiguous matches option does not return candidates if the input 

address matches to a single address. 


Option Name 


Match mode 

All input 

User's Guide 


If you specify choose Return all candidates you can choose to return 

just those candidates that are considered to be a close match. The criteria 

used to determine whether a candidate is a close match are those 

you specify in the Match mode option. 

Note: 

A close match does not necessarily indicate a high-quality match. 

You should always check the values in the output fields Match- 

Code and LocationCode to determine the quality of the match. 

Determines the leniency used to find a match. One of the following: 

Custom 

Exact 

Close 

Relaxed 

CASS 


Allows you to select the specific criteria to use when matching 

the input address to an address in the postal database. 

Requires a very tight match. This is a restrictive mode that 

generates the fewest number of match candidates to search, 

which decreases the time to obtain a match. When using 

this mode, ensure that your input address list is very clean; 

free of misspellings and incomplete addresses. 

Requires a moderately confident match. Generates a moderate 

number of match candidates. 

Default. This is the loosest match mode and generates the 

most match candidates, which increases the processing time 

and results in more multiple matches. Use this mode if your 

address list may contain misspellings and incomplete addresses. 

This is the only mode that does not respect the 

street parity for an address match. 

Imposes additional rules to ensure compliance with the USPS 

regulations for CASS. The purpose of this mode is to create 

a list of mailable addresses. This mode generates a large 

number of match candidates. This mode deviates from the 

other modes in its processing. This mode does not perform 

intersection, building name, or spatial alias (TIGER and GDT 

street name alias) matches. It also does not match to candidates 

from data sources that do not have USPS equivalent 

records. This mode recognizes and parses two unit numbers 

on the same address line, for example a building and unit 

number. 

Specifies whether candidates must match all non-blank input fields. For 

example, if an input address contains a city and postal code, then candidates 

for this address must match the city and postal code. 

461


462 

Option Name 

House number 

Street 

City 


Postal code 


Specifies whether candidates must match the house number. If the input 

house number is not within a range from the street, Geocode US Address 

selects the nearest range on the street which has the same parity (even 

or odd house number) as the input address number. Geocode US Address 

returns one or more of the closest matches inside this range that 

preserves street parity. This requires Geocode US Address to change 

the house number. The new house number is equal to one of the range's 

endpoints, possibly plus or minus one to preserve street parity. 

Note: 

Even when this option is disabled and an inexact match on the 

house number is found, Geocode US Address still returns an 

error code. 

When this option is disabled and no exact matching house number is 

found, a match code of either E029 (no matching range, single street 

segment found), or E030 (no matching range, multiple street segment) 

is returned. 

Geocode US Address does not change the house number on the output 

address. In order to access the inexact address number candidates, 

you must enable the Keep multiple matches option If there are inexact 

house number candidates returned, the corresponding match codes 

begin with the letter 'H' indicating that the house number was not 

matched. 

Additionally, even when one or more exact candidates are found, inexact 

matches to the house number are still on the list of possible candidates, 

and these can be differentiated from the others by their Hxx match 

codes. For more information on match codes, see Geocoding Match 


Specifies whether candidates must match the street name. 

Specifies whether candidates must match the city. If you do not require 

exact matches on city, the geocoder searches on the street address 

matched to the particular postal code, and considers other cities that 

do not match the name, but do match the postal code. 

Specifies whether candidates must match the state. 

Specifies whether candidates must match the postal code. If you do not 

require exact match on postal codes, the geocoder searches a wider 

area for a match. While this results in slower performance, the match 

rate is higher because the request does not need to match exactly when 

it compares match candidates. 


Difference Between Match Criteria for U.S. and Non-U.S. Geocoding 

The "must match criteria" used in the custom match mode of Geocode US Address work differently than 

the "close match criteria" in non-U.S. geocoders. For Geocode US Address, the custom match criteria 

specify which address elements must match the reference database in order for the match to be returned 

as a candidate. All candidates returned by Geocode US Address will match the elements you specify 

as long as those elements are available in the reference database. However, in non-U.S. geocoders, 

the "close match" criteria are used to determine which candidates are close matches and which are nonclose 

matches. Non U.S. geocoders can return both close candidates and non-close candidates, depending 

on whether you enable the Close matches only option. In summary, the "must match" criteria used 

by Geocode US Address automatically limit the candidates returned, whereas the "close match criteria" 

used by non-U.S. geocoders do not limit the candidates returned. 

Output Format 

The following table lists the Geocode US Address options that control the format of the output. 

Table 95: Geocode US Address Output Format Options 

Option Name 

Casing 

Output formatted on fail 

Output postal code separator 

Return descriptions in 

output 

User's Guide 


Specifies the casing of the output data. One of the following: 

Mixed 

Upper 

The output in mixed case (default). For example: 

123 Main St 

Mytown FL 12345 

The output in upper case. For example: 

123 MAIN ST 

MYTOWN FL 12345 


Specifies whether Geocode US Address normalizes an addresses that fail 

to match, and addresses that are unchanged. Normalization formats an address 

to the USPS guidelines without validating the address. 

Specifies whether Geocode US Address should include the dash in full postal 

code output. 

Specifies whether Geocode US Address provides an additional description 

field as output. These fields provide the text equivalent to a field represented 

by a code. For example, LocationCode returns a code that indicates the accuracy 

(quality) of the assigned geocode. LocationCode.Description provides 

the description for the code returned. 

463


Output 

464 

Output Data 

The following table shows the Geocode US Address options that control which data Geocode US Address 

returns in the output. 

Table 96: Geocode US Address Output Data Options 

Option Name 

Include data 

Include extra fields 


Specifies optional data to include in the output. Note that Geocode US Address 

always returns the default data listed in Default Output on page 474. 

The data you select here is returned with the default output data. 

• Auxiliary 

• Block Address 

• Census 

• Centerline Projection 

• DPV (The DPV field group is disabled unless you select Perform Delivery 

Point Validation (DPV) on the Configuration Options tab.) 

• Geoconfidence 

• Latitude/Longitude 

• Parsed Elements 

• Postal Data 

• Qualifiers 

• Range 

• Segment 

For a description of the fields in each output group, see Output on page 464. 

If you do not want all of the fields in a particular category returned, do not 

select the check box, and list only those fields you want returned in Include 

extra fields. 

Specifies the individual output fields you want returned. List fields with a pipe 

( | ) between each field. You can use this option instead of the Include data 

option to limit the output to those fields that are important to your data needs. 

By default, these are the address fields returned: AddressLine1|LastLine|Longitude|Latitude|MatchCode|LocationCode 

For a list of all the fields included in each data field, see Output on page 464. 

Geocode US Address always returns a default set of output fields that contain the latitude/longitude, 

standardized address, and result indicators. For information on these fields, see Default Output on page 

474. You can also choose to include the following optional categories of output data: 


• Auxiliary on page 465 

• Block Address on page 466 

• Census on page 467 

• Centerline Projection on page 470 

• Default Output on page 474 

• DPV on page 477 

• Geoconfidence on page 479 

• Latitude/Longitude on page 480 

• Parsed Elements on page 480 

• Postal Data on page 481 

• Qualifiers on page 484 

• Range on page 488 

• Segment on page 489 

Note: 

Auxiliary 

If you are using the API, the output returned is in the DataTable class. For information on the 

DataTable class, see the "API Fundamentals" section of the MapInfo Spatial Server API Guide. 

Auxiliary data output fields contain information on the an auxiliary file match. For more information on 

using an auxiliary file, see Auxiliary File Overview on page 548. Geocode US Address only returns 

values when matching against an auxiliary file. To include segment data fields in the output, select the 

Auxiliary check box under Include data. 

Table 97: Auxiliary Data Output Fields 

Field Name 

AuxiliaryData 

MCDCode 

MCDName 

User's Guide 


The user data field in an auxiliary file match. 

Note: 


Geocode US Address does not process this information. It simply 

includes the user data contained in the auxiliary file. 

The Minor Civil Division (MCD) code. A Minor Civil Division is a subdivision 

of a county, such as a township. There are Minor Civil Divisions in 

28 states, the District of Columbia, Puerto Rico, and Island Areas. Minor 

Civil Divisions are defined by U.S. Census Bureau. 

The Minor Civil Division (MCD) name. A Minor Civil Division is a subdivision 

of a county, such as a township. There are Minor Civil Divisions 

in 28 states, the District of Columbia, Puerto Rico, and Island Areas. 

Minor Civil Divisions are defined by U.S. Census Bureau. 

465


466 

Block Address 

Block data output fields contain extraneous information from the input address that Geocode US Address 

could not process. To include block data in the output, select the Block Data check box under Include 

data. 

If there are any empty lines in the input fields AddressLine1 through AddressLine6, Geocode US Address 

moves the output lines to the first empty BlockLine output field, eliminating the blank lines. For example: 

Input Field 

AddressLine1 

AddressLine2 

AddressLine3 

AddressLine4 

AddressLine5 

AddressLine6 

Input Data 

Pitney Bowes 

4750 Walnut 

Ste 200 

Dept ABC 

80301 

Table 98: Block Data Output Fields 

Field Name 

BlockLine1 

BlockLine2 

BlockLine3 

Description 

Output Field 

AddressLine1 

LastLine 

BlockLine1 

BlockLine2 

BlockLine3 

BlockLine4 

BlockLine5 

BlockLine6 

Output Data 

4750 Walnut St Ste 200 

Boulder, CO 80301-2532 

Pitney Bowes 

Dept ABC 

Note: Moved up one 

line from the input 

Address- 

Line5. 

Returns input address information Geocode US Address could not 

process. 


process. 


process. 


Field Name 

BlockLine4 

BlockLine5 

BlockLine6 

Census 

Description 


process. 


process. 


process. 

Census output fields contain U.S. Census information about the address. To include census data in the 

output, select the Census check box under Include data. 

Table 99: Census Data Output Fields 

Field Name 

APN 

BlockSuffix 

CBSACode 

User's Guide 

Description 

The assessor's parcel number of the property. The assessor's parcel 

number is an ID number assigned to a property by the local property 

tax authority. 

The block suffix for the Census block in which the address is located. 

A block suffix is a single character assigned to subsections of U.S. 

Census blocks that are split by a higher-level boundary, such as a municipal 

boundary. A block suffix is either "A" or "B". For information about 

U.S. Census block suffixes, see the Geographic Areas Reference 

Manual, available at the U.S. Census Bureau website: 

www.census.gov/geo/www/garm.html 


Block suffixes are only available if you are using Centrus Enhanced 

data. 

The code for the Core Based Statistical Area (CBSA) in which the address 

is located. 

A CBSA is a collective term that refers to both metropolitan and micropolitan 

areas. A metropolitan area has a population of more than 50,000, 

and a micropolitan area has a population between 10,000 and 49,999. 

For more information, see Metropolitan and Micropolitan Statistical Areas 

section of the U.S. Census Bureau website: 

www.census.gov/population/www/metroareas/metroarea.html 

467


468 

Field Name 

CBSADivisionCode 

CBSADivisionName 

CBSAMetro 

Description 

The code of the Core Based Statistical Area (CBSA) division in which 

the address is located. 

A CBSA division is a metropolitan statistical area with a population of 

at least 2.5 million that has been subdivided to form smaller groupings 

of counties referred to as "metropolitan divisions." For more information, 

see Metropolitan and Micropolitan Statistical Areas section of the U.S. 

Census Bureau website: 


The name of the Core Based Statistical Area (CBSA) division in which 

the address is located. 

A CBSA division is a metropolitan statistical area with a population of 

at least 2.5 million that has been subdivided to form smaller groupings 

of counties referred to as "metropolitan divisions." For more information, 

see Metropolitan and Micropolitan Statistical Areas section of the U.S. 



The CBSA division name is only returned if you enable the Return descriptions 

in output option on the Output Format tab. 

Indicates whether the core based statistical area (CBSA) in which the 

address is located is a metropolitan area or a micropolitan area. One 


Y 

N 

null 

Yes, the address is located in a metropolitan statistical area. 

Metropolitan areas have a population greater than 50,000. 

No, the address is not located in a metropolitan area. It is 

located in a micropolitan area. Micropolitan areas have a 

population between 10,000 and 49,999. 

There is no data available to determine whether the address 

is in a metropolitan or micropolitan area. 








Field Name 

CBSAName 

CensusBlockID 

CensusTract 

User's Guide 

Description 

The name of the core based statistical area (CBSA) in which the address 

is located. The CBSA division name is only returned if you enable the 

Return descriptions in output option on the Output Format tab. 







The 15-digit identification number of the census block in which the address 

is located. Census blocks are the smallest geographic area for 

which the Bureau of the Census collects and tabulates decennial census 

data. Census blocks are formed by streets, roads, railroads, streams 

and other bodies of water, other visible physical and cultural features, 

and the legal boundaries shown on Census Bureau maps. For more 

information about U.S. Census blocks, see the Geographic Areas Reference 



The Census block ID is in the format: 

sscccttttttgbbb 

Where: 

ss 

ccc 

tttttt 

g 

bbb 

Note: 


The two-digit state FIPS code. 

The three-digit county FIPS code. 

The six-digit Census tract FIPS code. 

The single-digit block group FIPS code. 

The block FIPS code. 

Geocode US Address does not return a period for the Centrus 

tract FIPS code. This may deviate from the industry standard. 

The six-digit ID of the Census tract in which the address is located. 

Census tracts are small, relatively permanent geographic entities within 

counties (or the statistical equivalents of counties). Generally, census 

tracts have between 2,500 and 8,000 residents and boundaries that 

follow visible features. For more information about U.S. Census tracts, 

see the Geographic Areas Reference Manual, available at the U.S. 


469


470 

Field Name 

CSACode 

CSAName 

USCountyName 

USFIPSCountyNumber 

USFIPSStateCode 

USFIPSStateCountyCode 

Centerline Projection 

Description 


Denotes the code for a geographic entity that consists of 2 or more adjacent 

CBSAs with employment interchange measures of at least 15. 

The name of the combined statistical area (CSA) in which the address 

is located. 

A CSA is a combination of two or more adjacent Core Based Statistical 

Areas (CBSAs) with a high employment interchange measure. The 

employment interchange measure is the sum of the percentage of employed 

residents of the smaller entity who work in the larger entity and 

the percentage of the employment in the smaller entity that is accounted 

for by workers who reside in the larger entity. Pairs of CBSAs with employment 

interchange measures of at least 25% combine automatically. 

Pairs of CBSAs with employment interchange measures of at least 15%, 

but less than 25%, may combine if local opinion in both areas favors 

combination. 

The CSA name is only returned if you enable the Return descriptions 


The name of the county or parish in which the address is located. The 

county/parish name is only returned if you enable the Return descriptions 


The three-digit FIPS county code of the county in which the address is 

located. 

The two-digit FIPS state code of the state in which the address is located. 

The five-digit FIPS code for the state and county in which the address 

is located. 

Centerline projection output fields contain information specific to a centerline match. To include centerline 

projection fields in the output, select the Centerline Projection check box under Include data. 


Table 100: Centerline Projection Output Fields 

Field Name 

User's Guide 

CenterlineBearing 

CenterlineBlockLeft 

CenterlineBlockRight 

CenterlineBlockSuffixLeft 

CenterlineBlockSuffixRight 

CenterlineDataCode 

Description 

The compass direction, in decimal degrees, from the point data match 

to the street centerline match. The compass direction is measured 

clockwise from 0 degrees north. For example, if the centerline match is 

directly north of the point match, the centerline bearing would be 0. 

The Census FIPS Code that indicates the address is on the left side of 

the street. 

The Census FIPS Code that indicates the address is on the right side 

of the street. 

The block suffix of the block on the left side of the street. 








data. 

The block suffix of the block on the right side of the street. 








data. 

Indicates the data used to obtain a centerline match for the address. 


0 

1 

2 


USPS data in either the Centrus Enhanced, Centrus GDT, 

or Centrus NAVTEQ database. 

TIGER data in the Centrus Enhanced database. 

TeleAtlas data in the Centrus GDT database. 

471


472 

Field Name 

CenterlineDirection 

CenterlineDistance 

CenterlineHouseNumberHigh 

CenterlineHouseNumberLow 

CenterlineIsAlias 

Description 

6 

7 

8 

9 

NAVTEQ data in the Centrus NAVTEQ database. 

TeleAtlas point-level data in the Centrus TeleAtlas Points 

database. 

Point-level data from the Centrus Points database. 

Auxiliary file data. 

For more information about these databases, see Enterprise Geocoding 

Databases on page 290. 

Indicates the order of numbers on a segment for a centerline match. 

F 

R 

B 

U 

Forward 

Reversed 

Both 

Undetermined 

Distance, in feet, from the point-level match to the centerline match. 

The highest address number in the range of addresses on the street 

segment. For example, if the address range for the street segment is 

1000 to 2000, the CenterlineHouseNumberHigh would be 2000. 

The lowest address number in the range of addresses on the street 

segment. For example, if the address range for the street segment is 

1000 to 2000, the CenterlineHouseNumberLow would be 1000. 

Three characters indicating that Geocode US Address located a 

centerline match by an index alias. The first is an N for normal street 

match or A for alias match (including buildings, aliases, firms, etc.). The 

next two characters are: 

01 

02 

03 

04 

05 

Basic index (normal address match) 

USPS street name alias index 

USPS building index 

USPS firm name index 

Statewide intersection alias match (when using the 

Usw.gsi or Use.gsi file) 


Field Name 

User's Guide 

CenterlineLatitude 

CenterlineLeadingDirectional 

CenterlineLongitude 

CenterlineParity 

CenterlineRoadClass 

CenterlineSegmentCode 

CenterlineStreetName 

CenterlineStreetSuffix 

Description 

06 

07 

08 

Spatial data street name alias (when using, the 

Us_pw.gsi, Us_pe.gsi, Us_psw.gsi, or Us_pse.gsi file is 

required) 

Alternate index (when using Zip9.gsu, Zip9e.gsu, and 

Zip9w.gsu) 

LACS Link 

A seven-digit number in degrees and calculated to four decimal places 

for a centerline match. This field is only returned ifDetermine street 

centerline coordinates is checked. 

The street directional that precedes the street name for a centerline 

match. For example, the N in 138 N Main Street. 

7-digit number in degrees and calculated to 4 decimal places (in the 

format specified) for a centerline match. This field is only returned ifDetermine 

street centerline coordinates is checked. 

Indicates which side of the street has odd numbers for a centerline 

match. 

L 

R 

B 

U 

The left side of the street has odd numbers. 

The right side of the street has odd numbers. 

Both sides of the street have odd numbers. 

Undetermined. 

The type of road for a centerline match: 

1 

2 

Major 

Minor 

The unique 10-digit street segment ID assigned by the street network 

data provider. 

The name of the street. 


The street type of the matched centerline location. For example, AVE 

in "Washington AVE". 

473


474 

Field Name 

CenterlineTrailingDirectional 

Default Output 

Description 

The street directional that follows the street name. For example, the N 

in 456 Washington AVE N. 

Geocode US Address always returns fields that contain the latitude/longitude, standardized address, 

and result indicators. Result indicators describe how well Geocode US Address matched the input address 

to a known address and assigned a location. They also describes the overall status of a match attempt. 

Table 101: Default Output Fields 

Field Name 

AddressLine1 

AddressLine2 

City 

Confidence 

Description 

The first line of the address. For example: 

1 Global View 

Troy, NY 12180-8371 

The second line of the address. For example: 

4200 Parliament Pl 

STE 600 

Lanham, MD 20706-1882 


Indicates the confidence in the output provided, from 0 to 100. The 

higher the score, the higher the probability that the match is correct. If 

the match is exact, the confidence score is 100. For all other matches, 

Geocode US Address calculates the confidence score by subtracting 

values from 100 as follows: 

• If Geocode US Address changed the state to obtain a match: 

• Added the state -3.75 

• No state -7.5 

• If Geocode US Address changed the city to obtain a match: 

• Added city -2.5 

• No city -5.0 

• If Geocode US Address change the house number to obtain a match: 

• Added house number -3.75 


Field Name 

Country 

FirmName 

LastLine 

Latitude 

User's Guide 

LocationCode 

Description 

• No house number -7.5 

• If Geocode US Address changed the street name to obtain a match: 

• Added street name -3.75 

• No street name -7.5 

• If Geocode US Address changed the trailing directional to obtain a 

match: 

• Added trailing directional -1.25 

• No trailing directional -2.5 

• If Geocode US Address changed the leading directional to obtain a 

match: 

• Added leading directional -1.25 

• No leading directional -2.5 

• If Geocode US Address changed the street suffix to obtain a match: 

• Added street suffix -1.25 

• No street suffix -2.5 

• If Geocode US Address changed the postal code to obtain a match: 

-11.25 

If you have enabled the option to return centroids, the confidence value 

indicates the type of centroid returned: 

• 60 for a street centroid 

• 50 for a postal code centroid 

• 35 for a city centroid 

• 30 for a county centroid 

• 25 for a state centroid 


The name of the country. Since Geocode US Address only works for 

U.S. locations, this field will always contain United States of America. 

The name of the business if the address is a business address. 

The complete last address line (city, state, and postal code). 



A value indicating the accuracy (quality) of the assigned geocode. 

475


476 

Field Name 

Longitude 

MatchCode 

PostalCode 

PostalCode.AddOn 

PostalCode.Base 

ProcessedBy 

StateProvince 

Status 

Status.Code 


Description 

For more information, see Address Location Codes on page 555. 



Indicates the portions of the address that matched to the directory file. 

For more information, see Geocoding Match Codes on page 571. 

Nine-digit ZIP Code with or without a hyphen. 

Four-digit ZIP Code extension 

Five-digit ZIP Code. 

The underlying software that processed the request. KGL for Geocode 

US Address. 

Two-character state abbreviation. 


null 

F 

Success 

Failure 

If Geocode US Address could not process the address, this field will 

show the reason. 




If Geocode US Address could not process the address, this field will 

show a description of the failure. 





System Error. 


Found. 


Found. 


Field Name 


StreetSide 

USUrbanName 

DPV 

Description 

The data set Geocode US Address attempted to match against. 

Indicates the side of the street the range occupies. One of the following: 

L 

R 

B 

U 

The range occupies the left side of the street. 

The range occupies the right side of the street. 

The range occupies both sides of the street. 

Undetermined. 

Urbanization name. Used for addresses in Puerto Rico. 

DPV data output fields contain information about a match made using DPV data. Geocode US Address 

only returns values when matching against DPV data. To include DPV data in the output, select the DPV 

Data check box under Include data. 

Table 102: DPV Data Output Fields 

Field Name 

CMRA 

DPV 

User's Guide 

Description 

Indicates whether the address is for a Commercial Mail Receiving Agent 

(CMRA). A CMRA is a private company that rents out mailboxes. A 

customer of a commercial mail receiving agency can receive mail and 

other deliveries at the street address of the CMRA rather than the customer's 

own street address. Depending on the agreement between the 

customer and the CMRA, the CMRA can forward the mail to the customer 

or hold it for pickup. 

Y 

N 

null 

Yes, the address is a CMRA. 

No, the address is not a CMRA. 

DPV data is not available. DPV data is required to determine 

if an address is a CMRA. 

Indicates whether the address is confirmed to be a deliverable address 

by USPS Delivery Point Validation (DPV). 

N 

Y 

Nothing confirmed 


Everything confirmed (ZIP+4, primary, and secondary) 

477


478 

Field Name 

DPVFootnote 

Description 

S 

D 

U 

ZIP+4 and primary (house number) confirmed 

ZIP+4 and primary (house number) confirmed and a default 

match 

Non-matched input address to USPS ZIP+4 data, or DPV 

data not loaded 

Contains detailed information about the address. The DPV footnote 

codes are combined together consecutively. 

DPV footnotes include the following: 

• FOOTNOTE1 provides information about matched DPV records. 

• AA—ZIP+4 matched record 

• A1—Failure to match a ZIP+4 record 

• null—Address not presented to hash table or DPV data not loaded 


• BB—All DPV categories matched 

• CC—Matched primary/house number, where the secondary/unit 

number did not match (present but invalid) 

• M1—Missing primary/house number 

• M3—Invalid primary/house number 

• N1—Matched primary/house number, with a missing highrise secondary 

number 

• P1—Missing PS, RR, or HC Box number 

• P3—Invalid PS, RR or HC Box number 

• F1—All military addresses 

• G1—All general delivery addresses 

• U1—All unique ZIP Code addresses 



• R1—Matched CMRA, without a present secondary/unit number 

• RR—Matched CMRA 


Note: 

A unique ZIP Code is a ZIP Code assigned to a company, 

agency, or entity with sufficient mail volume to receive its own 

ZIP Code. 


Geoconfidence 

Geoconfidence data output fields contain information about the type of geoconfidence polygon returned. 

To include geoconfidence fields in the output, select the Geo Confidence check box under Include 

data. 

Field Name 

User's Guide 

GeoConfidenceCode 

StreetSegmentPoints 

GeoConfidenceCentroidLatitude 

GeoConfidenceCentroidLongitude 

Description 

The value returned in this field indicates which geoconfidence 

surface type has been returned. 

Possible values are: 

INTERSEC- 

TION 

ADDRESS 

POINT 

POSTAL1 

POSTAL2 

POSTAL3 

ERROR 

A geocode point for the intersection of 

two streets. 

An array of street segment points representing 

the street segment where the 

address is located. 

If the geocoder was able to match the 

address using point data, the point 

geometry where the address is located. 

A geocode point for the ZIP centroid. 

An array of points for all street segments 

in the ZIP + 2 in which the address 

is located. 

An array of points for street segments 

in the ZIP + 4 in which the address is 

located. 

An error has occurred. 

An array of latitude/longitude values that represent the 

street segment points. 

Note: 


This field contains values only if the GeoConfidenceCode 

field returns a value of ADDRESS, 

POSTAL2, or POSTAL3. 

The latitude of the centroid of the geoconfidence polygon. 

The longitude of the centroid of the geoconfidence 

polygon. 

479


480 


The latitude/longitude output fields contain the geographic coordinates of the address. To include latitude/longitude 

output fields in the output, select the Latitude/Longitude check box under Include data. 

Table 103: Latitude/Longitude Output Fields 

Field Name 

Elevation 

Latitude 

Longitude 

Parsed Elements 

Description 

The location's elevation in feet above or below sea level. 

The latitude of the address. The latitude is a seven-digit number in degrees, 

calculated to six decimal places. 

The longitude of the address. The longitude is a seven-digit number in 

degrees, calculated to six decimal places. 

The parsed elements output fields contain standard address information as individual units, such as 

street suffixes (for example AVE, ST, or RD) and leading directionals (for example N and SE). To include 

parsed elements in the output, select the Parsed Elements check box under Include data. 

Table 104: Parsed Elements Output Fields 

Field Name 


ApartmentLabel2 


ApartmentNumber2 

CrossStreetLeadingDirectional 

1 

Description 


The type of unit, such as apartment, suite, or lot, for addresses that 

contain two units, such as: 123 E Main St APT 3, 4th Floor . 

Apartment number. For example: 123 E Main St APT 3 

Secondary apartment number. For example: 123 E Main St APT 3, 4th 

Floor 

Leading directional, for example: 123 E Main St Apt 3 


Field Name 

CrossStreetName 

CrossStreetSuffix 1 

CrossStreetTrailingDirectional 

1 

HouseNumber 



PrivateMailbox.Designator 

RRHC 

StreetName 

StreetSuffix 


Postal Data 

Description 

Name of cross street. 

Street suffix, for example: 123 E Main St Apt 3 

Trailing directional, for example: 123 Pennsylvania Ave NW 

Building number for the address. 

Leading directional, for example: 123 E Main St Apt 3 

Private mailbox. Not returned for multiline input. 

Private mailbox description. Not returned for multiline input. 

Rural Route/Highway Contract portion of the address. 

Street name. 




Postal data output fields contain detailed postal information for the address, such as the preferred city 

name and the US carrier route. To include postal data fields in the output, select the Postal Data check 

box under Include data. 

Table 105: Postal Data Output Fields 

Field Name 

CityPreferredName 

Description 

The USPS ® preferred city name for the ZIP Code of the address. 

1 Geocode US Address only returns Cross street outputs if you entered an intersection as an address. For 

example, entering Pearl and 28th, Boulder, CO returns cross street information. Entering 2800 Pearl, 

Boulder, CO does NOT return cross street information. 

User's Guide 


481


482 

Field Name 

CityShortName 

CityStateRecordName 

DeliveryPointCode 

GovernmentBuilding 

PostalBarCode 

PostalCodeClass 

PostalCodeUnique 

Description 

The USPS ® -approved abbreviation for the city, if there is one. The 

USPS ® provides abbreviations for city names that are 14 characters 

long or longer. City abbreviations are 13 characters or less and can be 

used when there is limited space on the mailing label. If there is no short 

city name for the city, then the full city name is returned. 

USPS ® city state city name. 

Two-digit delivery point bar code. 

Indicates if a building is used by the city, state, or federal government. 

A 

B 

C 

D 

E 

F 

G 

City government building 

Federal government building 

State government building 

Firm only 

City government building and firm only 

Federal government building and firm only 

State government building and firm only 

The values A, B, C, E, F, and G are valid for Alternate records only. The 

value D is valid for both base and alternate records. 

Six-digit combination of ZIP+4 Code and the delivery point bar code. 

ZIP Classification code. 

null 

M 

P 

U 

Standard ZIP Code 

Military ZIP Code 

ZIP Code has P.O. boxes only 

Unique ZIP Code (ZIP Code assigned to a single organization) 

Indicates if the ZIP Code is a unique ZIP Code assigned to an individual 

company or agency. 

Y 

null 

Unique ZIP name 

No unique ZIP name 


Field Name 

PostalFacility 

USBCCheckDigit 

USCarrierRouteCode 

USCarrierRouteSort 

USCityDelivery 

USLACS 

User's Guide 

Description 

USPS City State Name Facility code. 

A 

B 

C 

D 

E 

F 

G 

K 

M 

N 

P 

S 

U 

Airport Mail Facility (AMF) 

Branch 

Community Post Office (CPO) 

Area Distribution Center (ADC) 

Sectional Center Facility (SCF) 

Delivery Distribution Center (DDC) 

General Mail Facility (GMF) 

Bulk Mail Center (BMC) 

Money Order Unit 

Non-Postal Community Name, Former Postal Facility, 

or Place Name 

Post Office 

Station 

Urbanization 

Check-digit for delivery point bar code. 

Carrier Route code. 

Indicates if the USPS uses a carrier route sort, and what type of sort 

the USPS allows. 

A 

B 

C 

D 

Automation cart allowed, optional cart merging allowed 

Automation cart allowed, no optional cart merging allowed 

No automation cart allowed, optional cart merging allowed 

No automation cart allowed, no optional cart merging allowed 

Indicates if has city-delivery carrier routes. 

Y 

N 

Has city-delivery carrier routes 

Does not have city-delivery carrier routes. 

Indicates if LACS Link match occurred. 


483


484 

Field Name 

USLACS.ReturnCode 

USLOTCode 

Qualifiers 

Description 

Y 

N 

F 

S 

null 

Matched LACS Link record 

LACS Link match not found 

False-positive LACS Link record 

Secondary information (unit number) removed to make 

a LACS Link match 

Records not processed through LACS Link 



Indicates LACS Link results. 

A 

00 

09 

14 

92 

null 

Matched LACS Link record 

LACS Link match was not found 

Matched to highrise default, but noLACS Link conversion 

Found LACS Link match, but no LACS Link conversion 

Secondary information (unit number) was removed to 

make a LACS Link match 

Records not processed through LACS Link 



A combination of the 4-digit Line of Travel (LOT) Code and the ascending 

(A) or descending (D) indicator. 

Qualifier output fields contain qualification information on the match, such as the location code and the 

match code. To include postal data fields in the output, select the Qualifiers check box under Include 

data. 

Table 106: Qualifier Output Fields 

Field Name 

AddressLineResolved 

Description 

For two-line addresses, indicates which address line was used to obtain 

the match. One of the following: 


Field Name 

CountryLevel 

DatabaseVersion 

EWSMatch 

ExpirationDate 


GeoStanMatchScore 

Intersection 

User's Guide 

Description 

0 

1 

2 

3 

4 

5 

The address could not be matched, or the address matched 

to multiple addresses. 

AddressLine1 was used to obtain the match. 

AddressLine2 was used to obtain the match. 

Both address lines were used in their original order. 

Both address lines were used but the order of the lines was 

switched to obtain the match. 

The input address was a one line address. 

The category of postal data available. Always returns A in Geocode US 

Address—Validates, corrects, and provides missing postal code, city 

name, state/county name, street address elements, and country name. 

USPS publish date, in the format Month Year. 

Indicates if Geocode US Address denied a match because of the input 

address matched an address in the Early Warning System (EWS) data. 

Y 

null 

The address matched to an address in the EWS data so 

the match was denied. 

The address did not match to an address in the EWS data. 

Date the database expires, in the format MM/DD/YY. 


Note: The match codes returned in this field are different from the 

match codes described in Geocoding Match Codes on page 

571. Instead, the match codes returned in this field are taken 

from a set of match codes that are compatible with all other 

country geocoders. For more information, see Introduction on 

page 577. 

Record matching score (for multimatches only). 

Indicates if Geocode US Address found a cross-street match. 

T 

F 


True 

False 

485


486 

Field Name 

IsAlias 

IsCloseMatch 

LACSAddress 

LocationCode.Description 

MatchCode.Description 

RecordType 

Description 

Geocode US Address located a match by an index alias. Returns 3 

characters. The first is an N for normal street match or A for alias match 

(including buildings, aliases, firms, etc.). The next 2 characters are: 

01 

02 

03 

04 

05 

06 

07 

08 





Statewide intersection alias match 

Spatial data street name alias 

Alternate index 

LACS Link 

Indicates whether or not the address is considered a close match. 

Y 

N 



Indicates if Geocode US Address converted an address due to the 

Locatable Address Conversion System (LACS) 

L 

null 

Converted 

Not converted 

LocationCode converted to text. Only returned when you set the configuration 

options to return additional descriptions (verbose). 

MatchCode converted to text. Only returned when you set the configuration 


Indicates the record type: 

• GeneralDelivery 

• HighRise 

• FirmRecord 

• Normal 

• PostOfficeBox 

• RRHighwayContract 

• Geographic (non USPS TIGER match) 


Field Name 

User's Guide 

RecordType.Default 

StreetDataCode 


Description 

• Auxiliary (match to an auxiliary file) 

Indicates type of match that occurred for the record type HighRise or 

RRHighwayContract: 

Y 

N 

U 

Default match 

Exact match 

Not matched 

Indicates the data used to geocode the address. One of the following: 

0 

1 

2 

6 

7 

8 

9 







database. 




For more information about these databases, see Enterprise Geocoding 


Indicates the data initially used for the match attempt. Note that the 

output field StreetDataCode shows which data was actually used to 

obtain the match. 

The data indicated in StreetDataType may be different from that in 

StreetDataCode if a match cannot be made in the initial match attempt. 

For example, if a points database is loaded, Geocode US Address will 

first attempt a match to the point data because this is the most accurate 

type of match. If a point-level match cannot be made, Geocode US Address 

will attempt to match to street data. If the match is made using 

street data, then the SreetDataType would indicate the point-level data 

and the StreetDataCode would indicate the street data. 

For more information, see How Geocode US Address Processes 

Addresses on page 449. 

487


488 

Range 

Range output fields contain information on the street range, such as the high and low unit numbers. To 

include range data fields in the output, select the Range check box under Include data. 

Table 107: Range Data Output Fields 

Field Name 

Alternate 




PostalCodeExtensionHigh 

PostalCodeExtensionLow 


UnitNumberLow 

UnitNumberParity 

Description 

USPS code that specifies whether a record is a base or alternate record. 

B 

A 

Base record. Base records can represent a range of addresses 

or an individual address, such as a firm record. 

Alternate record. Alternate records are individual delivery 

points. 

The highest house number in the range. 

The lowest house number in the range. 

Indicates if the house number range contains even or odd numbers. 

E 

O 

B 

Even 

Odd 

Both 

The highest four-digit ZIP Code extension in the range. The ZIP Code 

extension is the four digits at the end of the ZIP Code. For example: 

60510-1134. 

The lowest four-digit ZIP Code extension in the range. The ZIP Code 

extension is the four digits at the end of the ZIP Code. For example: 

60510-1134. 

The highest unit number in the range. 

The lowest unit number in the range. 

Indicates if the unit number range contains even or odd numbers. 

E 

O 

B 

Even 

Odd 

Both 


Segment 

Segment output fields contain information on the street segment identified by the data provider. To include 

segment data fields in the output, select the Segment check box under Include data. 

Table 108: Segment Data Output Fields 

Field Name 

BlockLeft 

BlockRight 

BlockSuffixLeft 

BlockSuffixRight 

RoadClass 

User's Guide 

SegmentCode 

Description 

The Census FIPS Code that indicates the address is on the left side of 

the street. 

The Census FIPS Code that indicates the address is on the right side 


The block suffix of the block on the left side of the street. 








data. 

The block suffix of the block on the right side of the street. 








data. 

The type of road: 

1 

2 


Major 

Minor 

The unique 10-digit street segment ID assigned by the street network 

data provider. 

489


490 

Field Name 

SegmentDirection 

SegmentHouseNumberHigh 

SegmentHouseNumberLow 

SegmentLength 

SegmentParity 

StreetSide.NAVTEQ 

Description 

Indicates the order of numbers on a segment. 

F 

R 

B 

U 

Forward 

Reversed 

Both 

Undetermined 

The highest house number in the segment. 

The lowest house number in the segment. 

The length, in feet, of a block segment. 


L 

R 

B 

U 




Undetermined 

Indicates which side of the street the address is located on. The value 

in this field is determined by using the NAVTEQ reference nodes for the 

street segment. A street segment represents part of a street. Each 

segment has a node at each end: the reference node and the non-reference 

node. The reference node is the node with the lower latitude 

(southernmost). If the latitudes of both nodes are identical, the reference 

node is the end node with the lower longitude (westernmost). The street 

side corresponds to the street sides you would see if you were standing 

at the reference node and looking at the non-reference node. 

One of the follwoing: 

L 

R 

B 

U 

null 

The address is on the left side of the street. 

The address is on the right side of the street. 

The address occupies both sides of the street. 

The street side is unknown. 

NAVTEQ data was not used, or segment output data was 

not selected, or the address did not match a street segment 

(for example, the address was geocoded to a centroid). 


Reports 

There is one report available with Geocode US Address: the Geocode US Address Summary Report. 

To create the report, in Enterprise Designer, drag the Geocode US Address Summary Report icon to 

the canvas. You do not need to draw a connector to the report. 

Geocode US Address Summary Report 

The Geocode US Address Summary Report contains information about the job, such as the settings, 

number of records processed, performance statistics, and the database used, as well as detailed information 

about the geocoding and address matching results. This report contains the following sections. 

Address Matching Summary 

This section shows the number of records processed and the number of matches obtained. 

• Total Records in File—The total number of records in the input file used by this job. 

• Records Processed—The number of input records minus those records that were skipped. 

• Addresses Matched—The number of addresses that were successfully standardized and validated. 

This count includes all the Standardized addresses listed under the Matched Address Records section 

plus those with match codes beginning with G (auxiliary file), T (geographic data only), and X (intersections). 

• Unmatched—The number of records that could not be validated. 

Matched Address Records 

This section contains information about the addresses that were successfully matched. 

• Standardized—The number of addresses that match to USPS-relevant records. These addresses 

have match codes beginning with A (alias), D (small town), Q (unique ZIP), S (street), and U (rare). 

Only these types of matches are counted as Standardized. 

• Auxiliary File—The number of records that were matched to a user-defined file. These records have 

a MatchCode beginning with G. 

• Intersections—The number of records that were matched to an intersection. These records have a 

MatchCode beginning with X. 

• Non-USPS—The number of records that were matched to non-USPS data. 

Unmatched Address Records 

This section lists the number of unmatched addressees and the reasons why the addresses were not 

matched. For information on these codes, see Location Codes for U.S. Geocoding on page 554. 

Standardized Address Quality 

This section describes the changes that Geocode US Address made to addresses in order to validate 

them. 

• Original address unchanged—None of the address elements were changed to obtain a match. 

User's Guide 


491


492 

• Original last line unchanged—The last line (city, state, ZIP Code) was unchanged but other elements 

were changed to obtain a match. 

• Corrected predirectional—The predirectional of a street name was changed to obtain a match. For 

example, E MAIN ST changed to W MAIN ST. 

• Corrected street name—The name of the street was changed to obtain a match. For example, MAIN 

ST changed to MAINE ST. 

• Corrected street suffix—The street suffix was changed to obtain a match. For example, MAIN ST 

changed to MAIN AVE. 

• Corrected postdirectional—The postdirectional of a street was changed to obtain a match. For example, 

MAIN ST NW changed to MAIN ST SW. 

• Corrected city name—The name of the city was corrected to obtain a match. For example, LOS 

ANGLES changed to LOS ANGELES. 

• Corrected state abbreviation—The state abbreviation was corrected to obtain a match. For example, 

ROCHESTER NY changed to ROCHESTER MN. 

• Corrected ZIP Code—The ZIP Code as corrected to obtain a match. For example: 1071 MAPLE LN 

BATAVIA IL 49423 Changed to: 1071 MAPLE LN BATAVIA IL 60510 

• Corrected ZIP + 4 add on—The four digits that appear after the "-" in a ZIP + 4 were corrected to 

obtain a match. For example, 60510 changed to 60510-1135. 

Geocode Matching Levels 

This section describes the level of accuracy for the geocodes returned by Geocode US Address. 

• Geocodes Assigned—The number of records to which Geocode US Address assigned a geocode. 

This is the cumulative count of the following fields: 

• Address Match—Address geocodes indicate a geocode made directly to a street network segment 

(or two segments, in the case of an intersection). Addresses included in this count have a value that 

begins with A in the LocationCode output field. 

• Auxiliary Match—The geocode was determined using the Auxiliary File. Addresses included in this 

count have a value that begins with AG in the LocationCode output field. For more information, see 

Auxiliary Match Details on page 492. 

• Point Match—The geocode was determined using a points database, which means the geocode 

represents the center of a building or parcel. Addresses included in this count have a value that begins 

with AP in the LocationCode output field. For more information, see Point Matching Details on page 

493. 

• ZIP Centroids Match—The address could not be matched, so the geocode is the center of the address's 

ZIP Code. This is the least accurate geocode for a given address. Addresses included in this count 

have a value that begins with Z in the LocationCode output field. For more information, see ZIP 

Centroid Matching Details on page 493. 

Auxiliary Match Details 

This section describes the level of accuracy for the geocodes returned by Geocode US Address that 

were obtained from the Auxiliary File. For more information, see Auxiliary File Overview on page 548. 

These fields are ordered from the most accurate type of geocode to the least. 

• Point—The geocode represents the center of a building or parcel. Addresses included in this count 

have a value of AG0 in the LocationCode output field. 


• Centerline—The geocode represents the location of an address along a street segment. Addresses 

included in this count have a value of AG1 in the LocationCode output field. 

• Centerline with unknown street side—The geocode represents the location of an address along a 

street segment but the side of the street where the address resides could not be determined. Addresses 


• Midpoint—The geocode represents the midpoint of the street segment where the address resides. 

Geocode US Address could not determine where on the street segment the address is located. Addresses 


Point Matching Details 

This section describes the types of point-level geocodes returned by Geocode US Address. Point-level 

geocodes represent the center of a parcel or building. 

• Parcel Centroid—The geocode represents the center of a parcel. Addresses included in this count 

have a value of AP02 in the LocationCode output field. 

• Field-collected GPS—The geocode is determined using data collected by teams of field verification 

specialists who drive the roads of selected areas to verify and update the data. Addresses included 

in this count have a value of AP04 in the LocationCode output field. 

• Structure Centroid—The geocode represents the center of an addressable building footprint. An 

addressable structure is typically a structure that receives mail or has telephone service. Addresses 

included in this count have a value of AP05 in the LocationCode output field. 

• Manual Frontage Midpoint—The geocode represents the center of a the parcel's boundary with the 

street. These points are offset at a specific distance from the street centerline near the center of the 

side of the parcel that fronts the street segment. Street frontage points estimate address locations 

more accurately than do interpolated ranges. Addresses included in this count have a value of AP07 

in the LocationCode output field. 

• Unknown Point-Level Geocode—The type of geocode is not known. 

ZIP Centroid Matching Details 

This section describes the types of ZIP Code centroids and census centroids returned by Geocode US 

Address. 

• Location Accuracy—These fields describe the accuracy of the ZIP Code centroids. 

• ZIP + 4—The centroid indicates the center of a ZIP + 4 code. This is the most accurate type of ZIP 

centroid. Addresses included in this count have a value of 9 in the third character of the value in the 

LocationCode output field. 

• ZIP + 2—The centroid represents the center of a ZIP + 2 code. Addresses included in this count have 

a value of 7 in the third character of the value in the LocationCode output field. 

• ZIP Code—The centroid represents the center of a five-digit ZIP Code. This is the least accurate type 

of ZIP centroid. Addresses included in this count have a value of 5 in the third character of the value 

in the LocationCode output field. 

• Census Accuracy—These fields describe the accuracy of the census centroids. 

• Block Group—The centroid represents the center of a block group. This is the most accurate type of 

census centroid. Addresses included in this count have a value of that begins with ZB in the Location- 

Code output field. 

User's Guide 


493


494 

• Census Tract—The centroid represents the center of a census tract. Addresses included in this count 

have a value of that begins with ZT in the LocationCode output field. 

• County—The centroid represents the center of a county. This is the least accurate type of census 

centroid. Addresses included in this count have a value of that begins with ZC in the LocationCode 

output field. 

LACS/Link Statistics 

This section describes the results of LACS/Link address processing. For information on LACS/Link, see 

Locatable Address Conversion System (LACS) on page 299. 

• Records processed by LACS/Link—Addresses that were processed using LACS/Link. 

• LACS/Link Matched—Addresses that were matched to addresses in the LACS/Link database. 

• LACS/Link Matched w/ dropped unit info—Addresses whose secondary address information was 

removed in order to obtain a LACS Link match. 

• Not LACS/Link Matched—Addresses that Geocode US Address attempted to match to LACS Link but 

were not found in the LACS Link database. 

• Not LACS/Link Converted—The address matched a LACS Link record but was not converted. 

• Not LACS/Link Converted - highrise default—The address matched a highrise default record but 

was not converted. 

• Last LACS/Link false positive record—This is the record number within the input file of the last address 

to result in a false positive. For example, if the 5th record in the file was a LACS Link false positive, 

this field would contain "5". For more information on false positives, see Encountering False Positives 

on page 588. 

Delivery Point Validation 

This section describes the results of DPV address processing. For information on DPV, see Delivery 

Point Validation (DPV) on page 299. 

• Records processed by DPV—The number of addresses that were processed using DPV. 

• DPV Records with ZIP + 4—Addresses that contained a ZIP + 4 code and were processed by DPV. 

• DPV Confirmed—The number of addresses that were verified as deliverable addresses. 

• Primary Confirmed, Secondary Missing—The primary portion of the address (the house number 

and street) was verified. The address requires a secondary element (for example, a suite or apartment 

number) to be a deliverable address, and the secondary information was missing from the input address. 

• Primary Confirmed, Secondary Incorrect—The primary portion of the address (the house number 

and street) were verified. The address requires a secondary element (for example, a suite or apartment 

number) to be a deliverable address, and the secondary information in the input address was incorrect. 

• DPV CMRA Confirmed—Commercial Mail Receiving Agency (CMRA) addresses confirmed by DPV. 

• DPV Not Confirmed—Addresses that could not be verified as deliverable. 

• USPS Street Records Confirmed—Street addresses that were confirmed by DPV. 

• USPS General Delivery Records Confirmed—DPV processing confirmed that the address accepts 

general delivery mail. 

• Records with confirmed CMRA—Commercial Mail Receiving Agency (CMRA) addresses that were 

confirmed with DPV. 


• Records not confirmed CMRA—Commercial Mail Receiving Agency (CMRA) addresses that could 

not be confirmed with DPV. 

• DPV False Positive Seed table hits—Addresses that matched to DPV false positive records. For 

more information, see Encountering False Positives on page 588. 

Records with DPV Footnote 

This section lists the DPV footnote codes that were returned for the job. For an explanation of the DPV 

footnote codes, see DPV on page 477. 

USPS Firm Records 

This section describes the results of address validation for firm (business) addresses. 

• Confirmed—Geocode US Address confirmed that the address is a business address. 

• Confirmed with PMB presented—Geocode US Address confirmed that the address is a business 

address, and the business address contains a private mailbox (PMB). 

• Failed primary house number—Business addresses that contained a primary house number which 

could not be confirmed. 

• Failed secondary unit number—Business addresses that contained a secondary unit number which 


USPS Highrise Records 

This section describes the results of DPV processing for highrise addresses. 

• Confirmed—Highrise addresses that were confirmed by DPV. 

• Confirmed with PMB presented—Highrise addresses that contain a Private Mailbox (PMB) and were 

confirmed by DPV. 

• Conf. CMRA with/without PMB—Highrise addresses that are also CMRA addresses, and that did 

or did not contain a Private Mailbox (PMB) address element. 

• Failed primary house number—Highrise addresses that contained a primary house number which 


• Failed secondary unit number—Highrise addresses that contained a secondary unit number which 


USPS PO Box Records 

This section describes the results of DPV processing for PO box addresses. 

• Confirmed—PO Box addresses that were confirmed by DPV. 

• Failed primary box number—PO Box addresses that contained a primary box number which could 

not be confirmed. 

USPS Rural Route Records 

This section describes the results of DPV processing for rural route addresses. 

• Confirmed—Rural Route addresses that were confirmed by DPV. 

User's Guide 


495

GNAF PID Location Search 

• Conf. CMRA with/without PMB—Rural Route addresses that were also CMRA addresses, and that 

did or did not contain a Private Mailbox (PMB) address element. 

• PMB Presented—Rural Route addresses that contained a Private Mailbox (PMB) address element. 

• Failed primary house number—Rural Route addresses that contained a primary house number 

which could not be validated. 

USPS Street Records 

This section describes the results of DPV processing for street addresses. 

• Confirmed—Street addresses that were confirmed by DPV. 

• Confirmed with PMB presented—Street addresses that contained a Private Mailbox (PMB) and 

were confirmed by DPV. 

• Conf. CMRA with/without PMB—Street addresses that were also CMRA addresses, and that did or 

did not contain a Private Mailbox (PMB) address element. 

• Failed primary house number—Street addresses that contained a primary house number which 


• Failed secondary unit number—Street addresses that contained a secondary unit number which 



Input 

496 

GNAF PID Location Search identifies the address and latitude/longitude coordinates for a Geocoded 

National Address File Persistent Identifier (G-NAF PID). The G-NAF PID is a 14-character alphanumeric 

string that uniquely identifies each G-NAF address in the G-NAF database (a database of Australian 

locations). The PID is constructed from a combination of the major address fields of the G-NAF database. 

An example of a G-NAF PID is: 

GAVIC411711441 

Note: 

You must have the G-NAF database installed to use GNAF PID Location Search. 

GNAF PID Location Search is part of the Enterprise Geocoding Module. For more information on the 

Enterprise Geocoding Module, including a listing of other components included with it, see What is the 

Enterprise Geocoding Module? on page 290. 

GNAF PID Location Search takes a G-NAF PID as input. The following table provides information on 

the format and layout of the input. 

Note: 





Options 

Table 109: GNAF PID Location Search Input 

Field Name 

GNAFPID 

Format 

String 

Description/Valid Values 

The 14-character G-NAF persistent identifier you 

want to look up. For example: 

GAVIC411711441 

GNAF PID Location Search allows you to set default processing options through the Management 

Console. You can override certain settings for individual calls to GNAF PID Location Search using the 

API or MapInfo Spatial Server client tools, such as Enterprise Designer. 

The following sections describe the options that control GNAF PID Location Search processing. 


Table 110: GNAF PID Location Search Geocoding Options 

Option Name 

Point type 

Return 8 decimal places of parcel latitude/longitude 

User's Guide 


Specifies whether to return the parcel latitude/longitude or 

the street frontage latitude/longitude. This option is only 

available if you have the G-NAF database installed. This option 

only affects addresses matched to the G-NAF database. 



• Parcel—In a street address match, return the exact location 

of the parcel. This is the standard G-NAF point which is the 

exact authoritative point returned by the G-NAF database. 

Default. 

• Street frontage—In a street address match, return the 

street frontage point for the parcel. The street frontage point 

is 12.5 metres from the front boundary of the parcel. Street 

frontage points are more suitable for routing applications. 

Specifies whether to return the original latitude and longitude, 

precise up to eight digits after the decimal. This is the latitude/longitude 

that the candidate matched to in the G-NAF 

database. These are the original coordinates directly from 

the G-NAF data prior to truncation or rounding. This option is 

only available if you have the G-NAF database installed. This 

option only affects addresses matched to the G-NAF database. 

497


Data Options 

Output 

498 

Table 111: GNAF PID Location Search Data Options 

Option Name 

Database 


Specifies the database to use to look up the parcel. Use the database name 

specified in the Management Console's Database Resources tool. For more 

information, see Adding an Enterprise Geocoding Module International 

Database Resource on page 248. 

Note: 

Only database resources that contain G-NAF databases are available 

in this list. 

GNAF PID Location Search returns the following categories of data: 

The following tables list the output fields included in each category. 

Note: 





Field Name 

AddressLine1 

AddressLine2 



City 

Country 

County 

FirmName 

Description 




Unit number. 



The Local Government Authority (LGA). 



Field Name 

HouseNumber 




LastLine 


Locality 



PostalCode 

User's Guide 

Description 

Building number for the matched location. 

The highest house number of the range in which the address 

resides. 

The lowest house number of the range in which the address 

resides. 

Indicates if the house number range contains even or odd 

numbers or both. 

• E—Even 

• O—Odd 

• B—Both 


Complete last address line (city, state/province, and postal 

code). 

Street directional that precedes the street name. For example, 

the N in 138 N Main Street. 

This field is not used for this country. 

Indicates whether or not the address has a house number. 


• 0—The address has no house number. Examples of addresses 

that have no house number are P.O. box addresses 

and general delivery addresses. 

• 1—The address has a house number. For information about 

the range in which the house number falls, see the House- 

NumberHigh, HouseNumberLow, and HouseNumberParity 

fields. 

Indicates whether or not the address has a unit number, such 

as a suite number or apartment number. One of the following: 

• 0—The address has no unit number. 

• 1—The address has a unit number. For information about 

the range in which the unit number falls, see the UnitNumberHigh 


The postcode for the address. The format of the postcode 

varies by country. 

499


500 

Field Name 


PreAddress 


SegmentParity 

StateProvince 


StreetName 

StreetPrefix 

StreetSuffix 



UnitNumberLow 

Description 

The second part of a postcode. For example, for Canadian 

addresses this will be the LDU. This field is not used by most 

countries. 




• L—Left side of the street 

• R—Right side of the street 

• B—Both sides of the street 

• U—Undetermined 

The state name. 

The default search order rank of the database used to geocode 

the address. A value of "1" indicates that the database is first 

in the default search order, "2" indicates that the database is 

second in the default search order, and so on. 




The type of street when the street type appears before the 

base street name. For example, AVENUE: 


The street type of the matched location. For example, AVE for 

Avenue. 

Street directional that follows the street name. For example, 

the N in 456 Washington N. 






Field Name 


Latitude 

Longitude 

Result Codes 

Description 




Survey Group. 








Field Name 


IsCloseMatch 


Status 

User's Guide 

Description 






Y 

N 









501


502 

Field Name 

Status.Code 



Description 

null 

F 

Success 

Failure 


reason. 















System Error. 


Found. 


Found. 








0 

1 

2 

3 

4 


address. 






Field Name 

G-NAF Output 

Description 

5 

6 

7 

8 

9 

10 

11 

12 

13 

14 

15 

16 

17 


Intersection. 


















Field Name 

User's Guide 


Description 





 








503


504 

Field Name 




Description 

-1 




NAF dataset. 























0 

1 

2 

3 

4 

No geocode. 






geocode). 




Field Name 

User's Guide 

AUS.GNAF_PID 


Description 

5 

6 

7 











PID is: 

GAVIC411711441 









1 

2 

3 




















505

Reverse APN Lookup 

Field Name 



506 

Description 

Reverse APN Lookup allows you to look up an address using: 

4 

5 

6 






















• An Assessor's Parcel Number (APN). An APN is an ID number assigned to a piece of land by a county 

assessor. An APN is unique only within a county. 

• A FIPS county code. A Federal Information Processing Standard (FIPS) code is an ID number assigned 

to a county by the U.S. Federal government. 

• A FIPS state code. A FIPS state code is an ID number assigned to each state by the U.S. Federal 

government. 

These three pieces of information, used together, can uniquely identify a specific parcel. You must use 

all three pieces of information to perform a lookup using Reverse APN Lookup. 

Note: 

Reverse APN Lookup only works for U.S. addresses for which APN data is available. See the 

coverage map included with the points database for more information. 


Input 

Reverse APN Lookup is part of the Enterprise Geocoding Module. For more information on the Enterprise 

Geocoding Module, including a listing of other components included with it, see What is the Enterprise 

Geocoding Module? on page 290. 

Reverse APN Lookup takes an APN, FIPS county code, and FIPS state code as input. The following 

table provides information on the format and layout of the input. 

Note: 




Table 116: Reverse APN Lookup Input Data 

Field Name 

APN 

Options 

InputKeyValue 



Format 

String 

[45] 

String 

String [5] 

String [2] 


The assessor's parcel number (APN) for the property you 

want to look up. 

User-defined data, such as a record ID or source code. 

The FIPS county code for the county in which the property 

resides. 

The FIPS state code for the state in which the property 

resides. 

The following table lists the options that control Reverse APN Lookup processing. 

Table 117: Reverse APN Lookup Options 

Option Name 

Database 

User's Guide 

Latitude and longitude format 


Specifies the database to use to look up the parcel. Use the database 

name specified in the Management Console's Database Resources 

tool. For more information, see Adding an Enterprise Geocoding 

Module U.S. Database Resource on page 247 . 

Specifies the format for returned latitude/longitude. 

Decimal 


(90.000000-180.000000) Default. 

507


508 

Option Name 


Casing 


Integer 

(90000000-180000000) 

Specifies whether or not Reverse APN Lookup returns the elevation of 

the address. Elevation is the distance above or below sea level of a 

given location. The elevation is returned in the Elevation output field, 

which is part of the Latitude/Longitude output group. 


Centrus Premium Points database. Elevation data is not available 

for all addresses. See the coverage map included with the 

points database. 


Mixed 

Upper 


123 Main St 



123 MAIN ST 


Return descriptions in output Specifies whether or not Reverse APN Lookup provides an additional 

description field as output. This field provides the text equivalent to a 

field represented by a code. For example, LocationCode returns a code 

that indicates the accuracy (quality) of the assigned geocode. Location- 

Code.Description provides the description for the code returned. 

Include data 

Specifies optional data to include in the output. Note that Reverse APN 

Lookup always returns the default data listed in Default Output on page 

510. The data you select here is returned with the default output data. 

• Census 




• Range 

• Segment 

For a list of fields included in each record type, see Output on page 509. 


Output 

Option Name 



Reverse APN Lookup returns the following categories of data: 








If you do not want all of the fields in a group returned, do not select the 

group, and instead list only those fields you want returned in Include 

extra fields. 

Indicate the individual output fields you want returned. List fields with a 

pipe ( | ) between each field. You can use this field instead of the Include 

data field to limit the output to the specific fields you want. 

Default list: AddressLine1|LastLine|Longitude|Latitude|MatchCode|LocationCode 

The following tables list the output fields included in each category. 

Note: 

Census 



The Census output fields contain census information from the U.S. 2000 Census. To include census 

data in the output, select the Census check box under Include data. 

Table 118: Census Output Fields 

Field Name 

BlockSuffix 

CBSACode 

User's Guide 


Description 

Single character block suffix for split Census blocks. Returns A or B. 

Only available in Centrus Enhanced data. 

Indicates Core Based Statistical Area (CBSA). 

Denotes a subdivision of a CBSA. 


509


510 

Field Name 


CBSAMetro 

CBSAName 

CensusBlockID 

CensusTract 

CSACode 

CSAName 

USCountyName 



Description 

Describes a subdivision of a CBSA. Only returned when you set the 

configuration options to return additional descriptions (verbose). 

Metropolitan Statistical Area. Valid values include: 

Y 

N 

null 

Metro statistical area 

Micro statistical area 

Data unavailable 

Describes CBSA. Only returned when you set the configuration options 

to return additional descriptions (verbose). 

The ID of the Census Federal Information Processing Standard (FIPS) 

code. 

Six digits extracted from the CensusBlockID. 



Describes the name for a geographic entity that consists of 2 or more 

adjacent CBSAs with employment interchange measures of at least 15. 

Only returned when you set the configuration options to return additional 

descriptions (verbose). 

Name of the county, including the text "County" or "Parish." Only returned 

when you set the configuration options to return additional descriptions 

(verbose). 

Five-digit FIPS code for state and county extracted from the CensusBlockID. 

Reverse APN Lookup always returns the address, geocode, and result indicators. 



Field Name 

AdditionalInputData 

AddressLine1 

AddressLine2 

APN 

City 

Confidence 

Country 

Distance 

Elevation 

FirmName 

LastLine 

Latitude 

LocationCode 

Longitude 

MatchCode 

User's Guide 

Description 

Mailstop, attention line, or deliver instructions as included in the input 

data. This field is always null. 

Note: 

Reverse APN Lookup does not process this information. It simply 

includes the information as entered in the input data. 



The Assessor's Parcel Number that was specified in the input. 


Indicates the confidence in the output provided. The range is from 0 

(zero) to 100, with 0 being no match and 100 being an exact match. 

The name of the country. Since Reverse APN Lookup only works for 

U.S. locations, this field will always contain United States of America. 

The distance, in feet, of the dwelling along the segment. 

The distance in feet above or below sea level of the parcel. 

Name of the company. 


Complete last address line (municipality, state, and postal code). 

Seven-digit number in degrees and calculated to 4 decimal places (in 

the format specified). 

Indicates the accuracy (quality) of the assigned geocode. 

For more information, see Location Codes for U.S. Geocoding on 

page 554. 

Seven-digit number in degrees and calculated to 4 decimal places (in 

the format specified). 


511


512 

Field Name 

PercentGeocode 

PostalCode 



ProcessedBy 

StateProvince 

Status 

Status.Code 


Description 

For more information, see Match Codes for U.S. Geocoding on page 

571. 

The percent along the street segment that matches the geocode. For 

example, if the returned geocode falls 1/3 along the way of the entire 

street segment, the percent is 33.000. 

Note: 

This value is always 0.0 for matches to point-level data and intersections. 

Nine-digit ZIP Code with or without a hyphen. 

Four-digit ZIP Code extension. 

Five-digit ZIP Code. 

The feature code for the stage that processed the request. The value 

is KGL for Reverse APN Lookup. 

Two-character state abbreviation. 


null 

F 

Reason for failure: 


• No Address Found 


Description of the problem: 




Success 

Failure 


System Error. 

Returned when Status.code = No Address 

Found) 

Returned when Status.code = No Address 

Found. 


Field Name 


StreetSide 



USUrbanName 


Description 

The data set that Reverse APN Lookup attempted to match against. 

Indicates the side of the street for the range. 

LEFT 

RIGHT 

BOTH 

Left side of the street. 

Right side of the street. 

Both sides of the street. 

Three-digit FIPS county code specified in the input. 

Two-digit FIPS state code specified in the input. 

USPS ® urbanization name. Puerto Rican addresses only. 

The latitude/longitude output fields contain the geographic coordinates of the location. To include latitude/longitude 

output fields in the output, select the Latitude/Longitude check box under Include data. 


Field Name 

Latitude 

Longitude 


Description 


format specified). 



The Parsed Elements output fields contain standard address information as individual units, such as 

street suffixes (AVE) and leading directionals (N and SE). To include parsed elements in the output, 

select the Parsed Elements check box under Include data. 

User's Guide 


513


514 


Field Name 





City 


CrossStreetName 2 

CrossStreetSuffix 


HouseNumber 




Description 

Apartment designator (such as STE or APT), for example: 123 E Main 

St. APT 3 

Secondary apartment designator, for example: 123 E Main St. APT 3, 

4th Floor 

Apartment number, for example: 123 E Main St. APT 3 

Secondary apartment number, for example: 123 E Main St. APT 3, 4th 

Floor 


Leading directional, for example: 123 E Main St. Apt 3 

Cross street name, for example: 123 E Main St. Apt 3 

Cross street suffix, for example: 123 E Main St. Apt 3 

Cross street trailing directional, for example: 123 Pennsylvania Ave NW 

Building number, for example: 123 E Main St. Apt 3 

Note: 

This is an approximate building number based on the APN, FIPS 

county code, and FIPS state code provided. This approximate 

address may not exist or may not accept mail delivery. 

Leading directional, for example: 123 E Main St. Apt 3 

Private mailbox indicator. Not output for multiline input. 

The type of private mailbox. Possible values include: 

• Standard 

• Non-Standard 

2 Reverse APN Lookup only returns Cross street outputs if you entered an intersection as an address. For 

example, entering Pearl and 28th, Boulder, CO returns cross street information. Entering 2800 Pearl, 

Boulder, CO does NOT return cross street information. 


Field Name 

RRHC 

StreetName 

StreetSuffix 


Qualifiers 

Description 

Rural Route/Highway Contract indicator. 

Street name, for example: 123 E Main St. Apt 3 

Street suffix, for example: 123 E Main St. Apt 3 

Trailing directional, for example: 123 Pennsylvania Ave NW 

The qualifiers output fields contain qualification information on the match, such as the location code and 

the match code. To include qualifier output fields in the output, select the Qualifiers check box under 

Include data. 

Table 122: Qualifiers Output Fields 

Field Name 

CountryLevel 


EWSMatch 



Intersection 

User's Guide 

Description 

The category of postal data available. Always returns A in Reverse APN 

Lookup—Validates, corrects, and provides missing postal code, city 

name, state/county name, street address elements, and country name. 


Indicates if Reverse APN Lookup denied a match because of Early 

Warning System (EWS) data. 

Y 

null 

EWS denied a match. 

EWS did not deny a match. 

For more information on EWS, see Early Warning System (EWS) on 

page 300. 



Indicates if Reverse APN Lookup found a cross-street match. 

T 

F 


True, a cross-street match was found. 

False, a cross-street match was not found. 

515


516 

Field Name 

IsAlias 

LACSAddress 



RecordType 

Description 

Reverse APN Lookup located a matched record by an index alias. Returns 

3 characters. The first is an N for normal street match or A for alias 

match (including buildings, aliases, firms, etc.). The next 2 characters 

are: 

01 

02 

03 

04 

05 

06 

07 

08 







Spatial data street name alias (when using the 

Us_pw.gsi, Us_pe.gsi, Us_psw.gsi, or Us_pse.gsi file) 


Zip9w.gsu) 

LACS Link 

Indicates if Reverse APN Lookup converted an address due to the 

Locatable Address Conversion System (LACS). 

L 

null 

Converted 

Not converted 

For more information on LACS, see Locatable Address Conversion 

System (LACS) on page 299. 







• HighRise 


• Normal 




Field Name 



Range 

Description 



Y 

N 

U 

Default match 

Exact match 

Not matched 

Indicates the data used to obtain a match. 

0 

1 

2 

6 

7 

8 

9 




TeleAtlas data in the Cenrus GDT database. 



database. 


Auxiliary file data 

The range output fields contain information on the street range, such as the high and low unit numbers. 

To include range data fields in the output, select the Range check box under Include data. 

Table 123: Range Output Fields 

Field Name 

Alternate 

User's Guide 



Description 


B 

A 




points. 

House number high. 

House number low. 


517


518 

Field Name 





UnitNumberLow 


Segment 

Description 


E 

O 

B 

Even 

Odd 

Both 

4-digit ZIP Code extension high. 

4-digit Zip Code extension low. 

Unit number high. 

Unit number low. 


E 

O 

B 

Even 

The segment output fields contain information on the street segment identified by the data provider. To 

include segment data fields in the output, select the Segment check box under Include data. 

Table 124: Segment Output Fields 

Field Name 

BlockLeft 

BlockRight 



Description 

Odd 

Both 

Provides the Census FIPS Code that indicates the address is on the 

left side of the street. 


right side of the street. 

Current left Block suffix for Census 2000 Geography. Returns A or B. 


Current right Block suffix for Census 2000 Geography. Returns A or B. 



Field Name 

RoadClass 

PointCode 

SegmentCode 




SegmentLength 

SegmentParity 

Description 


1 

2 

The road is a major road. 

The road is a minor road. 

Unique point ID assigned by the data provider. This field is blank if the 

matched record is not from point-level data. 

Unique 10-digit segment ID assigned by the street network provider. 


F 

R 

B 

U 

Forward 

Reversed 

Both 

Undetermined 

A high range number in the segment. 

A low range number in the segment. 



L 

R 

B 

U 




Undetermined 

Reverse Geocode Address Global 

Reverse Geocode Address Global determines the address for a given latitude/longitude point. Reverse 

Geocode Address Global can determine addresses in many countries. The countries available to you 

depends on which country databases you have installed. For example, if you have databases for Canada, 

Italy, and Australia installed, Reverse Geocode Address Global would be able to geocode addresses in 

these countries in a single stage. 

User's Guide 


519


Input 

520 

Note: 

Reverse Geocode Address Global does not support U.S. addresses. To geocode U.S. addresses, 

use Reverse Geocode US Location. Also, reverse geocoding is not available for the U.K. 

Before you can work with Reverse Geocode Address Global, you must define a global database resource 

containing a database for one or more countries. Once you create the database resource, a Reverse 

Geocode Address Global will become available in the Management Console, Enterprise Designer, and 

Interactive Driver. For information on creating a database resource, see Adding an Enterprise Geocoding 

Module Global Database Resource on page 246. 

Reverse Geocode Address Global is an optional component of the Enterprise Geocoding Module. For 

more information on the Enterprise Geocoding Module, see What is the Enterprise Geocoding Module? 

on page 290. 

Reverse Geocode Address Global takes longitude and latitude as input. 

Note: 




Table 125: Reverse Geocode Global Input 

Field Name 

Latitude 

Longitude 

Country 

Format 

String 

String 

String 


The latitude of the point for which you want address information. 

The longitude of the point for which you want address information. 


• The name of the country in English. 

• The two-character ISO 3116-1 alpha-2 country code. 

• The three-character ISO 3116-1 alpha-3 country code. 


Options 



Option Name 

Search distance 

Units 

User's Guide 



The radius from the input coordinates in which to search for an address. 

Street segments and points within the radius are considered. The default 

search radius is 150 meters and the maximum search radius is 1600 

meters. 

The units in which the search distance is specified. One of the following: 

• Feet 

• Miles 

• Meters 




Units field. 

Note: 


(JPN). 












(ZAF). 







521


522 

Option Name 
















Note: 


(JPN). 











(ZAF). 


Option Name 

Units 

User's Guide 




points. 



Note: 

• Feet 

• Miles 

• Meters 



(JPN). 









EPSG:4230 

EPSG:4283 

EPSG:4301 

EPSG:4326 

EPSG:27200 






523


524 

Option Name 



Option Name 


Data Options 


EPSG:27700 



Specifies whether to return results when the coordinates matche to 

multiple candidate addresses in the database. If this option is not selected, 

coordinates that results in multiple address candidates will fail to 

geocode. 



The Data tab allows you to specify which databases to use in reverse geocoding. Databases contain 

the address and geocode data necessary to determine the address for a given point. The following table 

lists the options available for specifying the search order of databases. 


Option Name 


search list 
















Output 

Option Name 


Note: 



geocoder. 





248. 












street level. 

If you are using the MapInfo Spatial Server API the output returned is in the DataTable class. 

For information on the DataTable class, see the "API Fundamentals" section of the MapInfo 

Spatial Server API Guide. 

Table 129: Reverse Geocode Address Global Output Fields 

Field Name 

AddressLine1 

AddressLine2 



City 

User's Guide 

Description 




Unit number. 



525


526 

Field Name 

County 

Description 









































Field Name 

Distance 

FirmName 


HouseNumber 




LastLine 


Locality 

User's Guide 

Description 






The distance from input location in meters. If the input coordinates are 

an exact match for the address, the value is 0. 


Indicates how closely the input coordinates match the candidate address. 

For more information, see Reverse Geocoding Codes (R category) 

on page 580. 






both. 

E 

O 

B 

U 

Even 

Odd 

Both 

Unknown 










527


528 

Field Name 


Description 



EA) 






































Field Name 


PostalCode 


PreAddress 

User's Guide 


SegmentCode 

SegmentParity 

StateProvince 

Description 

0 

1 









0 

1 






country. 








L 

R 

B 

U 




Undetermined 






529


530 

Field Name 


Description 








































Field Name 

StreetName 

StreetPrefix 

StreetSuffix 



UnitNumberLow 

Description 









Reverse Geocode US Location 






Reverse Geocode US Location takes a latitude and longitude point as input and returns the address that 

is the best match for that point. For example, you could enter the following information: 

Longitude: -105239771 Latitude: 40018912 Search Distance: 150 feet 

This input would result in the following output: 

4750 WALNUT ST BOULDER, CO 80301-2538 

MatchCode = NS0 

LocCode = AS0 

Lon = -105239773 

Lat = 40018911 

Distances: 

Search = 150 

Offset = 50 

Squeeze = 50 

Nearest = 50.0 

Pct Geocode = 94.0 

SegID = 472881795 

PtID = GDT 

Block = 080130122032066 

User's Guide 


531


Input 

532 

County Name = BOULDER COUNTY 

DPBC = 50 

Note: 

The address returned is an approximate address based on the latitude and longitude provided. 

This approximate address may not exist or may not accept mail delivery. 

Reverse Geocode US Location is part of the Enterprise Geocoding Module. For more information on 

the Enterprise Geocoding Module, including a listing of other components included with it, see What is 

the Enterprise Geocoding Module? on page 290. 

Reverse Geocode US Location processes geocodes in the following order: 

1. Reverse Geocode US Location defines a small rectangle based on your input geocode and search 

distance. 

2. Reverse Geocode US Location computes the distance between each street segment and the input 

location. 

3. If one segment is closest, Reverse Geocode US Location finds the offset and interpolated percentage 

(using the squeeze factor) and the street side. It then computes an approximate house number based 

on this information. 

If there is more than one segment that is equally close to the input location, a multi-match occurs. 

Reverse Geocode US Location returns the information for all of the equally close segments so that 

you can determine which segment is applicable. 

4. Reverse Geocode US Location returns the address information, including the segment range, the 

approximate house number, and the parity of the range along with other standard address information. 

Although many of the standard address matching outputs apply to the reverse geocoding option, 

several outputs are unavailable (such as LACS Link Note: 

information and unit numbers). Reverse 

Geocode US Location returns these outputs as blank. Reverse Geocode US Location also has 

outputs specific to reverse geocode processing, such as specific match codes and the distance 

from the input location to the matched segment. 

To use Reverse Geocode US Location, you need additional data files, called GSX files. There is an option 

to install these files when you install the geocoding database. The GSX files must be installed the GSX 

subdirectory of the geocoding database. If you install the Centrus Enhanced Points, Centrus Premium 

Points, or Centrus TeleAtlas Points database, you must recreate the GSX files. For information on using 

the GSX files, see the Centrus Utilities Manual. You can find the manual at www.g1.com/support . 

Reverse Geocode US Location takes longitude and latitude information as input. The following table 

provides information on the format and layout of the input. 

Note: 





Table 130: Reverse Geocode US Location Input Data 

Field Name 

Latitude 

Options 

Longitude 

Format 

String 

String 


Latitude of the point for which you want address information 

returned. Specify latitude in millionths of decimal degrees. 

Longitude of the point for which you want address information 

returned. Specify longitude in millionths of decimal degrees. 

Reverse Geocode US Location allows you to set default processing options through the Management 

Console. You can override certain settings for individual calls to Reverse Geocode US Location using 

the API or MapInfo Spatial Server client tools, such as Enterprise Designer. 

The following tables provides information on the processing options. 

Configuration Options 

The following table lists the configuration options for Reverse Geocode US Location. 

Table 131: Reverse Geocode US Location Configuration Options 

Option 

Database 

User's Guide 

Search distance 

Nearest Address 

Nearest Unranged 


The name of the database that contains the data to use in the search 


Database Resources tool. For more information, seeAdding an Enterprise 

Geocoding Module U.S. Database Resource on page 247. 

Specifies the radius, in feet, that Reverse Geocode US Location search 

for matches. The range is 0 - 5280 feet, with a default value of 150 feet. 

Specifies whether or not Reverse Geocode US Location should find the 

nearest address to the input geocode. 

Note: 

You can use this option with the Nearest Intersection option to 

geocode to both addresses and intersections. 

Specifies whether or not Reverse Geocode US Location can match to 

a street segment that does not have a number range. This option is 

active when Nearest Address is selected. 

Note: 


If you are using the point-level data option, Reverse Geocode 

US Location ignores the Nearest Unranged option. 

533


534 

Option 

Nearest Intersection 

Determine Assessor's Parcel 

Number 

Offset 


Specifies whether or not Reverse Geocode US Location should find the 

nearest street intersection to the input geocode. 

Note: 

You can use this option with the Nearest address option to 

geocode to both addresses and intersections. 

Specifies whether or not Reverse Geocode US Location should determine 

the address's APN (assessor's parcel number). The APN is an ID 

number assigned to a property by the local property tax authority. The 

APN is returned in the APN output field, which is part of the Census 

output group. 


Cenrus Enhanced Points or Centrus Premium Points database. 

APN data is not available for all addresses. See the coverage 

map included with the points database. 

Specifies the offset distance from the street segments. The range is 0 

- 5280 feet, with the default value of 50 feet. 















Option 

Squeeze 

User's Guide 

Latitude/Longitude format 



Street coordinates are accurate to 1/10,000th of a degree and interpolated 

points are accurate to 1/1,000,000th of a degree. 

Specifies the distance, in feet, to squeeze the street end points in streetlevel 

geocoding. The range is 0 -2147483647 feet, with the default value 

of 50 feet. The following diagram compares the end points of a street 

to squeezed end points. 

Specifies the format to use for returned latitude/longitude. 

Decimal 

Integer 


The format is 90.000000-180.000000. Default. 

The format is 90000000-180000000. 

Specifies whether or not Reverse Geocode US Location returns the elevation 

of the address. Elevation is the distance above or below sea 

level of a given location. The elevation is returned in the Elevation 

output field, which is part of the Latitude/Longitude output group. 

535


536 

Option 

Output Format 



Centrus Premium Points database. Elevation data is not available 

for all addresses. See the coverage map included with the 

points database. 

The following table lists the options that control the format of the output . 

Table 132: Reverse Geocode US Location Output Format Options 

Option 

Casing 



Mixed 

Upper 


123 Main St 



123 MAIN ST 


Return descriptions in output Specifies whether or not Reverse Geocode US Location provides an 

additional description field as output. This field provides the text equivalent 

to a field represented by a code. For example, LocationCode returns 

a code that indicates the accuracy (quality) of the assigned geocode. 

LocationCode.Description provides the description for the code returned. 

Output Data 

The following table lists the options that control which data is returned by Reverse Geocode US Location. 

Table 133: Reverse Geocode US Location Output Data Options 

Option 

Include data 


Specifies the optional data to include in the output. Note that Reverse 

Geocode US Location always returns the data listed in Default Output 


Output 

Option 



on page 539. The data you select here is returned with the default output 

data. 

• Census 




• Range 

• Segment 

For a list of the fields included in each data type, see Output on page 

537. 

If you do not want all of the fields in a record type returned, do not select 

the check box. Instead, list only those fields you want returned in Include 

extra fields. 

Specifies the individual output fields you want returned. List fields with 

a pipe ( | ) between each field. You can use this field instead of the 

Output Record Type to limit the output to those fields that are important 

to your data needs. 

Default list: AddressLine1|LastLine|Longitude|Latitude|MatchCode|LocationCode 

Reverse Geocode US Location returns the following categories of data: 








The following tables lists the output fields included in each category. 

Note: 

Census 



The Census output record type contains census information from the U.S. 2000 Census. To include 

census data in the output, select the Census check box under Output Record Type. 

User's Guide 


537


538 

Table 134: Census Output Fields 

Field Name 

APN 

BlockSuffix 

CBSACode 



CBSAMetro 

CBSAName 

CensusBlockID 

CensusTract 

CSACode 

CSAName 

USCountyName 

Description 

The assessor's parcel number of the property. The assessor's parcel 

number is an ID number assigned to a property by the local property 

tax authority. 

Single character block suffix for split Census blocks. Returns A or B. 


Indicates Core Based Statistical Area (CBSA). 

Denotes a subdivision of a CBSA. 

Describes a subdivision of a CBSA. Only returned when you set the 

configuration options to return additional descriptions (verbose). 

Metropolitan Statistical Area. Valid values include: 

Y 

N 

null 

Metro statistical area. 

Micro statistical area. 

Data unavailable. 

Describes CBSA. Only returned when you set the configuration options 

to return additional descriptions (verbose). 

The ID of the Census Federal Information Processing Standard (FIPS) 

code. 

6-digits extracted from the CensusBlockID. 



Describes the name for a geographic entity that consists of 2 or more 

adjacent CBSAs with employment interchange measures of at least 15. 

Only returned when you set the configuration options to return additional 

descriptions (verbose). 

Name of the county, including the text "County" or "Parish." Only returned 

when you set the configuration options to return additional descriptions 

(verbose). 


Field Name 





Description 

3-digit FIPS county code extracted from the CensusBlockID. 

2-digit FIPS state code extracted from the CensusBlockID. 

5-digit FIPS code for state and county extracted from the CensusBlockID. 

Reverse Geocode US Address always includes the following fields in the output. 


Field Name 

AdditionalInputData 

AddressLine1 

AddressLine2 

City 

Confidence 

Country 

Distance 

Elevation 

FirmName 

LastLine 

User's Guide 

Description 

Mailstop, attention line, or deliver instructions as included in the input 

data. 

Note: 

Reverse Geocode US Location does not process this information. 

It simply includes the information as entered in the input 

data. 




Indicates the confidence in the output provided. The range is from 0 

(zero) to 100, with 0 being no match and 100 being an exact match. 

Country name. 

The distance, in feet, of the dwelling along the segment. 


Name of the company. 


Complete last address line (municipality, state, and postal code). 

539


540 

Field Name 

Latitude 

LocationCode 

Longitude 

MatchCode 

PercentGeocode 

PostalCode 



ProcessedBy 

RRHC 

StateProvince 

Status 

Status.Code 

Description 



Indicate the accuracy (quality) of the assigned geocode. 

For more information, see Location Codes for U.S. Geocoding on 

page 554. 




For more information, see Match Codes for U.S. Geocoding on page 

571. 

The percent along the street segment that matches the geocode. For 

example, if the returned geocode falls 1/3 along the way of the entire 

street segment, the percent is 33.000. 

Note: 

This value is always 0.0 for matches to point-level data and intersections. 

9-digit ZIP Code with or without a hyphen. 

4-digit ZIP Code extension. 

5-digit ZIP Code. 

The underlying software that processed the request. KGR for Reverse 

Geocode US Location. 

Rural Route Highway Contract (RRHC). This field is null if the address 

not a RRHC. 

2-character state abbreviation. 


null 

F 

Reason for failure: 

Success 

Failure 


Field Name 



StreetSide 

USUrbanName 


Description 




Description of the problem: 




Returned when Status.Code contains "Internal 

System Error." 

Returned when Status.code contains "No 

Geocode Found". 

Returned when Status.code contains "No 

Geocode Found." 

The data set that Reverse Geocode US Location attempted to match 

against. 

Indicates the side of the street for the range. 

LEFT 

RIGHT 

BOTH 




Urbanization name. Puerto Rico addresses only. 

The latitude/longitude output fields contain the geographic coordinates of the location. To include latitude/longitude 

output fields in the output, select the Latitude/Longitude check box under Output Record 

Type. 


Field Name 

Elevation 

Latitude 

User's Guide 

Description 





541


542 

Field Name 

Longitude 


Description 



The Parsed Elements output record type contains standard address information as individual units, such 

as street suffixes (AVE) and leading directionals (N and SE). To include parsed elements in the output, 

select the Parsed Elements check box under Output Record Type. 


Field Name 






CrossStreetName 

CrossStreetSuffix 


HouseNumber 



Description 

Unit, such as apartment, suite, or lot. 

Unit, such as apartment, suite, or lot. 

Unit number. 

Unit number. 

Prefix for cross street. 

Name of cross street. 

Cross street suffix. 

Postfix for cross street. 

Building number for the matched location. 

Note: 

This is an approximate building number based on the latitude 

and longitude provided. This approximate address may not exist 

or may not accept mail delivery. 



Private mailbox. Not output for multiline input. 


Field Name 


StreetName 

StreetSuffix 


Qualifiers 

Description 

Private mailbox description. Not output for multiline input. 

Street name. 




The qualifiers output record type contains qualification information on the match, such as the location 

code and the match code. To include latitude/longitude output fields in the output, select the Qualifiers 

check box under Output Record Type. 

Table 138: Qualifiers Output Fields 

Field Name 

CountryLevel 


EWSMatch 



Intersection 

User's Guide 

Description 

The category of postal data available. Always returns A in Reverse 

Geocode US Location—Validates, corrects, and provides missing postal 

code, city name, state/county name, street address elements, and 

country name. 


Indicates if Reverse Geocode US Location denied a match because of 

Early Warning System (EWS) data. 

Y 

null 

EWS denied a match. 

EWS did not deny a match. 

For more information on EWS, see Early Warning System (EWS) on 

page 300. 



Indicates if Reverse Geocode US Location found a cross-street match. 

T 


True, a cross-street match was found. 

543


544 

Field Name 

IsAlias 

LACSAddress 



RecordType 

Description 

F 

False, a cross-street match was not found. 

Reverse Geocode US Location located a matched record by an index 

alias. Returns 3 characters. The first is an N for normal street match or 

A for alias match (including buildings, aliases, firms, etc.). The next 2 

characters are: 

01 

02 

03 

04 

05 

06 

07 

08 







Spatial data street name alias (when using, the 

Us_pw.gsi, Us_pe.gsi, Us_psw.gsi, or Us_pse.gsi file is 

required) 


Zip9w.gsu) 

LACS Link 

Indicates if Reverse Geocode US Location converted an address due 

to the Locatable Address Conversion System (LACS). 

L 

null 

Converted 

Not converted. 

For more information on LACS, see Locatable Address Conversion 

System (LACS) on page 299. 







• HighRise 



Field Name 




Range 

Description 

• Normal 





Y 

N 

U 

Default match. 

Exact match. 

Not matched. 

Indicates the data used to obtain a match. 

0 

1 

2 

6 

7 

8 

9 







database. 



Indicates the data first used to attempt a match. 

The range output record type contains information on the street range, such as the high and low unit 

numbers. To include range data fields in the output, select the Range check box under Output Record 

Type. 

Table 139: Range Output Fields 

Field Name 

Alternate 

User's Guide 

Description 


B 




545


546 

Field Name 







UnitNumberLow 


Segment 

Description 

A 


points. 

House number high. 

House number low. 


E 

O 

B 

Even 

Odd 

Both 

4-digit ZIP Code extension high. 

4-digit Zip Code extension low. 

Unit number high. 

Unit number low. 


E 

O 

B 

The segment output record type contains information on the street segment identified by the data provider. 

To include segment data fields in the output, select the Segment check box under Output Record Type. 

Table 140: Segment Output Fields 

Field Name 

BlockLeft 

Description 

Even 

Odd 

Both 


left side of the street. 


Field Name 

BlockRight 



RoadClass 

User's Guide 

SegmentCode 




SegmentLength 

SegmentParity 

Description 


right side of the street. 

Current left Block suffix for Census 2000 Geography. Returns A or B. 


Current right Block suffix for Census 2000 Geography. Returns A or B. 



1 

2 

Major 

Minor 

Unique 10-digit segment ID assigned by the street network provider. 


F 

R 

B 

U 

Forward 

Reversed 

Both 

Undetermined 

A high range number in the segment. 

A low range number in the segment. 



L 

R 

B 

U 




Undetermined 


547

Geocode US Address Auxiliary Files 


Auxiliary File Overview 

Use auxiliary files to match against special data that is not included in the Geocode US Address database. 

The Geocode US Address database is updated regularly to incorporate changes made by the USPS 

and third-party data vendors. You may have newer information that has not yet been incorporated. 

Auxiliary files provide a way for you to process your input records against a file that includes these 

changes. 

Note: 

Reverse Geocode US Address does not support auxiliary files. 

There are two types of auxiliary file records: 

• Street Records—Contains a range of one or more addresses on a street. For required fields, see 

Auxiliary File Layout on page 550. A street record must not have secondary address information 

mailstops, Private mail boxes (PMBs), and PO Boxes. 

• Landmark Records—Represents a single site. For required fields, see Auxiliary File Layout on 

page 550. A landmark record must not have street type abbreviations, predirectional and postdirectional 

abbreviations, or low and high house numbers. 

Note: 

You cannot update the auxiliary file while Geocode US Address is running. If you want to update 

the auxiliary file, stop Geocode US Address before attempting to replace or edit the file. 

Matching to Auxiliary Files 

548 

Geocode US Address matches an input address to an auxiliary file as follows: 

1. Geocode US Address determines if there is an auxiliary file present. 

If you have an auxiliary file in the dataset directory, Geocode US Address automatically loads and 

attempts to match to the auxiliary file. You can verify that Geocode US Address found an auxiliary 

file by looking at the version information page in the Management Console. One of the following 

statuses display: 

• Loaded—An auxiliary file is loaded 

• None—An auxiliary file has not been found or loaded 

• Invalid—An auxiliary file was found, but failed to successfully load 

Geocode US Address only accepts one auxiliary file. If more than one auxiliary files is present, 

Geocode US Address attempts to match against the first file. Geocode US Address ignores any additional 

auxiliary files for matching, regardless if Geocode US Address found a match to the first 

auxiliary file. 

If a record in the auxiliary files is invalid, Geocode US Address returns a invalid record message. 

Geocode US Address continues to match input addresses with the auxiliary file, but will not match 

to the invalid auxiliary file record. 

2. If an auxiliary file is present, Geocode US Address attempts to match to the auxiliary file. 


Geocode US Address assumes that the auxiliary file is the most accurate data set and attempts to 

find a match to the input address in the auxiliary file. If Geocode US Address cannot find a match in 

the auxiliary file, it matches the input address with the other Enterprise Geocoding Module databases. 

Note: 

Geocode US Address only matches input address lists to auxiliary files if there is an exact 

match. Your input address list should be free of misspellings and incomplete addresses. 

3. If Geocode US Address finds an exact record match to the auxiliary file, it standardizes the match 

to USPS regulations and returns the output of the auxiliary file match. 

Geocode US Address uses the following defaults if you do not include the values in the auxiliary file: 

• House number parity = B (both odds and evens) 

• Segment direction = A (ascending) 

• Side of street = U (unknown) 

Record Type Matching Rules 

When matching against an auxiliary file, Geocode US Address uses the following rules: 

Street record match 

• The input house number must fall within or be equal to the low and high house number values of the 

auxiliary record. 

• The input house number must agree with the parity of the auxiliary record. 

• The input ZIP Code must exactly match the ZIP Code of the auxiliary record. 

Landmark record match 

• The input data must contain a ZIP Code and address line, and the values must exactly match the 

values on the auxiliary record. 

• The input address cannot have any other data, such as a house number, unit number, or Private Mail 

Box (PMB). 

Note: 

Geocode US Address only matches the ZIP Code against the auxiliary file. Geocode US Address 

does not verify that the ZIP Code of the input address record is correct for the city and state. 

Validate this information in your input lists before processing against the auxiliary file. 

Unavailable Features and Functions 

The following features and functions do not apply when Geocode US Address makes an auxiliary file 

match. 

• Geocode US Address does not match to 

• two-line addresses 

• multi-line addresses 

• intersection addresses 

• dual addresses 

• Geocode US Address does not perform EWS, ZIPMove, LACSLink, or DPV processing on auxiliary 

matches 

• You can only access the auxiliary file with processing through the Find function. You cannot access 

the auxiliary file through the Find First/Next or MBR functions 

• You can only access the auxiliary file logic using the address code option of the Find function, not the 

geocode option. 

User's Guide 


549


Auxiliary Match Output 

Geocode US Address provides special data type, match codes, and location code values for auxiliary 

matches. When Geocode US Address finds a match to an auxiliary file, the default output follows these 

conventions: 

• Geocode US Address formats the auxiliary file match as a street-style address for output. This excludes 

PO Boxes, Rural Routes, General Delivery, etc. 

• Geocode US Address follows the case setting you indicate (by default, upper case) by the casing 

function. Geocode US Address does not maintain the casing in the auxiliary file for mixed casing values. 

For example, Geocode US Address returns O'Donnell as ODONNELL or Odonnell depending on the 

setting of the casing function. 

Note: 

Geocode US Address does not change the casing for the User Data field. 

• Geocode US Address removes spaces at the beginning and ending of fields in the auxiliary file. 

Note: 

Geocode US Address does not remove spaces for the User Data field. 

Auxiliary File Layout 

550 

You must comply with the following organizational rules when you create auxiliary file: 

• Files are fixed-width text files with a .gax extension 

• Files can contain up to 500,000 records. 

• Use semicolons in the first column to indicate a row is a comment, not a data record; Geocode US 

Address ignores rows that begin with a semicolon. 

• For optimal performance, order the records within the file by descending ZIP Code, and then descending 

street name. 

• Records must represent only one side of a street. To represent both sides of a street, create a record 

for each side of the street. 

• Records must represent segments that are straight lines. 

• House numbers must follow USPS rules documented in Publication 28. 

• Numeric fields, such as ZIP Codes, must contain only numbers. 

• If house numbers are present in the record, the house number range must be valid according to USPS 

rules documented in Publication 28, Appendix E. 

• Latitude and Longitude values must be in millionths of decimal degrees. 

• Records cannot contain PO Box addresses. 

The following table shows auxiliary file layout. 


Table 141: Auxiliary File Layout 

Field 

ZIP Code 

Street name 

Street type abbreviation 

Predirectional 

Description 

5-digit ZIP Code. 

Name of the street or 

landmark. 

Street type. Also called 

street suffix. 

See the USPS Publication 

28, Appendix C for 

a complete list of supported 

street types. 

USPS street name 

predirectional abbreviation. 

Supported values 

are N, E, S, W, 

NE, NW, SE, and SW. 

Postdirectional USPS street name 

postdirectional abbreviations. 

Supported values 

are N, E, S, W, 

NE, NW, SE, and SW. 

RESERVED 

Low house 

number 

High house 

number 

House number 

parity 

User's Guide 

RESERVED 

Low house number of 

the address range. 

High house number of 

the address range. 

Indicates the parity of 

the house number in 

the range. 

Required 

X 

X 

X 

X 

Required 

for 

Street 

Segment 

Match 

X 

X 

X 

X 


Required 

for Landmark 

Match 

X 

X 

Exact 

Match 

Required 

if 

Present 

X 

X 

X 

X 

X 

Length 

5 

30 

4 

2 

2 

4 

11 

11 

1 

Position 

1-5 

6-35 

36-39 

40-41 

42-43 

44-47 

48-58 

59-69 

70 

551


552 

Field 

Segment direction 

RESERVED 

FIPS state 

FIPS county 

Census tract 

Census block 

group 

Census block 

ID 

RESERVED 

State abbreviation 

County name 

MCD code 

Description 

E - Even 

O - Odd 

B - Both 

Direction the house 

numbers progress 

along the segment: 

F - Forward (default) 

R - Reverse 

RESERVED 

US government FIPS 

state code. 

US government FIPS 

county code. 

US Census tract number. 

US Census block 

group number. 

US Census block ID 

number. 

RESERVED 

USPS state abbreviation. 

Name of the county. 

Minor Civil Division 

code. 

Required 

Required 

for 

Street 

Segment 

Match 

Required 

for Landmark 

Match 

Exact 

Match 

Required 

if 

Present 

Length 

1 

1 

2 

3 

6 

1 

3 

5 

2 

25 

5 

Position 

71 

72 

73-74 

75-77 

78-83 

84 

85-87 

88-92 

93-94 

95-119 

120-124 


Field 

MCD name 

CBSA code 

CBSA name 

RESERVED 

City Name 

RESERVED 

User-defined 

data 

Record ID 

Number 

Side of street 

User's Guide 

Description 

Minor Civil Division 

name. 

Core Based Statistical 

Area code. 

Core Based Statistical 

Area name. 

RESERVED 

City name. Overrides 

the city/state preferred 

city name upon a return. 

RESERVED 

User-defined data. 

User-defined unique 

record identifier. 

Side of the street for 

the address: 

L - Left side 

R - Right side 

B - Both sides 

U - Unknown side (default) 

This is relative to the 

segment endpoints 

and the segment direction. 

Required 

Required 

for 

Street 

Segment 

Match 


Required 

for Landmark 

Match 

Exact 

Match 

Required 

if 

Present 

Length 

40 

5 

49 

5 

40 

237 

300 

10 

1 

Position 

125-164 

165-169 

170-218 

219-223 

224-263 

264-500 

501-800 

801-810 

811 

553

Location Codes for U.S. Geocoding 

Field 

Beginning longitude 

Beginning latitude 

Ending longitude 

Ending latitude 

Description 

Beginning longitude of 

the street segment in 

millionths of degrees. 

Beginning latitude of 

the street segment in 

millionths of degrees. 

Ending longitude of the 

street segment in millionths 

of degrees. 

Ending latitude of the 

street segment in millionths 

of degrees. 

Required 

X 

Required 

for 

Street 

Segment 

Match 

X 

Required 

for Landmark 

Match 


554 

X 

X 

X 

X 

Exact 

Match 

Required 

if 

Present 

Length 

11 

10 

11 

10 

Position 

812-822 

823-832 

833-843 

844-853 

Geocoding components return location codes indicating the accuracy of the assigned geocode. There 

are three types of geocodes: 

• Address location codes—Location codes that begin with an "A" are address location codes. Address 

location codes indicate a geocode made directly to a street network segment (or two segments, in the 

case of an intersection). For more information, see Address Location Codes on page 555. 

• Street centroid location codes—Location codes that begin with "C" are street centroid location codes. 

Street centroids may be returned if the street centroid fallback option is enabled and an address-level 

geocode could not be determined. For more information about street centroid location codes, see 

Street Centroid Location Codes on page 565. 

• ZIP + 4 centroid location codes—Location codes that begin with a "Z" are ZIP + 4 centroid location 

codes. ZIP + 4 centroids indicate a geocode could not be determined for the address, so the location 

of the center of the address's ZIP + 4 was returned instead. For more information, see ZIP + 4 Centroid 


• Geographic centroid location codes—Location codes that begin with "G" are geographic centroid 

location codes. Geographic centroids may be returned if the street centroid fallback option is enabled 

and an address-level geocode could not be determined. For more information about street centroid 

location codes, see Street Centroid Location Codes on page 565. 


• Location unavailable—Location codes that begin with "E" indicate that neither an address location 

nor a ZIP + 4 centroid could be determined. This usually occurs when you have requested ZIP Code 

centroids of a high quality, and one is not available for that match. For more information, see Address 


Address Location Codes 

Address location codes detail the known qualities about the geocode. 

An address location code has the following characters. 

1 st character 

2 nd character 

3 rd and 4 th character 

Table 142: Address Location Codes 

Code 

AGn 

User's Guide 

Always an A indicating an address location. 

May be one of the following 

C 

G 

I 

P 

R 

S 

X 


Interpolated address point location 

Auxiliary file data location 

Application infers the correct 

segment from the candidate records 

Point-level data location 

Location represents a ranged address 

Location on a street range 

Digit indicating other qualities about the location. 

Location on an intersection of two 

streets 

Description 

Indicates an auxiliary file for a 

geocode match where n is one of 

the following values: 

555


556 

Code 

APnn 

n = 0 

n = 1 

n = 2 

n = 3 

nn = 02 

nn = 04 

nn = 05 

Description 

The geocode represents the center 

of a parcel or building. 

The geocode is an interpolated 

address along a segment. 

The geocode is an interpolated 

address along a segment, and 

the side of the street cannot be 

determined from the data 

provided in the auxiliary file record. 

The geocode is the midpoint of 

the street segment. 

Indicates a point-level geocode 

match representing the center of 

a parcel or building, where nn is 

one of the following values: 

Parcel centroid 

Indicates the center of an accessor's 

parcel (tract or lot) polygon. 

When the center of an irregularly 

shaped parcel falls outside 

of its polygon, the centroid is 

manually repositioned to fall inside 

the polygon as closely as 

possible to the actual center. 

Address points 

Represents field-collected GPS 

points with field-collected address 

data. 

Structure centroid 

Indicates the center of a building 

footprint polygon, where the 

building receives mail or has 

telephone service. 


Code 

User's Guide 

nn = 07 

nn = 08 


Description 

Usually a residential address 

consists of a single building. For 

houses with outbuildings (detached 

garages, shed, barns, 

etc.), only the residences have a 

structure point. Condominiums 

and duplexes have multiple points 

for each building. Larger buildings, 

such as apartment complexes, 

typically receive mail at 

one address for each building and 

therefore individual apartments 

are not represented as discrete 

structure points. 

Shopping malls, industrial complexes, 

and academic or medical 

center campuses where one 

building accepts mail for the entire 

complex are represented as 

one point. When addresses are 

assigned to multiple buildings 

within one complex, each addressed 

structure is represented 

by a point. 

If the center of a structure falls 

outside of its polygon, the center 

is manually repositioned to fall 

inside the polygon. 

Manually placed 

Address points are manually 

placed to coincide with the midpoint 

of a parcel's street frontage 

at a distance from the center line. 

Front door point 

Represents the designated 

primary entrance to a building. If 

a building has multiple entrances 

and there is no designated 

primary entrance or the primary 

entrance cannot readily be determined, 

the primary entrance is 

557


558 

Code 

AIn 

ASn 

nn = 09 

nn = 10 

nn=21 

AIn and ASn share the same qualities for n as follows: 

Description 

chosen based on proximity to the 

main access street and availability 

of parking. 

Driveway offset point 

Represents a point located on the 

primary access road (most commonly 

a driveway) at a perpendicular 

distance of between 33-98 

feet (10-30 meters) from the main 

roadway. 

Street access point 

Represents the primary point of 

access from the street network. 

This address point type is located 

where the driveway or other access 

road intersects the main 

roadway. 

Base parcel point 

When unable to match to an input 

unit number, or when the unit 

number is missing from an address 

location with multiple units, 

the "base" parcel information is 

returned, the address is not 

standardized to a unit number, 

and additional information, such 

as an Assessor's Parcel Number, 

is not returned. 

The correct segment is inferred 

from the candidate records at 

match time. 

House range address geocode. 

This is the most accurate geocode 

available. 


Code 

ACnh 

User's Guide 

n = 0 

n = 1 

n = 2 

n = 3 

n = 7 

Description 

Best location. 

Street side is unknown. The 

Census FIPS Block ID is as- 

signed from the left side; however, 

there is no assigned offset 

and the point is placed directly on 

the street. 

Indicates one or both of the following: 

• The address is interpolated 

onto a TIGER segment that did 

not initially contain address 

ranges. 

• The original segment name 

changed to match the USPS 

spelling. This specifically refers 

to street type, predirectional, 

and postdirectional. 

Note: Only the second case is 

valid for non-TIGER data 

because segment range 

interpolation is only completed 

for TIGER data. 

Both 1 and 2. 

The ACnn 4 th digit characteristics are as follows: 

n = 0 


Placeholder. Used when starting 

and ending points of segments 

contain the same value and 

shape data is not available. 

Represents the interpolation 

between two points, both coming 

from User Dictionaries. 

559


560 

Code 

n = 1 

n = 2 

n = 3 

n = 4 

n = 5 

n = 6 

n = 7 

Description 


between two points. The low 

boundary came from a User Dictionary 

and the high boundary, 

from a non-User Dictionary. 


between one point and one street 

segment end point, both coming 



between one point (low boundary) 

and one street segment end point 

(high boundary). The low boundary 

came from a User Dictionary 

and the high boundary from a 

non-User Dictionary. 


between two points. The low 

boundary came from a non-User 

Dictionary and the high boundary 

from a User Dictionary. 


between two points, both coming 

from non-User Dictionaries. 


between one point (low boundary) 

and one street segment end point 


came from a non-User Dictionary 

and the high boundary from 

a User Dictionary. 


between one point and one street 

segment end point and both came 

from non-User Dictionaries. 


Code 

User's Guide 

n = 8 

n = 9 

n = A 

n = B 

n = C 

n = D 

n = E 


Description 


between one street segment end 

point andone point, both coming 




point (low boundary) andone point 


came from a User Dictionary 

and the high boundary from a 

non-User Dictionary. 


between two street segment end 

points, both coming from User 

Dictionaries. 



points. The low boundary came 

from a User Dictionary and the 

high boundary from a non-User 

Dictionary. 



point (low boundary) and one 

point (high boundary). The low 

boundary came from a non-User 

Dictionary and the high boundary 

from a User Dictionary. 



point and one point, both coming 

from non-User Dictionary. 



points. The low boundary came 

from a non-User Dictionary and 

the high boundary from a User 

Dictionary. 

561


562 

Code 

ARn 

AXn 

n = F 

n = 1 

n = 2 

n = 4 

n = 7 

Description 



points, both coming from non- 

User Dictionaries. 

Ranged address geocode, where 

n is one of the following: 

The geocode is placed along a 

single street segment, midway 

between the interpolated location 

of the first and second input 

house numbers in the range. 

The geocode is placed along a 

single street segment, midway 

between the interpolated location 

of the first and second input 

house numbers in the range, and 

the side of the street is unknown. 

The Census FIPS Block ID is assigned 

from the left side; however, 

there is no assigned offset 

and the point is placed directly on 

the street. 

The input range spans multiple 

USPS segments. The geocode is 

placed on the endpoint of the 

segment which corresponds to 

the first input house number, 

closest to the end nearest the 

second input house number. 

Placeholder. Used when the 

starting and ending points of the 

matched segment contain the 

same value and shape data is not 

available. 

Intersection geocode, where n is 

one of the following: 


Code 

n = 3 

n = 8 

Table 143: Match Codes for No Match 

Code 

Ennn 

User's Guide 

nnn = 000 

nnn = 001 

nnn = 002 

nnn = 003 

nnn = 004 

nnn = 010 

nnn = 011 

nnn = 012 


Description 

Standard single-point intersection 

computed from the center lines 

of street segments. 

Interpolated (divided-road) intersection 

geocode. Attempts to re- 

turn a centroid for the intersection. 

Description 

Indicates an error, or no match. 

This can occur when the address 

entered does not exist in the 

database, or the address is badly 

formed and cannot be parsed 

correctly. The last three digits of 

an error code indicate which parts 

of an address the application 

could not match to the database. 

No match made. 

Low level error. 

Could not find data file. 

Incorrect GSD file signature or 

version ID. 

GSD file out of date. Only occurs 

in CASS mode. 

No city and state or ZIP Code 

found. 

Input ZIP not in the directory. 

Input city not in the directory. 

563


564 

Code 

nnn = 013 

nnn = 014 

nnn = 015 

nnn = 020 

nnn = 021 

nnn = 022 

nnn = 023 

nnn = 024 

nnn = 025 

nnn = 026 

nnn = 027 

nnn = 028 

nnn = 029 

nnn = 030 

Description 

Input city not unique in the directory. 

Out of licensed area. Only occurs 

if using Pitney Bowes Business 

Insight licensing technology. 

Record count is depleted and license 

has expired. 

No matching streets found in directory. 

No matching cross streets for an 

intersection match. 

No matching segments. 

Unresolved match. 

No matching segments. (Same 

as 022.) 

Too many possible cross streets 

for intersection matching. 

No address found when attempting 

a multiline match. 

Invalid directional attempted. 

Record also matched EWS data, 

therefore the application denied 

the match. 

No matching range, single street 

segment found. 

No matching range, multiple 

street segments found. 


Street Centroid Location Codes 

Street centroid location codes indicate the Census ID accuracy and the position of the geocode on the 

returned street segment. A street centroid location code has the following characters. 



3 rd character 

Always C indicating a location derived from a street 

segment. 

Census ID accuracy based on the search area used 

to obtain matching Street Segment. 

Location of geocode on the returned street segment. 

The following table contains the values and descriptions for the location codes. 

Character position 

2 nd Character 

3 rd Character 

User's Guide 

Code 

B 

T 

C 

F 

P 

C 

L 

H 


Description 

Block Group accuracy (most accurate). 

Based on input ZIP Code. 

Census Tract accuracy. Based 

on input ZIP Code. 

Unclassified Census accuracy. 

Normally accurate to at least the 

County level. Based on input ZIP 

Code. 

Unknown Census accuracy. 

Based on Finance area. 

Unknown Census accuracy. 

Based on input City. 

Segment Centroid. 

Segment low-range end point. 

Segment high-range end point. 

565


ZIP + 4 Centroid Location Codes 

566 

ZIP + 4 centroid location codes indicate the quality of two location attributes: Census ID accuracy and 

positional accuracy. 

A ZIP + 4 centroid location code has the following characters. 



3 rd character 

4 th character 

Table 144: ZIP + 4 Centroid Location Codes 

Character Position 

2 nd Character 

3 rd Character 

Code 

B 

T 

C 

5 

7 

Always Z indicating a location derived from a ZIP 

centroid. 

Census ID accuracy. 

Location type. 

How the location and Census ID was defined. 

Provided for completeness, but may not be useful 

for most applications. 

Description 

Block Group accuracy (most accurate). 

Census Tract accuracy. 

Unclassified Census accuracy. 

Normally accurate to at least the 

County level. 

Location of the Post Office that 

delivers mail to the address, a 5- 

digit ZIP Code centroid, or a location 

based upon locale (city). See 

the 4th character for a precise indication 

of locational accuracy. 

Location based upon a ZIP + 2 

centroid. These locations can 



4 th Character 

User's Guide 

Code 

9 

A 

a 

B 

b 


Description 

represent a multiple block area in 

urban locations, or a slightly larger 

area in rural settings. 

Location based upon a ZIP + 4 

centroid. These are the most accurate 

centroids and normally 

place the location on the correct 

block face. For a small number of 

records, the location may be the 

middle of the entire street on 

which the ZIP + 4 falls. See the 

4th character for a precise indication 

of locational accuracy. 

Address matched to a single 

segment. Location assigned in 

the middle of the matched street 

segment, offset to the proper side 


Address matched to a single 

segment, but the correct side of 

the street is unknown. Location 

assigned in the middle of the 

matched street segment, offset 

to the left side of the street, as 

address ranges increase. 

Address matched to multiple 

segments, all segments have the 

same Block Group. Location assigned 

to the middle of the 

matched street segment with the 

most house number ranges within 

this ZIP + 4. Location offset to the 

proper side of the street. 

Same as methodology B except 

the correct side of the street is 

unknown. Location assigned in 


567


568 


Code 

C 

c 

D 

d 

Description 

segment, offset to the left side of 

the street, as address ranges increase. 


segments, with all segments 

having the same Census Tract. 

Returns the Block Group representing 

the most households in this 

ZIP + 4. Location assigned to t he 

middle of the matched street 

segment with the most house 

number ranges within this ZIP + 

4. Location offset to the proper 

side of the street. 

Same as methodology C except 







segments, with all segments 

having the same County. Returns 

the Block Group representing the 

most households in this ZIP + 4. 

Location assigned to the middle 

of the matched street segment 

with the most house number 

ranges within this ZIP + 4. Location 

offset to the proper side of 

the street. 

Same as methodology D except 







User's Guide 


Code 

E 

F 

G 

H 

I 

J 


Description 

Street name matched; no house 

ranges available. All matched 

segments have the same Block 

Group. Location placed on the 

segment closest to the center of 

the matched segments. In most 

cases, this is on the mid-point of 

the entire street. 

Street name matched; no house 

ranges available. All matched 

segments have the same Census 

Tract. Location placed on the 

segment closest to the center of 

the matched segments. In most 



Street name matched (no house 

ranges available). All matched 

segments have the same County. 

Location placed on the segment 

closest to the center of the 

matched segments. In most 



Same as methodology G, but 

some segments are not in the 

same County. Used for less than 

.05% of the centroids. 

Created ZIP + 2 cluster centroid 

as defined by methodologies A, 

a, B, and b. All centroids in this 

ZIP + 2 cluster have the same 

Block Group. Location assigned 

to the ZIP + 2 centroid. 



a, B, b, C, and c. All centroids in 

this ZIP + 2 cluster have the 

569


570 


Code 

K 

L 

M 

N 

V 

W 

X 

Description 

same Census Tract. Location assigned 

to the ZIP + 2 centroid. 



a, B, b, C, c, D, and d. Location 

assigned to the ZIP + 2 centroid. 


as defined by methodology E. All 

centroids in this ZIP + 2 cluster 

have the same Block Group. 

Location assigned to the ZIP + 2 

centroid. 

Created ZIP+2 cluster centroid as 

defined by methodology E and F. 

All centroids in this ZIP + 2 cluster 

have the same Census Tract. 

Location assigned to the ZIP + 2 

centroid. 


as defined by methodology E, F, 

G, and H. Location assigned to 

the ZIP + 2 centroid. 

Over 95% of addresses in this 

ZIP Code are in a single Census 

Tract. Location assigned to the 

ZIP Code centroid. 

Over 80% of addresses in this 

ZIP Code are in a single Census 

Tract. Reasonable Census Tract 

accuracy. Location assigned to 

the ZIP Code centroid. 

Less than 80% of addresses in 

this ZIP Code are in a single 

Census Tract. Census ID is uncertain. 

Location assigned to the ZIP 

Code centroid. 



Code 

Geographic Centroid Location Codes 

Y 

Z 

Description 

Rural or sparsely populated area. 

Census code is uncertain. Location 

based upon the USGS places 

file. 

P.O. Box or General Delivery addresses. 

Census code is uncertain. 

Location based upon the 

Post Office location that delivers 

the mail to that address. 

Geographic centroid location codes indicate the quality a city, county, or state centroid. A geographic 

centroid location code has the following characters. 



Match Codes for U.S. Geocoding 

Geocoding Match Codes 

Always G indicating a location derived from a geographic 

centroid. 

Geographic area type. One of the following: 

M 

C 

S 

Municipality (for example, a city) 

County 

State 

Geocoding components return match codes indicating the address portions that matched or did not 

match to the database. If the geocoder cannot make a match, the match code begins with E and the 

remaining digits indicate why the address did not match. The digits do not specifically refer to which 

address elements did not match, but rather why the address did not match. 

User's Guide 


571


572 

Table 145: Match Codes 

Code 

Ahh 

Chh 

D00 

Gxx 

Hhh 

Jhh 

Nxx 

P 

Qhh 

Rhh 

Shh 

Description 

Same as Shh, but indicates match to an alias name 

record or an alternate record. 

The street address did not match, but the geocoder 

located a street segment based on the input ZIP 

Code or city 

. 

Matched to a small town with P.O. Box or General 

Delivery only. 

Matched to an auxiliary file. 

The house number was changed. 

Matched to a user-defined dictionary. 

Matched to the nearest address. Used with reverse 

geocoding. The following are the only values for N: 

NSO 

NS1 

NP0 

NX0 

Nearest street center match 

(nearest street segment interpolated) 

Nearest unranged street segment 

Nearest point address 

Nearest intersection 

Successful reverse APN lookup. 

Matched to USPS range records with unique ZIP 

Codes. CASS rules prohibit altering an input ZIP if 

it matches a unique ZIP Code value. 

Matched to a ranged address. 

Matched to USPS data. This is considered the best 

address match, because it matched directly against 

the USPS list of addresses. S is returned for a small 


Code 

Thh 

Uhh 

Xhhh 

Yhhh 

Z 

Description 

number of addresses when the matched address 

has a blank ZIP + 4. 

Matched to a street segment record. Street segment 

records do not contain ZIP Code information. 

If you enter a ZIP Code, the application returns the 

ZIP Code you entered. If the input city and state 

has only one ZIP Code, the application returns that 

ZIP Code. 

Matched to USPS data but cannot resolve the ZIP 

+ 4 code without the firm name or other information. 

CASS mode returns an E023 (multiple match) error 

code. 

Matched to an intersection of two streets, for example, 

"Clay St & Michigan Ave." The first hex digit 

refers to the last line information, the second hex 

digit refers to the first street in the intersection, and 

the third hex digit refers to the second street in the 

intersection. 

Note: 

The USPS does not allow intersections as 

a valid deliverable address. 

Same as Xhhh, but an alias name record was used 

for one or both streets. 

No address given, but verified the provided ZIP 

Code . 

The following table contains the description of the hex digits for the match code values. 

Table 146: Description of Hex Digits 

Code 

0 

1 

2 

User's Guide 

In first hex position means: 

No change in last line. 

ZIP Code changed. 

City changed. 


In second and third hex position 

means: 

No change in address line. 

Street type changed. 

Predirectional changed. 

573


574 

Code 

3 

4 

5 

6 

7 

8 

9 

A 

B 

C 

D 

E 

F 

In first hex position means: 

City and ZIP Code changed. 

State changed. 

State and ZIP Code changed. 

State and City changed. 

State, City, and ZIP Code 

changed. 

ZIP + 4 changed. 

ZIP and ZIP + 4 changed. 

City and ZIP + 4 changed. 

City, ZIP, and ZIP + 4 changed. 

State and ZIP + 4 changed. 

State, ZIP, and ZIP + 4 changed. 

State, City, and ZIP + 4 changed. 

State, City, ZIP, and ZIP + 4 

changed. 

In second and third hex position 

means: 

Street type and predirectional 

changed. 

Postdirectional changed. 

Street type and postdirectional 

changed. 

Predirectional and postdirectional 

changed. 

Street type, predirectional, and 

postdirectional changed. 

Street name changed. 

Street name and street type 

changed. 

Street name and predirectional 

changed. 

Street name, street type, and 

predirectional changed. 

Street name and postdirectional 

changed. 

Street name, street type, and 


Street name, predirectional, and 


Street name, street type, predirectional, 

and postdirectional 

changed. 

If neither an address location nor a ZIP + 4 centroid can be determined, the location code will start with 

"E". This occurs infrequently when the component does not have a 5-digit centroid location. Enterprise 

Geocoding Module components can also return an E location code type when it cannot standardize an 


input address and there is no input ZIP Code. In this case, do not assume the ZIP Code returned with 

the non-standardized address is the correct ZIP Code because the component did not standardize the 

address; therefore, the component does not return geocoding or Census Block information. 

Table 147: Match Codes for No Match 

Code 

Ennn 

User's Guide 

nnn = 000 

nnn = 001 

nnn = 002 

nnn = 003 

nnn = 004 

nnn = 010 

nnn = 011 

nnn = 012 

nnn = 013 

nnn = 014 


Description 

Indicates an error, or no match. 

This can occur when the address 

entered does not exist in the 

database, or the address is badly 

formed and cannot be parsed 

correctly. The last three digits of 

an error code indicate which parts 

of an address the application 

could not match to the database. 

No match made. 

Low level error. 

Could not find data file. 

Incorrect GSD file signature or 

version ID. 

GSD file out of date. Only occurs 

in CASS mode. 

No city and state or ZIP Code 

found. 

Input ZIP not in the directory. 

Input city not in the directory. 

Input city not unique in the directory. 

Out of licensed area. Only occurs 

if using Pitney Bowes Business 

Insight licensing technology. 

575


576 

Code 

nnn = 015 

nnn = 020 

nnn = 021 

nnn = 022 

nnn = 023 

nnn = 024 

nnn = 025 

nnn = 026 

nnn = 027 

nnn = 028 

nnn = 029 

nnn = 030 

Description 

Record count is depleted and license 

has expired. 

No matching streets found in directory. 

No matching cross streets for an 

intersection match. 

No matching segments. 

Unresolved match. 

No matching segments. (Same 

as 022.) 

Too many possible cross streets 

for intersection matching. 

No address found when attempting 

a multiline match. 

Invalid directional attempted. 

Record also matched EWS data, 

therefore the application denied 

the match. 

No matching range, single street 

segment found. 

No matching range, multiple 

street segments found. 


Result Codes for International Geocoding 

Introduction 

Geocoders return a result code in the Geocoder.MatchCode output field for each attempted record match. 

Result codes fall into five categories: 

• Single Close Match (S category) on page 577 

• Best Match From Multiple Candidates (M category) on page 579 

• Reverse Geocoding Codes (R category) on page 580 

• Postal Code Centroid Match (Z category) on page 581 

• Geographic Centroid Match (G category) on page 581 

• Non-match Codes on page 581 

Single Close Match (S category) 

Matches in the S category indicate that the record was matched to a single address candidate. The first 

character (S) indicates that the geocoding server found a street address that matches the record. The 

second position in the code indicates the positional accuracy of the resulting point for the geocoded record. 

Different types of matches: 

• S0—Single close match with no coordinates available (rare occurrence). 

• S1—Single close match with the point located at postal code centroid. For Canada, this is an FSA 

centroid. For Japan, S1 indicates that the candidate matched to prefecture, but not to anything more 

precise. 

• S3—Single close match with the point located at postal code centroid. For Canada, this is an FSALDU 

centroid. For Japan, S3 indicates that the candidate matched to prefecture, city, and municipality 

subdivision (oaza). 

• S4—Single close match with the point located at the street centroid. The S4 code is followed by letters 

and dashes indicating match precision. For information about these letters, see Match Detail Codes 

on page 578. 

• S4G—For Australia, the S4G result code is used for single matches with a G-NAF Reliability level of 

4 (associated with a unique road feature.) The reliability level is returned in the output field 

AUS.GNAF_Reliability. For more information, see Australia G-NAF Database Output on page 355. 

• S5—Single close match with the point located at a street address position. For Japan, S5 indicates 

that the candidate matched block but the lot was either not matched or not provided on input. The S5 

code is followed by letters and dashes indicating match precision. For information about these letters, 

see Match Detail Codes on page 578. 

• S6—Single close match with the point located at centroid of geometry postal code. (For example, large 

buildings having their own codes.) 

• S7—Single match with the point located at an interpolated point along the candidate's street segment. 

When the potential candidate is not an address point candidate and there are no exact house number 

matches among other address point candidates, the S7 result is returned using address point interpolation. 

The point is interpolated according to the next highest or lowest address point candidate that 

User's Guide 


577


578 

both intersects the segment and whose house number is contained within the range of houses of the 

original candidate. By using known address reference points on the street segment, the S7 point can 

be adjusted to a more accurate position. For Australia, the S7G result code is also used for single 

matches with G-NAF Reliability level of 3. The reliability level is returned in the output field 

AUS.GNAF_Reliability. For more information, see Australia G-NAF Database Output on page 355. 

• S8—Single close match with the point located at either the single point associated with an address 

point candidate or at an address point candidate that shares the same house number. No interpolation 

is required. For Australia, the S8G result code is also used for single matches with G-NAF Reliability 

levels of 1or 2 (the highest level of G-NAF Reliability. The reliability level is returned in the output field 

AUS.GNAF_Reliability. For more information, see . 

• SGG—For Australian locations only, single close match with the point at the center of a locality, or 

Locality level geocode derived from topographic feature. An SGG result code is associated with G- 

NAF Reliability Level 5 (locality or neighbourhood) or with Level 6 (unique region). The reliability level 

is returned in the output field AUS.GNAF_Reliability. For more information, see Australia G-NAF 

Database Output on page 355. 

• SP—For Australian locations only, single close match to a postal (PO Box) location. This can be 

generated from the Street Range Address database only (not the G-NAF database). 

• SX—Single close match with the point located at street intersection. 

Match Detail Codes 

S4 and S5 geocode results are followed by additional characters that indicate details of the match precision. 

A typical result code looks like this: 

S5-P--S--A 

This code indicates that the geocoder returned a single close match to a street address (S5), with an 

exact match on street directional prefix (P), street suffix (S), and the match was obtained using a database 

provided by Pitney Bowes Business Insight (A). It did not match the house number (H), street name (N), 

street type (T), city (C) or postal code (Z), so these positions contain a dash. 

A perfect street level match would return a result code with every component of the address matched 

and would look like this: 

S5HPNTSCZA 

Note: 

To minimize the match inaccuracy, specify stricter matching conditions. 

The match detail codes appear in the order listed in the following table. 

Table 148: Matching Details Codes 

Character 

H 

P 

N 

T 

S 

Description 

Exact match on house number. 

Exact match on street directional prefix. 

Exact match on street name. 

Exact match on street type. 

Exact match on street suffix. 


Character 

C 

Z 

A 

U 

- 

Description 

Exact match on city name. 

Exact match on postal code. 

Best Match From Multiple Candidates (M category) 

Address matched using an Enterprise Geocoding 

Module database provided by Pitney Bowes Business 

Insight. 

Address matched using a user-defined geocoding 

database. 

If any of the fields do not match, the letter is replaced 

with a dash. 

Matches in the M category indicate that there is more than one close match candidate for the record and 

MapInfo Spatial Server has chosen the best one of those candidates. As in the S category, the second 

position in the code of M category matches the positional accuracy of the resulting point object. 

• M1—Multiple close matches, point located at postal code centroid. 

• M3—Multiple close matches, point located at geographic centroid. 

• M4—Multiple close matches, point located at the center of a shape point path (shape points define 

the shape of the street polyline). 

• M5—Multiple close matches, point located at a street address position (highest accuracy available). 

• M6—Multiple close matches, point located at point postal code location. 

• MX—Multiple close matches, point located at street intersection. 

• M0—Multiple close matches, no coordinates available. 

Interpreting S and M Result Codes 

For either S or M category result codes, eight additional characters describe how closely the address 

matches an address in the database. The characters appear in the order listed in the following table. 

Any non-matched components are represented by a dash. 

For example, the result code S5--N-SCZA represents a single close match that matched the street name, 

street suffix direction, town, and postcode. The dashes indicate that there was no match on house 

number, street prefix direction, or thoroughfare type. The match came from the Street Range Address 

database. This record would be geocoded at the street address position of the match candidate. 

Category 

H 

P 

User's Guide 

Description 

House number 

Street prefix direction 

P is present if any of these conditions are satisfied: 


Example 

18 

North 

579


Category 

N 

T 

S 

C 

Z 

A, G, or U 

Description 

• The candidate pre-directional matches the input 

pre-directional. 

• The candidate post-directional matches the input 

pre-directional after pre- and post-directionals 

are swapped. 

• The input does not have a pre-directional. 

Street name 

Street type 

Street suffix direction 

S in result code is present if any of these conditions 

are satisfied: 

• The candidate post-directional matches the input 

post-directional. 

• The candidate pre-directional matches the input 

post-directional after pre- and post-directionals 

are swapped. 

• The input does not have a post-directional. 

City name 

Postal code 

Database type used to obtan the match. 

• A—Street Range Address database. 

• G—G-NAF Point Address Dictionary (Australia 

only). 

• U—Customer (user-defined) database. 

Reverse Geocoding Codes (R category) 

580 

Example 

Merivale 

St 

W 

South Brisbane 

Matches in the R category indicate that the record was matched by reverse geocoding. The second two 

characters of the R result code indicate the type of match found. R geocode results include an additional 

letter to indicate the dictionary from which the match was made. 

Example reverse geocoding codes: 

4101 

A 


Example Reverse Geocoding 

Code 

RS8A 

RS5A 

RS4A 

Description 

Postal Code Centroid Match (Z category) 

Point/parcel level precision for reverse geocoding. Candidate returned 

from Address Dictionary. 

Interpolated street candidate for reverse geocoding. Candidate returned 


Street centroid candidate for reverse geocoding. Candidate returned 


Matches in the Z category indicate that no street match was made for one of the following reasons: 

• You specified to match to postal code centroids. The resulting point is located at the postal code 

centroid with four possible accuracy levels. 

• There is no close match and you specified to fall back to postal code centroid 

The Z category contains the following accuracy levels: 

• Z0—Postal Code match, no coordinates available (rare occurrence). 

• Z1—Postal Code centroid match. 

• Z3—Full postal code centroid match. For Canada, this is an FSALDU centroid. 

• Z6—Postal Code centroid match for point ZIP. 

Geographic Centroid Match (G category) 

Matches in the G category indicate that no street match was made. The resulting point is located at the 

geographic centroid with the following possible accuracy levels. 

• G0—Country centroid. 

• G1—State or province centroid. For Japan, this indicates a prefecture (ken) match. 

• G2—County centroid. For Japan, this indicates a city (shi) match. 

• G3—City centroid. For Japan, this indicates a municipality subdivisio (oaza) match. For Australia, 

Local Government Authority (LGA) information can be returned from the Street Range Address Database 

only (not the G-NAF database). 

• G4—Locality centroid. For Japan, this indicates a city district (chome) match. 

Non-match Codes 

The following result codes indicate no match was made: 

• N—No close match. 

• NX—No close match for street intersections. 

User's Guide 


581

Custom Databases for International Geocoding 

• ND—MapInfo Spatial Server could not find the geocoding database for the given postal code or municipality/state/province. 


What Is a Custom Database? 

A custom database is a table of addresses and coordinates that you can use for geocoding in place of, 

or in addition to, the standard Enterprise Geocoding Module databases. Use a custom database when 

you have newer or more precise data than what is available in the standard databases to get more accurate 

geocoding results. For example, if you have address point data for your customer sites, you can 

create a custom database of these sites. 

A custom database can be used by itself to geocode records, or can be used in combination with the 

standard databases. 

Note: 

The more user dictionaries you use, the more geocoding performance degrades. 

The capabilities of custom databases are as follows. 

• All columns supported by normal street geocoding can be included in custom databases. 

• Points Of Interest (POI) geocoding is supported in custom databases. Postal or geographic centroid 

geocoding are not supported in custom databases. 

• Custom databases support address browsing using partial street names or Points of Interest. 

• A standard database is required to create a custom database. This is because standard databases 

have some internal structure that must be available when you are creating a custom database. 

Requirements 

582 

The requirements for custom databases consist of: 

• Source Data Requirements on page 582 

• Column Requirements on page 583 

• File Name and Format Requirements on page 586 

Source Data Requirements 

Source data for custom databases includes street data, but can also include place names and intersections. 

Source data for custom databases must conform to the following requirements: 

• You can only create custom databases for areas you have licensed. For example, if you create a 

custom database of Adelaide streets and addresses, you must have a license for South Australia or 

the entire Australia database. 

• Source records must include required columns, which are mapped during the custom database creation 

process. If a value of a required column is empty for a particular record, that record is not imported 

into the custom database. Required columns vary by country. 

• Source records must be in a MapInfo table (TAB file). 


• The MapInfo table (TAB file) must contain specific columns. The database creation utility uses the 

TAB file to convert the table into the database format. These input columns are described in Column 

Requirements on page 583. 

• Intersection segments must have one or more endpoints for MapInfo Spatial Server to recognize it as 

an intersection. 

• Source records can be point objects or segments. 

• Each row in the table is equal to a street segment. 

Column Requirements 

You must specify the column names in the MapInfo table (TAB file) for the table to be translated into a 

custom database. Required columns must be present in the TAB file. Other columns are optional, but 

recommended. Omitting optional columns may cause negative consequences. If any required columns 

are missing, an error code is returned. 

Australia 

Table 149: Required Input Columns for Australia on page 583 lists the required fields. 

Table 149: Required Input Columns for Australia 

Field 

Street Name 

Town / Suburb 

Postcode 

State 

Place Name 

Local Government Authority 

Unit Number 

Unit Type 

Left Starting Address 

Number 

User's Guide 

Description 

Name of street 

Municipality 

The four-digit postcode. 

Abbreviation of state or territory 

Place name 

The LGA. 

Unit Numbers are associated with Unit 

Types, 

Unit Types include Apartment, Building, 

Flat, Suite, and others. 

Start of address range on left side of 

street. For more information, see Range 


Maximum Column 

Length 

50 

40 

4 

3 

40 

50 

11 

Required 

X 

X 

X 

X 

583


584 

Field 

Right Starting Address 

Number 

Left Ending Address 

Number 

Right Ending Address 

Number 

Left Odd/Even indicator 

Description 

Order in Custom Databases on page 

587. 

Start of address range on right side of 



587. 

End of address range on left side of 



587. 

End of address range on right side of 



587. 

Left side of the street contains only odd 

or even address ranges (O=odd, 

E=even, B=both). For more information, 

see Odd/Even Indicators in Custom 


It is strongly recommended that you include 

this column. 

Right Odd/Even indicator Right side of the street contains only 

odd or even address ranges (O=odd, 




Canada 


this column. 


Length 

Table 150: Required Input Columns for Australia on page 585 lists the required fields. 

11 

11 

11 

1 

1 

Required 


Table 150: Required Input Columns for Australia 

Field 

Left Start Address 

Right Start Address 

Left End Address 

Right End Address 

Street Name 

Province Abbreviation 

Left FSA (segment) 

Right FSA (segment) 

Left Odd/Even indicator 

Description 

Start of the address range on the left 


Start of the address range on the right 


End of the address range on the left 


End of the address range on the right 


Name of street 

Abbreviation of the province 

FSA for the left side of the street. 

FSA for the right side of the street. 

Left side of the street contains only odd 

or even address ranges (O=odd, 





this column. 

Right Odd/Even indicator Right side of the street contains only 

odd or even address ranges (O=odd, 




1 

City 

Left LDU 

User's Guide 


this column. 

The city name 

LDU for the left side of the street. 



Length 

10 

10 

10 

10 

50 

2 

3 

3 

1 

28 

3 

Required 

X 

X 

X 

X 

X 

X 

X 

X 

585


Field 

Right LDU 

Description 

LDU for the right side of the street 

File Name and Format Requirements 

A custom database must meet these requirements: 

• The file name must be eight characters or less. 

• Each custom database must reside in its own directory. 

• The maximum length of a path to a custom database is 1,024 characters. 


Length 

• The maximum length of the paths to multiple custom databases is 1,024 characters. 

3 

Required 

Because each custom database resides in its own directory, custom databases may share the same 

name. However, it is good practice to use a unique name for each custom database. 

Some database files are linked to the base name. The other files have fixed names regardless of database. 

For example, the files for a database called "ud1" would be: 

postinfo.jdr 

postinfo.jdx 

lastline.jdr 

post2sac.mmj 

geo2sac.mmj 

sac2fn_ud.mmj 

ud1.jdr 

ud1.jdx 

ud1.bdx 

If your data includes place names, the database contains the following files: 

ud1.pdx 

ud1.pbx 

The database also contains these log files: 

ud1.log 

ud1.err 

Creating a Custom Database 

586 

1. Download the User Dictionary Utility. Go to www.pbinsight.com/support/product-downloads, 

under Applications, click MapMarker, then click MapInfo User Dictionary Utility. 


Note: 

The utility uses the term "user dictionary" instead of "custom database". These terms are 

synonymous. 

2. Create a MapInfo tab file (.tab) following the requirements described in Requirements on page 582). 

3. Start the User Dictionary Utility. 

4. Enter the required information and then click Next. 

• In the Country field, select the country for this custom database. 

• In the Address Dictionary File field, accept or browse to the standard database for the selected 

country. In the Table Name field, browse to the TAB file that contains the source data for your 

custom database. 

5. Select the required columns and then click Next. 

Note: 

Field labels and details vary by country. See Column Requirements on page 583 for more 

information. 

6. Select optional columns as needed and then click Next. 

7. Enter the custom database output directory and file name and then click Finish. 

You must specify an empty directory. For example, you could browse to C:\data and create an empty 

directory named TroyUD. Name the file and save it in this directory. For example, the file TroyUD.jdr. 

A log file summarizes the processing and lists all created files. Any errors are indicated in the Error 

File area of the dialog box. 

8. Click Exit. 

The custom database directory contains the custom database files (with .mmj, .jdr, .jdx, .sdx, and 

.bdx file extensions). The log file and error file are also stored in the same directory. 

9. Start Management Console and define a new database resource for the custom database. For more 

information, see Adding an Enterprise Geocoding Module International Database Resource on 

page 248. After you define the database resource in the Management Console, select the database 

in the Data tab of the geocoding component. 

Range Order in Custom Databases 

Enterprise Geocoding Module determines address range order based on a comparison of the start and 

end addresses. The comparison produces the following results: 

• If the end is greater than the start, the range is ascending. 

• If the start is greater than the end, the range is descending. 

• If the start is equal to the end, the range is ascending. 

Odd/Even Indicators in Custom Databases 

Left and Right Odd/Even Indicator columns specify whether the sides of the street segment contain odd 

or even address ranges. If your TAB file contains odd/even indicator information, you should use the 

Odd/Even indicator columns. These columns ensure that geocoded addresses are located on the correct 

side of the street. Omitting these columns may produce incorrect results. If the Odd/Even Indicator is 

not included, the following logic is used: 

User's Guide 


587

Encountering False Positives 

• When the Odd/Even Indicator is not specified and both Start Address and End Address have values, 

the indicator is set to Both, unless the start and end address numbers are the same number. In that 

case, the indicator is set to Odd if the address numbers are odd, and set to Even if the address numbers 

are even. 

• When the Odd/Even Indicator is not specified and both Start Address and End Address have values, 

the indicator is set to Both (odd and even). 

When the Odd/Even Indicator is specified, but is inconsistent with address numbers, the indicator is set 

to Both. 

Street Intersections in Custom Databases 

When geocoding street intersections with a custom database, Enterprise Geocoding Module cannot recognize 

intersections if one or more of the intersection segments does not have an endpoint at the intersection. 

This can happen when you create a custom database from a customized street table in which 

some segments that terminate at intersections do not have endpoints (Example"1). 

Example 1: Intersection in a custom database does not have endpoints for all segments. Enterprise 

Geocoding Module does not identify the geocode of this intersection. 

Example 2: Intersection in a standard database includes endpoints for all segments. Enterprise Geocoding 

Module identifies the geocode of this intersection. 


What is a False-Positive? 

588 

To prevent the generation of address lists, the DPV and LACS Link databases include false-positive records. 

False-positive records are artificially manufactured addresses that reside in a false-positive table. For 


each negative response that occurs in a DPV or LACS Link query, a query is made to the false-positive 

table. A match to this table (called a false-positive match) disables your DPV or LACS Link key. In batch 

processing the job that contains the violation will complete successfully but you will not be able to run 

any subsequent jobs that use DPV or LACS Link until you report the violation and obtain a key to reactivate 

DPV or LACS Link . 

Note: 

The term "seed record violation" is also used to refer to encountering false positive records. The 

two terms mean the same thing. 

Reporting DPV False-Positive Violations 

During batch processing, if you encounter a false positive record the job will continue, and indicates a 

false-positive match via messages in the server log.. After the job completes you will not be able to run 

any other jobs using DPV because your DPV key is disabled. When a DPV false positive record violation 

occurs, the following text is displayed in the Execution History: 

DPV Seed Record Violation. Seed Code S 

You can report the violation and obtain a restart key by following these steps. 

1. In your browser, go to http://://dpv.jsp. For example, http://localhost:8080/unc/dpv.jsp 

for the Universal Addressing Module and http://localhost:8080/geostan/dpv.jsp 

for the Enterprise Geocoding Module. 

2. Enter the mailer's information into each field. The number in parentheses after each field name indicates 

the maximum length of the field. 

3. Click Submit when you're done. A File Download dialog will appear. 

4. Click Save to save the file to your computer. A Save As dialog will appear. 

5. Specify a file name and location on your local hard drive (for example c:\DPVSeedFile.txt) and 

click Save. 

6. Go to www.g1.com/support and log in. 

7. Click DPV & LACS Link False Positive. 

8. Follow the on-screen instructions to attach your seed file and obtain a restart key. 

DPV False Positive Header File Layout 

The USPS ® has determined the required layout of the DPV false-positive header file, which is currently 

defined as a fixed-length file containing two or more 180-byte records. The first record must always be 

the header record, whose layout is shown below. 

Table 151: DPV False-Positive Header Record Layout 

Position 

1-40 

41-98 

99-126 

User's Guide 

Length 

40 

58 

28 

Description 

Mailer's company name 

Mailer's address line 

Mailer's city name 


Format 

Alphanumeric 

Alphanumeric 

Alphanumeric 

589


590 

Position 

127-128 

129-137 

138-146 

147-155 

156-164 

165-173 

174-178 

179-180 

Length 

2 

9 

9 

9 

9 

9 

5 

2 

Description 

Mailer's state abbreviation 

Mailer's 9-digit ZIP Code 

Total Records Processed 

Total Records DPV Matched 

Percent Match Rate to DSF 

Percent Match Rate to ZIP + 4 ® 

Number of ZIP Codes on file 

Number of False-Positives 

Format 

Alphabetic 

Numeric 

Numeric 

Numeric 

Numeric 

Numeric 

Numeric 

Numeric 

The trailer record contains information regarding the DPV false-positive match. There must be one 

trailer record added to the false-positive file for every DPV false-positive match. The layout is shown 

below. 

Table 152: DPV False-Positive Trailer Record Layout 

Position 

1-2 

3-30 

31-34 

35-36 

37-46 

47-50 

51-58 

59-63 

64-67 

Length 

2 

28 

4 

2 

10 

4 

8 

5 

4 

Description 

Street predirectional 

Street name 

Street suffix abbreviation 

Street postdirectional 

Address primary number 

Address secondary abbreviation 

Address secondary number 

Matched ZIP Code 

Matched ZIP + 4 ® 

Format 

Alphanumeric 

Alphanumeric 

Alphanumeric 

Alphanumeric 

Alphanumeric 

Alphanumeric 

Numeric 

Numeric 

Numeric 


Position 

68-180 

Length 

113 

Description 

Filler 

Reporting LACS/Link False-Positive Violations 

Format 

Spaces 

MapInfo Spatial Server indicates a false-positive match via messages in the server log. Batch jobs will 

fail if a false-positive match occurs and client/server calls will throw an exception. 

Note: 

The term "seed record violation" is also used to refer to encountering false positive records. The 

two terms mean the same thing. 

When a false positive record is encountered, the server log will say: 

2005-05-19 09:40:10,758 WARN [com.g1.dcg.component.Log] Seed record violation 

for RR 1 R74039 2924 

2005-05-19 09:40:10,774 ERROR [com.g1.dcg.component.Log] Feature Disabled: 

LLB: LACS Seed Record Violation. Seed Code: R74039 2924 

2005-05-19 09:40:10,867 ERROR [com.g1.dcg.job.server.stages.JobRunnerStages] 

Error executing job 

com.g1.dcg.stage.StageException: com.g1.dcg.component.ComponentException: 

Feature Disabled: LLB 

1. In your browser, go to http://://lacslink.jsp. For example, http://localhost:8080/unc/lacslink.jsp 

for the Universal Addressing Module and http://localhost:8080/geostan/lacslink.jsp 

for the Enterprise Geocoding Module. 

2. Enter the mailer's information into each field. The number in parentheses after the field name indicates 

the maximum length of the field. Click Submit when you're done. A File Download dialog will appear. 

3. Click Save to save the file to your computer. A Save As dialog will appear. 

4. Specify a file name and location on your local hard drive (for example c:\lacslink.txt) and click 

Save. 

5. Go to www.g1.com/support and log in. 

6. Click DPV & LACS Link False Positive. 

7. Follow the on-screen instructions to attach your seed file and obtain a restart key. 

User's Guide 


591

Enterprise Mapping Module 


• What is the Enterprise Mapping Module? . . . . . . . . . . .594 

• Where to find information on the Enterprise Mapping Module? 

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .594 

• Getting started with the Enterprise Mapping Module . .594 

14

What is the Enterprise Mapping Module? 

What is the Enterprise Mapping Module? 

The Enterprise Mapping Module provides a suite of broadly applicable location capabilites through services 

and access via REST and SOAP APIs. These location capabilites include mapping, tiling, feature seraching, 

geometry calculations, WMS (web map), WFS (web feature), and CSW (catalog service). 

Note: 

The Enterprise Mapping Module, in MapInfo Spatial Server, does not appear as a stage in the 

client applications (Enterprise Designer, Interactive Driver, Management Console). 

Where to find information on the Enterprise Mapping 

Module? 

The Enterprise Mapping Module is made up of various components and services, each requiring their 

own set of documentation. Documentation for the REST and SOAP services, as well as administration 

of the Enterprise Mapping Module can be accessed at: reference.mapinfo.com/software/spatial_server/english/1_0/index.html 

All documentation can be downloaded or viewed online. 

Getting started with the Enterprise Mapping Module 

594 

The best way to get started using the Enterprise Mapping Module is to try the various services that are 

included with this module. Each service and component has its own unique endpoint, and many of the 

services and RIA controls included with the Enterprise Mapping Module have demonstration pages with 

ready to use examples. 

Each URL endpoint should replace localhost:8080 with the appropriate host name and port number 

for your Spatial Server installation. 

Use the following URLs and demo pages with the documentation located at reference.mapinfo.com/software/spatial_server/english/1_0/index.html 

Enterprise Mapping Demo Page 

The demo page includes sample requests for the Mapping, Geometry, Feature, and NamedResource 

SOAP services. The URL endpoint is located at http://localhost:8080/EnterpriseMapping/. 

OpenLayers and RIA Controls 

The sample page includes examples of the controls in use. The URL endpoint is located at http://localhost:8080/ria-examples/. 


The controls API documentation is also included in the deployment. The URL endpoint is located at http://localhost:8080/ria/api/. 

Repository Service 

The Enterprise Mapping services use the repository to store resources. The Repository service allows 

you to access these resources, inlcuding: service configuration, layers, maps, styles, tables, tiles, and 

database files. The repository endpoint is located at: http://localhost:8080/RepositoryService/. When 

accessing the repository (using clients such as WebDAV) the content repository is located at: http://localhost:8080/RepositoryService/repository/default/. 

REST Service Endpoints 

The Enterprise Mapping REST services are located at the following endpoint URL: http://localhost:8080/rest/. 

These services include Mapping, Feature, WMS, WFS, MapTiling, and Legacy MapTiling. 

The individual services are accessed using the following URLs: 

• http://localhost:8080/rest/EnterpriseMapping/MappingService/ 

• http://localhost:8080/rest/EnterpriseMapping/FeatureService/ 

• http://localhost:8080/rest/EnterpriseMapping/WMS/ 

• http://localhost:8080/rest/EnterpriseMapping/WFS/ 

• http://localhost:8080/rest/EnterpriseMapping/NamedResourceService/ 

• http://localhost:8080/rest/EnterpriseMapping/MapTilingService/ 

• http://localhost:8080/rest/EnterpriseMapping/LegacyMapTilingService/ 

SOAP Service Endpoints 

The Enterprise Mapping SOAP services are located at the following endpoint URL: http://localhost:8080/soap/. 

These services include Mapping, Feature, Geometry, and NamedResource. This URL 

also lists the available service interfaces (operations) for each service, endpoint address, WSDL, and 

target namespace. 

MapInfo Spatial Server JMX Console 

Included with MapInfo Spatial Service is a JMX console that allows you to control different aspects of 

service administration. For example, you can use the JMX console to dynamically reload a service configuration 

in the repository after you have made changes, without restarting the service. The JMX console 

is available at: http://localhost:8080/jmx-console/ 

User's Guide 

Chapter 14:Enterprise Mapping Module 

595

Appendices 


• Module Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .599 

• Country Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .601

Module Matrix 


• Modules, Components, and Databases . . . . . . . . . . . . .600 

A

Modules, Components, and Databases 

Modules, Components, and Databases 

600 

Table 153: Modules, Components, and Databases 

Module 

Enterprise Geocoding 

Module 

Enterprise Mapping 

Module 

Description 

Determines the geographic coordinates for 

an address. Also determines the address of 

a given latitude and longitude. 

Components 

Geocode Address (Deprecated) 






Reverse Geocode Address 

Global 


Mapping provides the ability to generate Mapping 

maps, and also the ability to create new information 

about your data by assessing, evaluat- 

MapTiling 

ing, analyzing and modeling geographic rela- Feature Searching 

tionships. NOTE: The Enterprise Mapping 

Module is not a staged module, and is only 

Geometry Calculations 

used in the Mananagement Console to define WMS (Web Map Service) 

users. 

WFS (Web Feature Service) 

CSW (Catalog Service for 

Web) 


Country Codes 


• Country Names and ISO Codes . . . . . . . . . . . . . . . . . . . .602 

B

Country Names and ISO Codes 


602 

The following table lists the ISO codes for each country as well as the modules that support addressing 

and geocoding for each country. 

ISO Country Name (English) 

Afghanistan 

Aland Islands 

Albania 

Algeria 

American Samoa 

Andorra 

Angola 

Anguilla 

Antarctica 

Antigua And Barbuda 

ISO 3116-1 

Alpha-2 

AF 

AX 

AL 

DZ 

AS 

AD 

AO 

AI 

AQ 

AG 

ISO 3116-1 

Alpha-3 

AFG 

ALA 

ALB 

DZA 

ASM 

AND 

AGO 

AIA 

ATA 

ATG 

Supported Modules 

Address Now Module 

Universal Addressing Module 










Enterprise Geocoding Module (Andorra 

is covered by the Spain geocoder) 











Argentina 

Armenia 

Aruba 

Australia 

Austria 

Azerbaijan 

Bahamas 

Bahrain 

Bangladesh 

Barbados 

Belarus 

User's Guide 

ISO 3116-1 

Alpha-2 

AR 

AM 

AW 

AU 

AT 

AZ 

BS 

BH 

BD 

BB 

BY 

ISO 3116-1 

Alpha-3 

ARG 

ARM 

ABW 

AUS 

AUT 

AZE 

BHS 

BHR 

BGD 

BRB 

BLR 

Appendix B:Country Codes 




Enterprise Geocoding Module 























603


604 


Belgium 

Belize 

Benin 

Bermuda 

Bhutan 

Bolivia, Plurinational State Of 

Bonaire, Saint Eustatius And 

Saba 

Bosnia And Herzegovina 

Botswana 

Bouvet Island 

Brazil 

ISO 3116-1 

Alpha-2 

BE 

BZ 

BJ 

BM 

BT 

BO 

BQ 

BA 

BW 

BV 

BR 

ISO 3116-1 

Alpha-3 

BEL 

BLZ 

BEN 

BMU 

BTN 

BOL 

BES 

BIH 

BWA 

BVT 

BRA 





























British Indian Ocean Territory 

Brunei Darussalam 

Bulgaria 

Burkina Faso 

Burundi 

Cambodia 

Cameroon 

Canada 

Cape Verde 

Cayman Islands 

Central African Republic 

Chad 

User's Guide 

ISO 3116-1 

Alpha-2 

IO 

BN 

BG 

BF 

BI 

KH 

CM 

CA 

CV 

KY 

CF 

TD 

ISO 3116-1 

Alpha-3 

IOT 

BRN 

BGR 

BFA 

BDI 

KHM 

CMR 

CAN 

CPV 

CYM 

CAF 

TCD 




























605


606 


Chile 

China 

Christmas Island 

Cocos (Keeling) Islands 

Colombia 

Comoros 

Congo 

Congo, The Democratic Republic 

Of The 

Cook Islands 

Costa Rica 

Côte d'Ivoire 

Croatia 

ISO 3116-1 

Alpha-2 

CL 

CN 

CX 

CC 

CO 

KM 

CG 

CD 

CK 

CR 

CI 

HR 

ISO 3116-1 

Alpha-3 

CHL 

CHN 

CXR 

CCK 

COL 

COM 

COG 

COD 

COK 

CRI 

CIV 

HRV 




























Cuba 

Curacao 

Cyprus 

Czech Republic 

Denmark 

Djibouti 

Dominica 

Dominican Republic 

Ecuador 

Egypt 

El Salvador 

User's Guide 

Equatorial Guinea 

ISO 3116-1 

Alpha-2 

CU 

CW 

CY 

CZ 

DK 

DJ 

DM 

DO 

EC 

EG 

SV 

GQ 

ISO 3116-1 

Alpha-3 

CUB 

CUW 

CYP 

CZE 

DNK 

DJI 

DMA 

DOM 

ECU 

EGY 

SLV 

GNQ 




























607


608 


Eritrea 

Estonia 

Ethiopia 

Falkland Islands (Malvinas) 

Faroe Islands 

Fiji 

Finland 

France 

French Guiana 

French Polynesia 

French Southern Territories 

Gabon 

ISO 3116-1 

Alpha-2 

ER 

EE 

ET 

FK 

FO 

FJ 

FI 

FR 

GF 

PF 

TF 

GA 

ISO 3116-1 

Alpha-3 

ERI 

EST 

ETH 

FLK 

FRO 

FJI 

FIN 

FRA 

GUF 

PYF 

ATF 

GAB 





























Gambia 

Georgia 

Germany 

Ghana 

Gibraltar 

Greece 

Greenland 

Grenada 

Guadeloupe 

Guam 

Guatemala 

User's Guide 

ISO 3116-1 

Alpha-2 

GM 

GE 

DE 

GH 

GI 

GR 

GL 

GD 

GP 

GU 

GT 

ISO 3116-1 

Alpha-3 

GMB 

GEO 

DEU 

GHA 

GIB 

GRC 

GRL 

GRD 

GLP 

GUM 

GTM 














Enterprise Geocoding Module (Gibraltar 

is covered by the Spain geocoder) 













609


610 


Guernsey 

Guinea 

Guinea-Bissau 

Guyana 

Haiti 

Heard Island and McDonald 

Islands 

Holy See (Vatican City State) 

Honduras 

Hong Kong 

Hungary 

Iceland 

ISO 3116-1 

Alpha-2 

GG 

GN 

GW 

GY 

HT 

HM 

VA 

HN 

HK 

HU 

IS 

ISO 3116-1 

Alpha-3 

GGY 

GIN 

GNB 

GUY 

HTI 

HMD 

VAT 

HND 

HKG 

HUN 

ISL 
















Enterprise Geocoding Module (The Vatican 

is covered by the Italy geocoder) 












India 

Indonesia 

Iran, Islamic Republic Of 

Iraq 

Ireland 

Isle Of Man 

Israel 

Italy 

Jamaica 

Japan 

Jersey 

User's Guide 

ISO 3116-1 

Alpha-2 

IN 

ID 

IR 

IQ 

IE 

IM 

IL 

IT 

JM 

JP 

JE 

ISO 3116-1 

Alpha-3 

IND 

IDN 

IRN 

IRQ 

IRL 

IMN 

ISR 

ITA 

JAM 

JPN 

JEY 




























611


612 


Jordan 

Kazakhstan 

Kenya 

Kiribati 

Korea, Democratic People's 

Republic Of 

Korea, Republic Of 

Kosovo 

Kuwait 

Kyrgyzstan 

Lao People's Democratic Republic 

Latvia 

Lebanon 

ISO 3116-1 

Alpha-2 

JO 

KZ 

KE 

KI 

KP 

KR 

KS 

KW 

KG 

LA 

LV 

LB 

ISO 3116-1 

Alpha-3 

JOR 

KAZ 

KEN 

KIR 

PRK 

KOR 

KOS 

KWT 

KGZ 

LAO 

LVA 

LBN 




























Lesotho 

Liberia 

Libyan Arab Jamahiriya 

Liechtenstein 

Lithuania 

Luxembourg 

Macao 

Macedonia, Former Yugoslav 

Republic Of 

Madagascar 

Malawi 

Malaysia 

User's Guide 

ISO 3116-1 

Alpha-2 

LS 

LR 

LY 

LI 

LT 

LU 

MO 

MK 

MG 

MW 

MY 

ISO 3116-1 

Alpha-3 

LSO 

LBR 

LBY 

LIE 

LTU 

LUX 

MAC 

MKD 

MDG 

MWI 

MYS 




























613


614 


Maldives 

Mali 

Malta 

Marshall Islands 

Martinique 

Mauritania 

Mauritius 

Mayotte 

Mexico 

Micronesia, Federated States 

Of 

Moldova, Republic Of 

ISO 3116-1 

Alpha-2 

MV 

ML 

ML 

MH 

MQ 

MR 

MU 

YT 

MX 

FM 

MD 

ISO 3116-1 

Alpha-3 

MDV 

MLI 

MLT 

MHL 

MTQ 

MRT 

MUS 

MYT 

MEX 

FSM 

MDA 




























Monaco 

Mongolia 

Montenegro 

Montserrat 

Morocco 

Mozambique 

Myanmar 

Namibia 

Nauru 

Nepal 

Netherlands 

User's Guide 

ISO 3116-1 

Alpha-2 

MC 

MN 

ME 

MS 

MA 

MZ 

MM 

NA 

NR 

NP 

NL 

ISO 3116-1 

Alpha-3 

MCO 

MNG 

MNE 

MSR 

MAR 

MOZ 

MMR 

NAM 

NRU 

NPL 

NLD 




Enterprise Geocoding Module (Monaco 

is covered by the France geocoder) 























615


616 


New Caledonia 

New Zealand 

Nicaragua 

Niger 

Nigeria 

Niue 

Norfolk Island 

Northern Mariana Islands 

Norway 

Oman 

Pakistan 

Palau 

ISO 3116-1 

Alpha-2 

NC 

NZ 

NI 

NE 

NG 

NU 

NF 

MP 

NO 

OM 

PK 

PW 

ISO 3116-1 

Alpha-3 

NCL 

NZL 

NIC 

NER 

NGA 

NIU 

NFK 

MNP 

NOR 

OMN 

PAK 

PLW 





























Palestinian Territory, Occupied 

Panama 

Papua New Guinea 

Paraguay 

Peru 

Philippines 

Pitcairn 

Poland 

Portugal 

Puerto Rico 

Qatar 

User's Guide 

ISO 3116-1 

Alpha-2 

PS 

PA 

PG 

PY 

PE 

PH 

PN 

PL 

PT 

PR 

QA 

ISO 3116-1 

Alpha-3 

PSE 

PAN 

PNG 

PRY 

PER 

PHL 

PCN 

POL 

PRT 

PRI 

QAT 




























617


618 


Reunion 

Romania 

Russian Federation 

Rwanda 

Saint Barthelemy 

Saint Helena, Ascension & 

Tristan Da Cunha 

Saint Kitts and Nevis 

Saint Lucia 

Saint Martin (French Part) 

Saint Pierre and Miquelon 

Saint Vincent And The Grenadines 

Samoa 

ISO 3116-1 

Alpha-2 

RE 

RO 

RU 

RW 

BL 

SH 

KN 

LC 

MF 

PM 

VC 

WS 

ISO 3116-1 

Alpha-3 

REU 

ROU 

RUS 

RWA 

BLM 

SHE 

KNA 

LCA 

MAF 

SPM 

VCT 

WSM 




























San Marino 

Sao Tome And Principe 

Saudi Arabia 

Senegal 

Serbia 

Seychelles 

Sierra Leone 

Singapore 

Sint Maarten (Dutch Part) 

Slovakia 

Slovenia 

User's Guide 

Solomon Islands 

ISO 3116-1 

Alpha-2 

SM 

ST 

SA 

SN 

RS 

SC 

SL 

SG 

SX 

SK 

SI 

SB 

ISO 3116-1 

Alpha-3 

SMR 

STP 

SAU 

SEN 

SRB 

SYC 

SLE 

SGP 

SXM 

SVK 

SVN 

SLB 




Enterprise Geocoding Module (San 

Marino is covered by the Italy geocoder) 























619


620 


Somalia 

South Africa 

South Georgia And The South 

Sandwich Islands 

Spain 

Sri Lanka 

Sudan 

Suriname 

Svalbard And Jan Mayen 

Swaziland 

Sweden 

Switzerland 

ISO 3116-1 

Alpha-2 

SO 

ZA 

GS 

ES 

LK 

SD 

SR 

SJ 

SZ 

SE 

CH 

ISO 3116-1 

Alpha-3 

SOM 

ZAF 

SGS 

ESP 

LKA 

SDN 

SUR 

SJM 

SWZ 

SWE 

CHE 





























Syrian Arab Republic 

Taiwan, Province of China 

Tajikistan 

Tanzania, United Republic Of 

Thailand 

Timor-Leste 

Togo 

Tokelau 

Tonga 

Trinidad and Tobago 

Tunisia 

User's Guide 

ISO 3116-1 

Alpha-2 

SY 

TW 

TJ 

TZ 

TH 

TL 

TG 

TK 

TO 

TT 

TN 

ISO 3116-1 

Alpha-3 

SYR 

TWN 

TJK 

TZA 

THA 

TLS 

TGO 

TKL 

TON 

TTO 

TUN 




























621


622 


Turkey 

Turkmenistan 

Turks And Caicos Islands 

Tuvalu 

Uganda 

Ukraine 

United Arab Emirates 

United Kingdom 

United States 

United States Minor Outlying 

Islands 

Uruguay 

Uzbekistan 

ISO 3116-1 

Alpha-2 

TR 

TM 

TC 

TV 

UG 

UA 

AE 

GB 

US 

UM 

UY 

UZ 

ISO 3116-1 

Alpha-3 

TUR 

TKM 

TCA 

TUV 

UGA 

UKR 

ARE 

GBR 

USA 

UMI 

URY 

UZB 





























Vanuatu 

Venezuela, Bolivarian Republic 

Of 

Viet Nam 

Virgin Islands, British 

Virgin Islands, U.S. 

Wallis and Futuna 

Western Sahara 

Yemen 

Zambia 

Zimbabwe 

User's Guide 

ISO 3116-1 

Alpha-2 

VU 

VE 

VN 

VG 

VI 

WF 

EH 

YE 

ZM 

ZW 

ISO 3116-1 

Alpha-3 

VUT 

VEN 

VNM 

VGB 

VIR 

WLF 

ESH 

YEM 

ZMB 

ZWE 
























623

Index 

A 

Add Separator dialog box 18 

AdditionalInputData 511, 539 

output 511, 539 

address location codes 555 

Address Preference 457 

input option 457 

AddressLine 466 

output 466 

AddressLine1 342, 412, 448, 474, 498, 511, 525, 

539 

input 448 

output 342, 412, 474, 498, 511, 525, 539 

AddressLine2 342, 412, 448, 474, 498, 511, 525, 

539 

input 448 

output 342, 412, 474, 498, 511, 525, 539 

AddressLine3 449 

input 449 


input 449 


input 449 


input 449 

AddressLineResolved 484 

output 484 

AddressPointInterpolation 456 


AddressPreference 299 

input 299 

Alternate 488, 517, 545 

output 488, 517, 545 

AlwaysFindCandidates 473 


ApartmentLabel 342, 412, 480, 498, 514, 525, 542 

output 342, 412, 480, 498, 514, 525, 542 

ApartmentLabel2 480, 514, 542 

output 480, 514, 542 

ApartmentNumber 342, 412, 480, 498, 514, 525, 542 

output 342, 412, 480, 498, 514, 525, 542 

ApartmentNumber2 480, 514, 542 

output 480, 514, 542 

APN 467, 506, 511, 538 

See also Assessor's Parcel Number 

output 467, 511, 538 

See also Assessor's Parcel Number 

architecture 10 

Assessor's Parcel Number 506 

AUS.GNAF_Confidence 355, 421, 503 

output 355, 421, 503 

AUS.GNAF_Eight_Digit_Latitude 355, 422, 504 

output 355, 422, 504 

AUS.GNAF_Eight_Digit_Longitude 356, 422, 504 

output 356, 422, 504 

AUS.GNAF_Geocode_Level 356, 422, 504 

output 356, 422, 504 

AUS.GNAF_PID 356, 423, 505 

output 356, 423, 505 

AUS.GNAF_Reliability 357, 423, 505 

output 357, 423, 505 

AUS.Mesh_Block_ID 358, 424, 506 

output 358, 424, 506 

auto-refresh interval 18 

auxiliary file 548 

auxiliary files 294 

AuxiliaryData 465 

output 465 

B 

BlockLeft 489, 518, 546 

output 489, 518, 546 

BlockLine 466 

output 466 

BlockLine1 466, 477 

output 466, 477 

BlockLine2 466 

output 466


output 466 


output 467 


output 467 


output 467 

BlockRight 489, 518, 547 

output 489, 518, 547 

BlockSuffix 467, 509, 538 

output 467, 509, 538 

BlockSuffixLeft 489, 518, 547 

output 489, 518, 547 

BlockSuffixRight 489, 518, 547 

output 489, 518, 547 

BuildingSearch 458 


C 

CAN.Census_CD 358, 424 

output 358, 424 

CAN.Census_CMA 358, 424 

output 358, 424 

CAN.Census_CSD 358, 425 

output 358, 425 

CAN.Census_CT 358, 425 

output 358, 425 

CAN.Census_DA 358, 425 

output 358, 425 

Canvas 21 

case transforms 73, 136, 199 

CBSACode 467, 509, 538 

output 467, 509, 538 

CBSADivisionCode 468, 509, 538 

output 468, 509, 538 

CBSADivisionName 468, 510, 538 

output 468, 510, 538 

CBSAMetro 468, 510, 538 

output 468, 510, 538 

CBSAName 469, 510, 538 

output 469, 510, 538 

CensusBlockID 469, 510, 538 

output 469, 510, 538 

CensusTract 469, 510, 538 

output 469, 510, 538 

centerline matching 296 

CenterlineBearing 471 

output 471 

CenterlineBlockLeft 471 

output 471 

626 

CenterlineBlockRight 471 

output 471 

CenterlineBlockSuffixLeft 471 

output 471 

CenterlineBlockSuffixRight 471 

output 471 

CenterlineDataCode 471 

output 471 

CenterlineDirection 472 

output 472 

CenterlineDistance 472 

output 472 

CenterlineHouseNumberHigh 472 

output 472 

CenterlineHouseNumberLow 472 

output 472 

CenterlineIsAlias 472 

output 472 

CenterlineLatitude 473 

output 473 

CenterlineLeadingDirectional 473 

output 473 

CenterlineLongitude 473 

output 473 

CenterlineOffset 455 


CenterlineParity 473 

output 473 

CenterlineRoadClass 473 

output 473 

CenterlineSegmentCode 473 

output 473 

CenterlineStreetName 473 

output 473 

CenterlineStreetSuffix 473 

output 473 

CenterlineTrailingDirectional 474 

output 474 

centroid matching 297 

CentroidPreference 454 


Centrus Enhanced Geocoding 291 

Centrus Enhanced Points 294 

Centrus Points 294 

Centrus Premium Points 294 

Centrus Tele Atlas Points 294 

Character field 18 

Character Map button 18 

City 342, 413, 430, 449, 474, 498, 511, 514, 525, 

539 

input 449 

output 342, 413, 430, 474, 498, 511, 514, 525, 

539 


CityPreferredName 481 

output 481 

CityShortName 482 

output 482 

CityStateRecordName 482 

output 482 

CloseMatchesOnly 333, 404, 429, 461 


CMRA 477 

output 477 

codes 555, 566, 571 

address location 555 

geographic centroid location 571 

match 571 

ZIP+4 centroid location 566 

Codes 565 

Street centroid location 565 

common objects 74, 137, 200 

datarow 74, 137, 200 

components 12 

Confidence 474, 511, 539 

output 474, 511, 539 

Connection Manager 256 

connections 16, 37, 63, 85, 126, 150, 161, 189, 209, 

256 

adding 37, 63, 85, 126, 150, 161, 189, 209, 256 

deleting 256 

modifying 37, 63, 85, 126, 150, 161, 189, 209, 

256 

server 16 

CoordinateSystem 332, 352, 403, 428, 523 

Country 342, 413, 430, 475, 498, 539 

output 342, 413, 430, 475, 498, 539 

CountryElevation 511 

output 511 

CountryLevel 485, 515, 543 

output 485, 515, 543 

County 431, 498 

output 431, 498 

creating dataflow options 87, 152, 214 

CrossStreetLeadingDirectional 480, 514, 542 

output 480, 514, 542 

CrossStreetName 481, 514, 542 

output 481, 514, 542 

CrossStreetSuffix 481, 514, 542 

output 481, 514, 542 

CrossStreetTrailingDirectional 481, 514, 542 

output 481, 514, 542 

CSACode 470, 510, 538 

output 470, 510, 538 

CSAName 470, 510, 538 

output 470, 510, 538 

custom database for Enterprise Geocoding 582 

Custom Logging Node 18, 279 

User's Guide 

custom logs 279, 280 

clearing 280 

deleting 280 

modifying 280 

Write to Stored Procedures 279 

Write to Tables 279 

Write to Views 279 

D 

data inspection 230, 234 

closing 234 

Database Connection Manager 37, 63, 85, 126, 150, 

161, 189, 209 

database runtime 85, 151, 210 

readers and writers 85, 151, 210 

DatabasePreference 339, 410 

databases 12, 290, 294 

DPV 294 

Enterprise Geocoding Module 290 

DatabaseSearchOrder 340, 411, 430, 525 

DatabaseVersion 485, 515, 543 

output 485, 515, 543 

Dataflow 23, 24, 25 

Channels 25 

Control Stages 24 

Deployed stages 25 

elements of 23 

New 23 

Palette 24 

Ports 25 

Primary Stages 25 

Rename 25 

Sinks 24 

Sources 24 

User-Defined Stages 25 

Dataflow Name tab 21 

Dataflows 90, 154, 215 

validating 90, 154, 215 

Dataset 498, 507, 533 

date ranges 271 

Datum 455 


Debug logging level 278 

defining database sources 83, 149, 208 

defining the input 156 

defining the output 143, 206 

defining transforms 73, 136, 199, 220 

case transforms 73, 136, 199 

copy transforms 73, 136, 199 

custom transforms 73, 136, 199 

field template transforms 73, 136, 199 

mask transforms 73, 136, 199 

627

defining transforms (continued) 

minimize whitespace transforms 73, 136, 199 

pad transforms 73, 136, 199 

remove transforms 73, 136, 199 

status transforms 73, 136, 199 

substring transforms 73, 136, 199 

trim transforms 73, 136, 199 

truncate transforms 73, 136, 199 

deleting dataflow options 88, 153, 215, 216 

Delivery Point Validation (DPV) 299 

DeliveryPointCode 482 

output 482 

Description field 18 

Distance 511, 539 

output 511, 539 

dockable windows 20 

DPV 294, 477 

database 294 

output 477 

DPVFootnotes 478 

output 478 

DPVSEED Header Record Layout 589 

dual addresses 298 

E 

Early Warning System 295 

database 295 

Early Warning System (EWS) 300 

Edit menu 22 

Elevation 480, 511, 539, 541 

output 480, 511, 539, 541 

Enterprise Designer 13, 19, 22 

described 19 

menus 22 

toolbar 22 

Enterprise Geocoding Module 290, 600 

databases 290 

described 290 

Geocode US Address 290 

matrix 600 

Reverse APN Lookup 290 

Enterprise Mapping Module 594, 600 

described 594 

documentation 594 

getting started 594 

matrix 600 

Error logging level 278 

Event Log node 18, 278 

Event Logging options 278 

Events subnode 278 

EWS 300 

628 

EWS (continued) 

See also Early Warning System 

USPS website 300 

See also Early Warning System 

EWS download address 300 


EWSMatch 485, 515, 543 

output 485, 515, 543 

Execution History 94, 95, 226, 227, 268, 269, 270 

details 95 

grouping columns 95, 227, 269 

selecting fields 95, 227, 268 

sorting grid data 95, 227, 269 

using 94, 226 

viewing details of 270 

Execution node 17 

Execution tab 18 

ExpirationDate 485, 515, 543 

output 485, 515, 543 

exporting dataflows 230 

F 

FallbackToGeographic 329, 349, 400, 455 


FallbackToPostal 329, 349, 400 

FallbackToStreet 454 


false-positive records 589, 591 

defined 589 

DPV header file layout 589 

reporting DPV violations 589 

reporting LACS/Link violations 591 

Fatal logging level 278 

fields 235 

renaming 235 

File field separator field 18 

File menu 22 

file servers 258, 272 

adding 258, 272 

deleting 258 

modifying 258 

File Servers subnode 258 

FindNearestIntersection 534 

FindNearestUnranged 533 

FindNearsetAddress 533 

FIPS county code 506 

FIPS state code 506 

FirmName 343, 414, 449, 475, 498, 511, 527, 539 

input 449 

output 343, 414, 475, 498, 511, 527, 539 

FirmNameSearch 457 



FirstLetterSearch 458 


Folders feature 21 

G 

GBR.ALIASED_LOCALITY 360 

GBR.AP_STATUS_FLAG 359 

GBR.DEPENDENT_LOCALITY 359 

GBR.DEPENDENT_STREET_NAME 359 

GBR.DOUBLE_DEPENDENT_LOCALITY 359 

GBR.HISTORIC_POSTCODE 360 

GBR.OSAPR 360 

GDT Geocoding 291 

Geocode Address Global 360 

GeocodeLevel 328, 348, 399 

Geocoder.MatchCode 353, 419, 433, 485, 501, 577 

output 353, 419, 433, 485, 501 

geocoding 10 

geocoding concepts 296 

Geocoding databases 291 

GeoStanMatchScore 485, 515, 543 

output 485, 515, 543 

GNAF PID Location Search 496 

GNAFPointType 331, 351, 402, 497 

GovernmentBuilding 482 

output 482 

Groovy scripting 74, 137, 200 

looping 74, 137, 200 

Group Statistics 51, 52, 53, 114, 115, 116, 177, 178, 

179 

using the Group Statistics stage 51, 114, 177 

using the Operations tab 52, 115, 178 

using the Output tab 53, 116, 179 

H 

Help menu 18, 22 

HouseNumber 344, 414, 481, 499, 514, 527, 542 

output 344, 414, 481, 499, 514, 527, 542 

HouseNumberHigh 344, 414, 488, 499, 517, 527, 

546 

output 344, 414, 488, 499, 517, 527, 546 

HouseNumberLow 344, 414, 488, 499, 517, 527, 546 

output 344, 414, 488, 499, 517, 527, 546 

HouseNumberParity 344, 414, 488, 499, 518, 527, 

546 

output 344, 414, 488, 499, 518, 527, 546 

I 

importing dataflows 230 

Info logging level 278 

User's Guide 

input 299, 448, 449 








City 449 

FirmName 449 

LastLine 449 

PostalCode 449 

StateProvince 449 

input option 452, 453, 454, 455, 456, 457, 458, 459, 

460, 461, 463, 464, 473 

AddressPointInterpolation 456 


AlwaysFindCandidates 473 

BuildingSearch 458 

CenterlineOffset 455 

CentroidPreference 454 

CloseMatchesOnly 461 

Datum 455 

FallbackToGeographic 455 

FallbackToStreet 454 

FirmNameSearch 457 

FirstLetterSearch 458 

KeepCandidates 460 

KeepMultimatch 460 

LatLonFormat 454 

MatchMode 461 

Offset 452 

OutputCasing 463 

OutputFields 464 

OutputFormattedOnFail 463 

OutputPostalCodeSeparator 463 

OutputRecordType 464 

OutputVerbose 463 

PerformDPV 459 

PerformLacsLink 459 

PreferZipCodeOverCity 460 

RetreiveAPN 459 

RetreiveElevation 456 

Squeeze 453 

inspection points 231, 232, 233 

choosing data 233 

choosing fields 233 

correlating data 232 

deleting 231 

moving 231 

sorting data 233 

updating jobs containing 232 

Inspection Results toolbar 232 

629

Interactive Driver 26 

described 26 

Interpolation 328, 349, 399 

Intersection 485, 515, 543 

output 485, 515, 543 

IsAlias 486, 516, 544 

output 486, 516, 544 

IsCloseMatch 353, 419, 433, 486, 501 

output 353, 419, 433, 486, 501 

J 

JDBC Drivers subnode 257 

Job Manager 589 

DPV Seed Record Violation 589 

Job Options subnode 270 

jobs 86, 90, 94, 224, 231 

exposing 90 

inspecting 231 

running 90, 224 

terminating 86 

using Jobs Manager 94 

K 

KeepCandidates 460 


KeepMultimatch 460 


KeepMultiMatch 333, 404, 429, 524 

L 

LACSAddress 486, 516, 544 

output 486, 516, 544 

LACSLink database 295 

LastLine 344, 415, 449, 466, 475, 499, 511, 527, 539 

input 449 

output 344, 415, 466, 475, 499, 511, 527, 539 

Latitude 419, 433, 475, 480, 501, 511, 513, 540, 541 

output 419, 433, 475, 480, 501, 511, 513, 540, 

541 

LatLonFormat 454, 535 


LatLongFormat 507 

LeadingDirectional 344, 415, 481, 499, 514, 527, 542 

output 344, 415, 481, 499, 514, 527, 542 

License Information Subnode 282 

Locality 334, 405, 499 

output 499 

Locatable Address Conversion System (LACS) 299 

location codes 555, 566, 571 

address 555 

630 

location codes (continued) 

geographic centroid 571 

ZIP+4 centroid 566 

Location codes 565 

Street centroid 565 

LocationCode 475, 511, 540 

output 475, 511, 540 

LocationCode.Description 486, 516, 544 

output 486, 516, 544 

LocationPrecision 354, 420, 434, 502 

output 354, 420, 434, 502 

logs 279 

adding 279 

creating new 279 

Longitude 419, 433, 476, 480, 501, 511, 513, 540, 

542 

output 419, 433, 476, 480, 501, 511, 513, 540, 

542 

M 

malformed input records 38 

malformed records 38 

configuring job settings 38 

Malformed Records Sink 38 

Manage field separators dialog box 18 

Management Console 12, 17, 19 

primary window 17 

toolbar 19 

Mangement Console 17 

described 17 

mask transforms 73, 75, 136, 138, 199, 201 

examples 75, 138, 201 

using 75, 138, 201 

match codes 571 

MatchCode 476, 511, 540 

output 476, 511, 540 

MatchCode.Description 486, 516, 544 

output 486, 516, 544 

MatchMode 461 


Math 54, 56, 58, 59, 60, 61, 117, 119, 121, 122, 123, 

124, 180, 182, 184, 185, 186, 187 

using conditional statements 58, 121, 184 

using functions and constants 56, 119, 182 

using the Expressions console 59, 122, 185 

using the Fields control 60, 123, 186 

using the Math stage 54, 117, 180 

using the Preview control 61, 124, 187 

Maximum number of records to process field 18 

MCDCode 465 

output 465 


MCDName 465 

output 465 

modifying dataflow options 88, 153, 215, 216 

modules 11 

Modules node 17 

MultiMatchCount 353, 419, 433, 501 

output 353, 419, 433, 501 

MustMatch2DigitPostalCode 338, 408 

MustMatchCity 335, 406, 462 

MustMatchCount 335, 406 

MustMatchFullPostalCode 337, 408 

MustMatchHouseNumber 334, 405, 462 

MustMatchInput 333, 404, 461 

MustMatchLocality 334, 405 

MustMatchPostalCode 337, 408, 462 

MustMatchPostalDistrict 337, 408 

MustMatchStateProvince 336, 407, 462 

MustMatchStreet 334, 405, 462 

N 

NAVTEQ Geocoding 291 

Notification subnode 280 

Notifications 94 

setting up notifications in 94 

NumberOfCandidateRanges 345, 416, 499, 528 

output 345, 416, 499, 528 

NumberOfRangeUnits 345, 416, 499, 529 

output 345, 416, 499, 529 

O 

Offset 452, 534 


OffsetFromCorner 330, 350, 401, 522 

OffsetFromStreet 329, 349, 400, 521 

Options option 18 

Options subnode 271, 284 

Options tab 26 

output 342, 343, 344, 345, 346, 347, 348, 353, 354, 

355, 356, 357, 358, 412, 413, 414, 415, 

416, 417, 418, 419, 420, 421, 422, 423, 

424, 425, 430, 431, 432, 433, 434, 465, 

466, 467, 468, 469, 470, 471, 472, 473, 

474, 475, 476, 477, 478, 480, 481, 482, 

483, 484, 485, 486, 487, 488, 489, 490, 

498, 499, 500, 501, 502, 503, 504, 505, 

506, 509, 510, 511, 512, 513, 514, 515, 

516, 517, 518, 519, 525, 527, 528, 529, 

530, 531, 538, 539, 540, 541, 542, 543, 

544, 545, 546, 547 

AdditionalInputData 511, 539 

AddressLine 466 

User's Guide 

output (continued) 

AddressLine1 342, 412, 474, 498, 511, 525, 539 

AddressLine2 342, 412, 474, 498, 511, 525, 539 

AddressLineResolved 484 

Alternate 488, 517, 545 

ApartmentLabel 342, 412, 480, 498, 514, 525, 

542 

ApartmentLabel2 480, 514, 542 

ApartmentNumber 342, 412, 480, 498, 514, 525, 

542 

ApartmentNumber2 480, 514, 542 

APN 467, 511, 538 

AUS.GNAF_Confidence 355, 421, 503 

AUS.GNAF_Eight_Digit_Latitude 355, 422, 504 

AUS.GNAF_Eight_Digit_Longitude 356, 422, 504 

AUS.GNAF_Geocode_Level 356, 422, 504 

AUS.GNAF_PID 356, 423, 505 

AUS.GNAF_Reliability 357, 423, 505 

AUS.Mesh_Block_ID 358, 424, 506 

AuxiliaryData 465 

BlockLeft 489, 518, 546 

BlockLine 466 

BlockLine1 466, 477 






BlockRight 489, 518, 547 

BlockSuffix 467, 509, 538 

BlockSuffixLeft 489, 518, 547 

BlockSuffixRight 489, 518, 547 

CAN.Census_CD 358, 424 

CAN.Census_CMA 358, 424 

CAN.Census_CSD 358, 425 

CAN.Census_CT 358, 425 

CAN.Census_DA 358, 425 

CBSACode 467, 509, 538 

CBSADivisionCode 468, 509, 538 

CBSADivisionName 468, 510, 538 

CBSAMetro 468, 510, 538 

CBSAName 469, 510, 538 

CensusBlockID 469, 510, 538 

CensusTract 469, 510, 538 

CenterlineBearing 471 

CenterlineBlockLeft 471 

CenterlineBlockRight 471 

CenterlineBlockSuffixLeft 471 

CenterlineBlockSuffixRight 471 

CenterlineDataCode 471 

CenterlineDirection 472 

CenterlineDistance 472 

CenterlineHouseNumberHigh 472 

CenterlineHouseNumberLow 472 

631


CenterlineIsAlias 472 

CenterlineLatitude 473 

CenterlineLeadingDirectional 473 

CenterlineLongitude 473 

CenterlineParity 473 

CenterlineRoadClass 473 

CenterlineSegmentCode 473 

CenterlineStreetName 473 

CenterlineStreetSuffix 473 

CenterlineTrailingDirectional 474 

City 342, 413, 430, 474, 498, 511, 514, 525, 539 

CityPreferredName 481 

CityShortName 482 

CityStateRecordName 482 

CMRA 477 

Confidence 474, 511, 539 

Country 342, 413, 430, 475, 498, 511, 539 

CountryLevel 485, 515, 543 

County 431, 498 

CrossStreetLeadingDirectional 480, 514, 542 

CrossStreetName 481, 514, 542 

CrossStreetSuffix 481, 514, 542 

CrossStreetTrailingDirectional 481, 514, 542 

CSACode 470, 510, 538 

CSAName 470, 510, 538 

DatabaseVersion 485, 515, 543 

DeliveryPointCode 482 

Distance 511, 539 

DPV 477, 478 

Elevation 480, 511, 539, 541 

EWSMatch 485, 515, 543 

ExpirationDate 485, 515, 543 

FirmName 343, 414, 475, 498, 511, 527, 539 

Geocoder.MatchCode 353, 419, 433, 485, 501 

GeoStanMatchScore 485, 515, 543 

GovernmentBuilding 482 

HouseNumber 344, 414, 481, 499, 514, 527, 542 

HouseNumberHigh 344, 414, 488, 499, 517, 527, 

546 

HouseNumberLow 344, 414, 488, 499, 517, 527, 

546 

HouseNumberParity 344, 414, 488, 499, 518, 

527, 546 

Intersection 485, 515, 543 

IsAlias 486, 516, 544 

IsCloseMatch 353, 419, 433, 486, 501 

LACSAddress 486, 516, 544 

LastLine 344, 415, 466, 475, 499, 511, 527, 539 

Latitude 419, 433, 475, 480, 501, 511, 513, 540, 

541 

LeadingDirectional 344, 415, 481, 499, 514, 527, 

542 

Locality 499 

632 


LocationCode 475, 511, 540 

LocationCode.Description 486, 516, 544 

LocationPrecision 354, 420, 434, 502 

Longitude 419, 433, 476, 480, 501, 511, 513, 

540, 542 

MatchCode 476, 511, 540 

MatchCode.Description 486, 516, 544 

MCDCode 465 

MCDName 465 

MultiMatchCount 353, 419, 433, 501 

NumberOfCandidateRanges 345, 416, 499, 528 

NumberOfRangeUnits 345, 416, 499, 529 

PercentGeocode 512, 540 

PointCode 519 

PostalBarCode 482 

PostalCode 346, 416, 431, 476, 499, 512, 529, 

540 

PostalCode.Addon 346, 416, 500, 529 

PostalCode.AddOn 476, 512, 540 

PostalCode.Base 476, 512, 540 

PostalCodeClass 482 

PostalCodeExtensionHigh 488, 518, 546 

PostalCodeExtensionLow 488, 518, 546 

PostalCodeUnique 482 

PostalFacility 483 

PreAddress 346, 416, 500, 529 

PrivateMailbox 346, 416, 481, 500, 514, 529, 542 

PrivateMailbox.Designator 481, 514, 543 

ProcessedBy 476, 512, 540 

RecordType 486, 516, 544 

RecordType.Default 487, 517, 545 

RoadClass 489, 519, 547 

RRHC 481, 515, 540 

SegmentCode 346, 417, 489, 519, 529, 547 

SegmentDirection 490, 519, 547 

SegmentHouseNumberHigh 490, 519, 547 

SegmentHouseNumberLow 490, 519, 547 

SegmentLength 490, 519, 547 

SegmentParity 346, 417, 490, 500, 519, 529, 547 

StateProvince 431, 476, 500, 512, 540 

Status 353, 419, 433, 476, 501, 512, 540 

Status.Code 353, 420, 433, 476, 502, 540 

Status.Description 353, 420, 434, 476, 502, 512, 

541 

StreetDataCode 487, 517, 545 

StreetDataType 347, 418, 432, 487, 500, 513, 

530, 541, 545 

StreetName 347, 418, 419, 432, 481, 500, 501, 

515, 531, 543 

StreetPrefix 347, 418, 500, 531 

StreetSide 477, 513, 541 

StreetSide.NAVTEQ 490 

StreetSuffix 347, 418, 481, 500, 515, 531, 543 



TrailingDirectional 348, 418, 481, 500, 515, 531, 

543 

UnitNumberHigh 348, 418, 488, 500, 518, 531, 

546 

UnitNumberLow 348, 418, 488, 500, 518, 531, 

546 

UnitNumberParity 488, 518, 546 

USBCCheckDigit 483 

USCarrierRouteCode 483 

USCarrierRouteSort 483 

USCityDelivery 483 

USCountyName 470, 510, 538 

USFIPSCountyCode 513 

USFIPSCountyNumber 470, 539 

USFIPSStateCode 470, 513, 539 

USFIPSStateCountyCode 470, 510, 539 

USLACS 483 

USLACS.ReturnCode 484 

USLotCode 484 

USUrbanName 477, 513, 541 

output fields 82, 147, 148, 212 

adding 82, 147, 212 

sorting 82, 148, 212 

output files 80, 145, 210 

defining 80, 145, 210 

OutputCasing 463, 508, 536 


OutputFields 464, 509, 537 


OutputFormattedOnFail 463 


OutputPostalCodeSeparator 463 


OutputRecordType 464, 508, 536 


OutputVerbose 463, 508, 536 


P 

pad transforms 73, 136, 199 

Palette 20, 21 

PercentGeocode 512, 540 

output 512, 540 

PerformDPV 459 


PerformLacsLink 459 


point-level matching 296 

PointCode 519 

output 519 

Points databases 294 

User's Guide 

port number 16 

default 16 

PostalBarCode 482 

output 482 

PostalCode 346, 416, 431, 449, 476, 499, 512, 529, 

540 

input 449 

output 346, 416, 431, 476, 499, 512, 529, 540 

PostalCode.Addon 346, 416, 500, 529 

output 346, 416, 500, 529 

PostalCode.AddOn 476, 512, 540 

output 476, 512, 540 

PostalCode.Base 476, 512, 540 

output 476, 512, 540 

PostalCodeClass 482 

output 482 

PostalCodeExtensionHigh 488, 518, 546 

output 488, 518, 546 

PostalCodeExtensionLow 488, 518, 546 

output 488, 518, 546 

PostalCodeUnique 482 

output 482 

PostalFacility 483 

output 483 

PreAddress 346, 416, 500, 529 

output 346, 416, 500, 529 

PreferPOIOverStreet 338, 409 

PreferZipCodeOverCity 460 


Preview tab 26, 264 

previewing input 26, 264 

entering data manually 264 

previewing output 28 

PrivateMailbox 346, 416, 481, 500, 514, 529, 542 

output 346, 416, 481, 500, 514, 529, 542 

PrivateMailbox.Designator 481, 514, 543 

output 481, 514, 543 

Process Flow 220, 223 

creating 220 

transition options 223 

Process Flow Details 226 

process flows 220, 227 

creating 220 

defining 220 

deleting 227 

Process Flows tab 268 

Process List 234 

how to use 234 

overview 234 

ProcessedBy 476, 512, 540 

output 476, 512, 540 

633

Q 

QueryDB 61, 124, 187 

defining database sources 61, 124, 187 

R 

Read from DB 37, 160 

defining database sources 37, 160 

defining sources 37, 160 

read from file 32, 161 

defining input files 32, 161 

RecordID field 79, 142, 205 

RecordType 486, 516, 544 

output 486, 516, 544 

RecordType.Default 487, 517, 545 

output 487, 517, 545 

Remote Servers 236, 272, 274, 275 

adding 272 

deleting 274 

error conditions in Enterprise Designer 236 

error conditions in Management Console 275 

modifying 274 

routing to in Management Console 272 

Report Subnode 271 

reports 88, 89 

setting options 89 

using 88 

Reports 271 

accessing in Management Console 271 

Reports Subnode 88, 89, 271 

activating reports 88 

setting job level options 89 

setting report level options 89 

Reports Window 20, 21 

Representational State Transfer (REST) 152 

Resources node 17 

RetreiveAPN 459 


RetreiveElevation 456 


RetrieveAPN 534 

RetrieveElevation 508, 535 

ReturnOnlySimilarFirmNames 341, 412 

ReturnPOIWithStreet 338, 409 

Reverse APN Lookup 506 

Reverse Geocode Address Global 519 

Reverse Geocoding database 293 

RoadClass 489, 519, 547 

output 489, 519, 547 

Routing button 235, 273 

RRHC 481, 515, 540 

output 481, 515, 540 

634 

Run menu 22 

Run Service Settings tab 18 

S 

scripting areas 50, 113, 176 

router 50, 113, 176 

SearchDistance 533 

Security node 18, 284 

seed record violations, See false-positive records 

SegmentCode 346, 417, 489, 519, 529, 547 

output 346, 417, 489, 519, 529, 547 

SegmentDirection 490, 519, 547 

output 490, 519, 547 

SegmentHouseNumberHigh 490, 519, 547 

output 490, 519, 547 

SegmentHouseNumberLow 490, 519, 547 

output 490, 519, 547 

SegmentLength 490, 519, 547 

output 490, 519, 547 

SegmentParity 346, 417, 490, 500, 519, 529, 547 

output 346, 417, 490, 500, 519, 529, 547 

server 11, 16 

connecting to 16 

Server Explorer 21 

service input 156 

service output 143, 206 

setting dataflow options 87, 88, 152, 153, 214, 215, 

216 

creating dataflow options 87, 152, 214 

deleting dataflow options 88, 153, 215, 216 

modifying dataflow options 88, 153, 215, 216 

setting output runtime properties 83, 148, 213 

setting up a job 90, 94, 224 

running the job 90, 224 

using Job Manager 94 

Simple Object Access Protocol (SOAP) 152 

Sort Performance subnode 276 

Squeeze 453, 535 


StateProvince 431, 449, 476, 500, 512, 540 

input 449 

output 431, 476, 500, 512, 540 

Status 353, 419, 433, 476, 501, 512, 540 

output 353, 419, 433, 476, 501, 512, 540 

Status.Code 353, 420, 433, 476, 502, 512, 540 

output 353, 420, 433, 476, 502, 540 

outputoutput 512 

Status.Code 512 

Status.Description 353, 420, 434, 476, 502, 512, 541 

output 353, 420, 434, 476, 502, 512, 541 

Street centroid location codes 565 

street matching 296 


StreetDataCode 487, 517, 545 

output 487, 517, 545 

StreetDataType 347, 418, 432, 487, 500, 513, 530, 

541, 545 

output 347, 418, 432, 487, 500, 513, 530, 541, 

545 

StreetName 347, 418, 419, 432, 481, 500, 501, 515, 

531, 543 

output 347, 418, 419, 432, 481, 500, 501, 515, 

531, 543 

StreetPrefix 347, 418, 500, 531 

output 347, 418, 500, 531 

StreetSide 477, 513, 541 

output 477, 513, 541 

StreetSide.NAVTEQ 490 

output 490 

StreetSuffix 347, 418, 481, 500, 515, 531, 543 

output 347, 418, 481, 500, 515, 531, 543 

substring transforms 73, 136, 199 

System node 17 

T 

Task Window 20 

Time-out in seconds field 18 

Tools menu 18, 22 

Trace logging level 278 

TrailingDirectional 348, 418, 481, 500, 515, 531, 543 

output 348, 418, 481, 500, 515, 531, 543 

Transaction History node 18 

Transaction History Node 271 

Transactions 271 

Summary Report 271 

how to access 271 

transforms 73, 74, 75, 76, 77, 136, 137, 138, 139, 

140, 199, 200, 201, 202, 203 

changing the order of 73, 136, 199 

condition sample 76, 139, 202 

customizing 74, 137, 200 

data augmentation sample 77, 140, 203 

Groovy scripting 74, 137, 200 

mask transforms 75, 138, 201 

Transition options 223 

trim transforms 73, 136, 199 

truncate transforms 73, 136, 199 

U 

Unicode field 18 

Unique ID Generator 77, 78, 79, 140, 141, 142, 203, 

204, 205 

appending a unique ID field 78, 141, 204 

defining a unique ID 78, 141, 204 

User's Guide 

Unique ID Generator (continued) 

defining Unique ID Field 78, 141, 204 

described 77, 140, 203 

output 79, 142, 205 

UnitNumberHigh 348, 418, 488, 500, 518, 531, 546 

output 348, 418, 488, 500, 518, 531, 546 

UnitNumberLow 348, 418, 488, 500, 518, 531, 546 

output 348, 418, 488, 500, 518, 531, 546 

UnitNumberParity 488, 518, 546 

output 488, 518, 546 

USBCCheckDigit 483 

output 483 

USCarrierRouteCode 483 

output 483 

UsCarrierRouteSort 483 

output 483 

USCityDelivery 483 

output 483 

USCountyName 470, 510, 538 

output 470, 510, 538 

users 284, 285 

adding new 284 

deleting 285 

modifying 284 

USFIPSCountyCode 513 

output 513 

USFIPSCountyNumber 470, 539 

output 470, 539 

USFIPSStateCode 470, 513, 539 

output 470, 513, 539 

USFIPSStateCountyCode 470, 510, 539 

output 470, 510, 539 

USLACS 483 

output 483 

USLACS.ReturnCode 484 

output 484 

USLotCode 484 

output 484 


EWS download address 300 

USUrbanName 477, 513, 541 

output 477, 513, 541 

V 

Version Information Subnode 281 

View menu 22 

W 

Warn logging level 278 

web services 152 

Window menu 22 

635

Write to DB 83, 84, 149, 150, 208, 209 

defining database sinks 84, 150, 209 

defining sinks 84, 150, 209 

defining sources 83, 149, 208 

636 

Z 

ZIP + 4 Centroid 291

MapInfo Spatial Server Architecture - Documentation - MapInfo

Create successful ePaper yourself

Delete template?

Save as template?