GeoCode

Program ID          

MetraPipeline.MTGeoCodePlugin.1

Description

The GeoCodeLookup plug-in looks up the GeoCode value for a given city, state, and ZIP code. The configuration file contains configuration information needed by the GeoCodeLookup plug-in to determine the GeoCode. The GeoCodeLookup plug-in only runs if the GeoCodeApplicability plug-in determined that the GeoCode applies to the account.

For more information on configuring the GeoCoder application, see the Account Server Programmer Guide or GeoCoder Geographic Coding System, Vertex, 1998.

Required Input Properties

Tag name

Value type

Description

State

String

A valid stage code; MA, PA, CA, etc.

City

String

City name.  For information on formatting requirements see the Vertex Geocode documentation.

Zipcode

String

Valid 5 digit US ZIP code.

ApplyGeoCode

Boolean

Whether to calculate the geocode or not.

Required Output Properties

Tag name

Value type

Description

Geocode

long

The Vertex Geocode for the given State, City, and ZIP code.

Additional Configuration Tags

Tag name

Value type

Description

ConfigFile

String

The configuration file for the Geocode objects.  Should be "tax\MTGeoCoder.xml"

BillToId

integer

Unused.

Configuration Example

<configdata>
  <State>state</State>
  <City>city</City>
  <Zipcode>zip</ZipCode>
  <ApplyGeoCode>ApplyGeoCode</ApplyGeoCode>
  <Geocode>GeoCode</Geocode>
  <ConfigFile>tax\MTGeoCoder.xml</ConfigFile>
  <BillToId ptype="INTEGER">1</BillToId>
</configdata>

Remarks

The geocode will not be calculated if the GeoCode platform extension is not installed.