Microsoft Bing Maps Plug-in

The Microsoft Bing Maps Plug-in for Convergence for MDM uses the Bing Location API to provide an enricher for international postal addresses. This enricher cleanses, standardizes and enriches the postal address with geocoding information.

Bing Maps Enricher

Plug-in ID

Google Bing Enricher - com.semarchy.engine.plugins.bing.address

Description

This enricher takes an input address, enriches and validates this postal address using the Bing Maps Service.

Note: This plugin must be used in compliance with the Microsoft Bing Maps APIs Terms of Service.

Note: This enricher uses the Bing Maps Service, which must be accessible from the Convergence for MDM Application at the URL specified in the Bing Location URL parameter. Make sure to make this URL accessible through your firewalls.

Plug-in Parameters

The following table lists the plug-in parameters.

Parameter Name Mandatory Type Description
Bing Maps Key Yes String To use the Bing Maps Services, you must have a Bing Maps Key.
Bing Location URL Yes String This URL will be used to query Bing Location API.

Plug-in Inputs

The following table lists the plug-in inputs.

Parameter Name Mandatory Type Description
Address Line Yes String Address line to process.
Postal Code No String Postal code of the address.
City No String City of the address.
Country No String Country of the address.

Note: The entire address, including the Address Line, Postal Code, City and Country values can be passed to the plugin as a single concatenated string in the Address Line input. If the source data contains the address in a single string, then you can pass this string directly in the Address Line input.

Plug-in Outputs

The following table lists the plug-in outputs.

Parameter Name Type Description
Administrative District String The subdivision name within the country or region for an address, such as the abbreviation of a US state.
Administrative District 2 String The subdivision name within the administrative district for an address.
Confidence String Defines the confidence of the location match found by the geocoding service. Possible values: High, Medium, Low.
Country or Region String The country or region name of the address.
Formatted Address String A string specifying the complete address. This address may not include the country or region.
Status Code String The HTTP Status code for the request.
Status Description String A description of the HTTP status code.
Latitude String Latitude of the location.
Locality String The locality, such as the primary city, that corresponds to an address.
Longitude String Longitude of the address.
Match Code String Defines the geocoding level of the location match found by the geocoder. One or more of the following values: Good, Ambiguous, UpHierarchy
Postal Code String The city or neighborhood that corresponds to the postal code.
Process Code String Code that indicates the result status of the process.