Semarchy xDM plug-in reference guide

Input Filter

No

String

Transformation

Yes

String

Synonyms Separator

No

String

Input Text

Yes

String

Transformed Text

String

Filtered and transformed text.

Secondary Transformed Text

String

Secondary transformed text. This text may contain transformation resulting from a Beidermorse or Double Metaphone transformation. See Other Transformations for more information.

Cache Lookup Data

No

String

Custom SQL

No

String

Datasource

No

String

Fallback Behavior

No

String

Fallback Value

No

String

Lookup Column

No

String

Mapping Table

No

String

Output Column

No

String

Lookup Value

Yes

String

Output Value

String

Value returned by the lookup.

Application Name

Yes

String

Google Key

Yes

String

Input Text

Yes

String

Source Language

No

String

Target Language

Yes

String

Translated Text

String

Translated Text.

Surname Position

Yes

String

Case Transformation

Yes

String

Input Name

Yes

String

Source Country Code

Yes

String

Full Name

String

The reconstructed full name, with the surname positioned according to the Surname Position parameter.

Gender

String

The gender of the Matched Given Name. One of MALE, FEMALE, UNISEX, UNKNOWN.

Gender Score

String

Confidence with which for Most Frequent Gender can be used [0-100].

Given Name

String

The part identified as Given Name in the input name.

Matched Given Name

String

Given name matched in the given name database.

Most Frequent Gender

String

The more frequent gender of the Matched Given Name for the given country. One of MALE, FEMALE, UNKNOWN.

Names Parsing Score

String

Names Parsing confidence [0-100]

Surname

String

The part identified as Surname in the input name.

Surname Position

String

Position at which the surname was detected.

Input Phone Number

Yes

String

Region Code

No

String

Enriched Phone Format

No

String

Region of Origin

No

String

Enriched Phone Number

String

Phone number returned by the enricher in the format specified in the Enriched Phone Format input. This string is null if the enricher was not able to process the input phone number. The Status Code and Status Text value help troubleshooting such issues.

Geocoding Data

String

Geocoding data computed for a given number and country. Depending on the country and phone number, this value includes the country, region/state and city information. This string is null if the enricher was not able to process the input phone number. The Status Code and Status Text value help troubleshooting such issues.

Status Code

String

Return code for the phone number processing. More details about the Status Codes.

Status Text

String

Text explaining the status code.

International Phone Prefix

String

International Phone Prefix for worldwide dialing.

National Number

String

National number part of a phone number in International format. It is often the International number without the Country Prefix.

Extension

String

Extension part of the phone number.

Country Code Source

String

Explains how the Country Code was retrieved. Possible values are FROM_NUMBER_WITH_PLUS_SIGN, FROM_NUMBER_WITH_IDD, FROM_NUMBER_WITHOUT_PLUS_SIGN and FROM_DEFAULT_COUNTRY.

Leading Zero

String

Returns 0 or 1 to specify if leading zero is mandatory for foreign calls.

Possible Phone Number

String

Returns 0 or 1 to indicate whether a phone number is a possible number, and the region where the number could be dialed from.

Possible Phone Number Reason

String

Detailed explanation of why a phone number is a possible number or not. Possible values are INVALID_COUNTRY_CODE, IS_POSSIBLE, TOO_LONG and TOO_SHORT.

Valid Phone Number

String

Returns 0 or 1 to indicate whether a phone number matches a valid pattern.

Valid Phone Number For Region

String

Returns 0 or 1 to indicate that a phone number is valid for the specified Region Code.

Phone Line Type

String

Provides the line type of a phone number. Possible values are : FIXED_LINE, FIXED_LINE_OR_MOBILE, MOBILE, PAGER, PERSONAL_NUMBER, PREMIUM_RATE, SHARED_COST, TOLL_FREE, UAN, UNKNOWN and VOIP

Region Code

String

Returns the region code for the Phone Number. See this link for the list of codes.

International Phone Number

String

Phone number formatted for international dialing.

Time Zones

String

List of corresponding time zones for a given number. For example: Europe/Paris. If the timezone is unknown, returns Etc/Unknown

First Time Zone

String

First time zone from the list of corresponding time zones for a given number.

Carrier Name

String

Name of the carrier for the phone number.

Matching Leniency

No

String

Extraction Format

No

String

List Separator

No

String

Maximum Invalid Numbers

No

String

Input Text

Yes

String

Accepted Region

No

String

Extracted Phone List

String

List of phone numbers extracted.

Phone 1 to Phone 5

String

First, second… extracted phone number in the list.

Validation Leniency

No

String

Input Phone Number

Yes

String

Country Code

No

String

Datasource

No

String

Lowercase User Name

No

String

Offline Mode

No

String

Processing Mode

No

String

Input Email Address

Yes

String

Cleansed Email Address

String

Cleansed email address returned by the enricher. This address may be valid or not. The syntactic validity or domain name validity of the email address is indicated in the other plug-in outputs.

Valid Domain

String

Flag (0 or 1) indicating whether the domain name is valid or not (based on syntax and MX records lookup) in the cleansed email address. In Offline mode, this parameter returns 1 or 0 if the domain name appears in the local domain cache as valid or invalid. It returns null if the domain name does not exist in the cache and the MX Lookup was not issued.

Valid Domain Syntax

String

Flag (0 or 1) indicating whether the domain name syntax is valid or not in the cleansed email address.

Valid Email Syntax

String

Flag (0 or 1) indicating whether the cleansed email address is syntactically valid or not.

Valid Username Syntax

String

Flag (0 or 1) indicating whether the local-part (user name) syntax is valid or not in the cleansed email address.

Valid Input Domain

String

Flag (0 or 1) indicating whether the domain name is valid or not (based on syntax and MX records lookup) in the input email address. In Offline mode, this parameter returns 1 or 0 if the domain name appears in the local domain cache as valid of invalid. It returns null if the domain name does not exist in the cache and the MX Lookup was not issued.

Valid Input Domain Syntax

String

Flag (0 or 1) indicating whether the domain name syntax is valid or not in the input email address.

Valid Input Email Syntax

String

Flag (0 or 1) indicating whether the input email address is syntactically valid or not.

Valid Input Username Syntax

String

Flag (0 or 1) indicating whether the local-part (user name) syntax is valid or not in the input email address.

Accepted Domains

No

String

Offline Mode

No

String

Processing Mode

No

String

Input Email Address

Yes

String

Input email address to check.

On-Premise Host

No

String

On-Premise Port

No

String

On-Demand URL

No

String

Data Elements Format

No

String

Pool Names List

No

String

Address Line

Yes

String

Postal Code

No

String

City

No

String

Country

No

String

Pool Names List

No

String

Formatted Address
These outputs contain address information formatted and suitable for mailing purposes.

Address

String

Comma-separated list of address lines. This output contains the full formatted address.

Address Key

String

UK Address Key as defined by the Royal Mail.

Ambiguity
These outputs contain information for ambiguous matches.

Ambiguity List

String

Comma-separated list of address elements and postal codes of the form: Address Elements;Postal Code. This list is provided if the search result is ambiguous.

Ambiguity List Count

Integer

Count of entries in the ambiguity list.

Address Items
These outputs contain address tokens.

Organization

String

Organization Name.

Building Name

String

Name of the building.

Building Number

String

Number of the building.

Sub-Building

String

Sub-building information. Postal boxes (PO Box) information appear in this field.

Street

String

Street of the address.

Dependent Street

String

Street to which this address’ street depends to.

Locality

String

Locality of the address.

Dependent Locality

String

Locality to which this address’ locality depends to.

County

String

Name of the county or province.

Postal Code

String

Postal code.

Postal Town

String

Town or City.

Country

String

Country of the address.

Country Code

String

Country code.

Error Management
These outputs contain result and error codes for the processing of the address.

Result Code

Integer

Result code for the address search. See Error Management Outputs for more information.

Error Code

String

Error code returned by the server.

Error Text

String

Error message returned by the server.

Address Quality
These outputs contain information about the quality of the output address and match process.

Field Status

String

8 character string. Each character represents how each address element was matched. See Address Quality Outputs for more information.

Match Score

Integer

Percentage score describing the quality of the address match.

Match Level

Integer

Address element to which the address is matched. See Address Quality Outputs for more information.

Output Status

String

This output field contains the status of the address match; Whether Verified, Corrected, Parsed or Not Matched. See Address Quality Outputsfor more information.

Postal Code Change Level

String

The level at which the matched postal code differs from the input postal code. See Address Quality Outputs for more information.

Input Postal Code Level

Integer

Level of postal code input: 0 - No post code, 4 - Postal code.

Output Postal Code Level

Integer

Level of postal code match: 0 - No post code, 4 - Postal code.

Geocoding
These outputs contain information about address geocoding.

Latitude

Float

GPS (WGS84) latitude in degrees decimal

Longitude

Float

GPS (WGS84) longitude in degrees decimal

Geocoding Level

Integer

Geocoding level for this address. See Geocoding Outputs for more information.

Geocoding Status

String

Geocoding status for this address. See Geocoding Outputs for more information.

Client ID or API Key

No

String

Private Key

No

String

Default Language

No

String

Address Line

Yes

String

Postal Code

No

String

City

No

String

Country

No

String

Language

No

String

Address Types

String

Comma-separated list of address types (See Address Types for more information.).

Administrative Area Level 1*

String

First-order civil entity below the country level. Within the United States, these administrative levels are states. Not all countries exhibit these administrative levels.

Administrative Area Level 2*

String

Second-order civil entity below the country level. Within the United States, these administrative levels are counties. Not all countries exhibit these administrative levels.

Administrative Area Level 3*

String

Third-order civil entity below the country level. Not all countries exhibit these administrative levels.

Airport

String

Indicates an airport. NOTE: This output is deprecated.

Country*

String

The national political entity.

East Bound Longitude

String

Bounding box eastern limit.

Floor*

String

Indicates the floor of a building address.

Formatted Address

String

Human-readable version of the geocoded address.

Intersection

String

Major intersection, usually of two major roads. NOTE: This output is deprecated.

Latitude

String

Latitude of the address.

Locality*

String

Incorporated city or town political entity.

Longitude

String

Longitude of the address.

Natural Feature*

String

Prominent natural feature.

Neighborhood*

String

Named neighborhood.

North Bound Latitude

String

Bounding box northern limit.

Park*

String

Named park.

Point of Interest*

String

Named point of interest.

Post Box*

String

Specific postal box.

Postal Code*

String

Postal code as used to address postal mail within the country.

Premise*

String

Named location, usually a building or collection of buildings with a common name.

Quality

String

The value of an Address Quality element defines the granularity of the location described by an address. Should return a value that expresses this quality between 0 and 100 (100 being the best quality)

Room*

String

The room of a building address.

Route*

String

Named route (such as US 401).

South Bound Latitude

String

Bounding box southern limit.

Status

String

Status of the request. OK indicates that no error occurred and the address was geocoded. ZERO_RESULTS indicates that no error occurred but the address was not geocoded. See the API documentation for a list of status and error codes

Street Address

String

Precise street address. NOTE: This output is deprecated.

Street Number*

String

Precise street number.

Sub-Locality*

String

First-order civil entity below a locality.

Sub-Premise*

String

First-order entity below a named location, usually a singular building within a collection of buildings with a common name.

West Bound Longitude

String

Bounding box western limit.

OpenStreetMap URL

Yes

String

Address Line

Yes

String

Postal Code

No

String

City

No

String

Country

No

String

Address

String

Complete address of the location.

City

String

City of the location.

Country

String

Country of the location.

Country Code

String

Country code of the location.

County

String

County of the location.

Latitude

String

Latitude of the location.

Longitude

String

Longitude of the location.

Postal Code

String

Postal code of the location.

Process Code

String

Code that indicates the result status of the address processing.

State

String

State of the Location.

Street Number

String

Street number of the location.

Street Name

String

Street name of the location.

Bing Maps Key

Yes

String

Bing Location URL

Yes

String

Address Line

Yes

String

Postal Code

No

String

City

No

String

Country

No

String

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.

HOST_NAME

Domain name. e.g. "gmail.com"

PREFIX

2 first letters of the domain name. e.g. "gm"

SUFFIX

2 last letters of the domain name. e.g. "om"

HIT_COUNT

Number of times this host name was processed by the enricher. This value is automatically incremented by the enricher.

SEED_DATA

Indicates whether this record was part of the seeded data, of created by the enricher. The value is 1for seeded data, 0 otherwise.

VALID

Indicates whether the domain name is valid 1 or invalid 0. The value is N/A if the validity is unknown (for example, when a new domain is added in the cache in offline mode).

SUGGESTION

Latest correction found for an invalid domain.

FIRST_INVALID_DATE
LAST_INVALID_DATE
LAST_VALID_DATE

Additional date information used to reconsider a domain validity after a certain period of time.