Cisco Unified Communications Manager Features and Services Guide, Release 8.5(1)
Geolocations and Location Conveyance
Downloads: This chapterpdf (PDF - 258.0KB) The complete bookPDF (PDF - 11.79MB) | Feedback

Geolocations and Location Conveyance

Table Of Contents

Geolocations and Location Conveyance

Configuration Checklist for Geolocations

Configuration Checklist for Geolocation Filters

Configuration Checklist for Location Conveyance

Introducing Geolocations

Overview of Geolocations

Geolocation Characteristics

Geolocation Usage for Shared Lines and Route Lists

Geolocation Examples

Geolocation Identifiers

Geolocation Interactions

Geolocation Configuration

Finding a Geolocation

Configuring a Geolocation

Deleting a Geolocation

Geolocation Configuration Settings

Introducing Geolocation Filters

Geolocation Filter Configuration

Finding a Geolocation Filter

Configuring a Geolocation Filter

Deleting a Geolocation Filter

Geolocation Filter Configuration Settings

Introducing Location Conveyance

Geolocation Conveyance Across SIP Trunks and Intercluster Trunks

SIP Trunk Error Handling for Geolocation Information

Intercluster Trunk Error Handling for Geolocation Information

Handling a Received Geolocation

Feature Interactions with Midcall Geolocation Change

Location Conveyance Configuration

Related Topics


Geolocations and Location Conveyance


This chapter discusses the following concepts:

Geolocations

Geolocation filters

Location conveyance


Tip Do not confuse locations with geolocations. Locations, which you configure by using the System > Location menu option, allow you to define entities that a centralized call-processing system uses to provide call admission control (CAC). Geolocations, which you configure by using the System > Geolocation Configuration menu option, allow you to specify geographic locations that you use to associate Cisco Unified Communications Manager devices for features such as logical partitioning.


This chapter contains information on the following topics:

Configuration Checklist for Geolocations

Configuration Checklist for Geolocation Filters

Configuration Checklist for Location Conveyance

Introducing Geolocations

Geolocation Interactions

Geolocation Configuration

Introducing Geolocation Filters

Geolocation Filter Configuration

Introducing Location Conveyance

Location Conveyance Configuration

Related Topics

Configuration Checklist for Geolocations

Geographical location information, or geolocation, describes a physical position in the world that may correspond to the past, present, or future location of a person, event, or device.

Cisco Unified Communications Manager Administration allows you to specify a geolocation for every device.

The Request for Comments (RFC) 4119 standard provides the basis for geolocations. Geolocations use the civic location format that specifies the following fields: country, A1, A2, A3, A4, A5, A6, PRD, POD, STS, HNO, HNS, LMK, LOC, FLR, NAM, and PC.

In Cisco Unified Communications Manager Administration, geolocations get configured manually.


Tip Do not confuse locations with geolocations. Locations, which you configure by using the System > Location menu option, allow you to define entities that a centralized call-processing system uses to provide call admission control (CAC). Geolocations, which you configure by using the System > Geolocation Configuration menu option, allow you to specify geographic locations that you use to associate Cisco Unified Communications Manager devices for features such as logical partitioning.


Table 24-1 provides a checklist for configuring geolocations. For more information on geolocations, see the "Introducing Geolocations" section and the "Related Topics" section.

Table 24-1 Geolocation Configuration Checklist 

Configuration Steps
Procedures and Related Topics

Step 1 

Define a set of geolocations on a new Geolocation Configuration window.

Geolocation Configuration

Step 2 

Assign geolocations to device pools, devices, trunks, gateways, or MGCP ports.

Device Pool Configuration Settings, Cisco Unified Communications Manager Administration Guide

Gateway Configuration Settings, Cisco Unified Communications Manager Administration Guide

Displaying the MAC Address of a Phone, Cisco Unified Communications Manager Administration Guide

Trunk Configuration Settings, Cisco Unified Communications Manager Administration Guide

Step 3 

Assign geolocations to the default geolocation that the Default Geolocation enterprise parameter specifies.

Geolocation Configuration

Enterprise Parameter Configuration, Cisco Unified Communications Manager Administration Guide

Enterprise Parameters for Logical Partitioning, page 32-10

Step 4 

For devices that do not participate in features that require geolocations, define the geolocation as Unspecified or leave undefined.

Note You can define this lack of association at the individual-device level, the device-pool level, or the enterprise-parameter level.

Device Pool Configuration Settings, Cisco Unified Communications Manager Administration Guide

Gateway Configuration Settings, Cisco Unified Communications Manager Administration Guide

Displaying the MAC Address of a Phone, Cisco Unified Communications Manager Administration Guide

Trunk Configuration Settings, Cisco Unified Communications Manager Administration Guide

Enterprise Parameter Configuration, Cisco Unified Communications Manager Administration Guide

Additional Information

See the "Related Topics" section.

Configuration Checklist for Geolocation Filters

Cisco Unified Communications Manager administrators define a geolocation filter for every device that participates in a feature that uses geolocation filters. Geolocation filters allow selection of specific fields from the 17 geolocation fields for the purpose of creating an identifier from the selected fields. Geolocation filters get configured manually.

Cisco Unified Communications Manager administrators then assign geolocation filters to devices.

Use the System > Geolocation Filter menu option in Cisco Unified Communications Manager Administration to configure geolocation filters.

Table 24-2 provides a checklist for configuring geolocation filters. For more information on geolocation filters, see the "Introducing Geolocation Filters" section and the "Related Topics" section.

Table 24-2 Geolocation Configuration Checklist 

Configuration Steps
Procedures and Related Topics

Step 1 

Define a set of filter rules in a new Geolocation Filter Configuration window.

Geolocation Filter Configuration

Step 2 

Assign geolocation filters to device pools, trunks, intercluster trunks, gateways, or MGCP ports.

Device Pool Configuration Settings, Cisco Unified Communications Manager Administration Guide

Gateway Configuration Settings, Cisco Unified Communications Manager Administration Guide

Trunk Configuration Settings, Cisco Unified Communications Manager Administration Guide

Step 3 

For the logical partitioning feature, assign geolocation filter to the default filter that the Logical Partitioning Default Filter enterprise parameter specifies.

Enterprise Parameter Configuration, Cisco Unified Communications Manager Administration Guide

Enterprise Parameters for Logical Partitioning, page 32-10

Additional Information

See the "Related Topics" section.

Configuration Checklist for Location Conveyance

Location conveyance involves configuration to make the following behavior possible:

Communicate geolocation information across clusters

Allow communication of geolocation information from one cluster to another, at call establishment as well as midcall joins and redirects.


Note Enterprise parameters and logical partitioning configuration do not control location conveyance. If a device that communicates through a trunk associates with geolocation information, check the Send Geolocation Information check box when you configure the trunk (either SIP or ICT) to convey the geolocation information across clusters.

For the logical partitioning feature in the current release, the Cisco Unified Communications Manager does not send the configured geolocation information to line devices (phones that are running SIP or SCCP).


Table 24-3 provides a checklist for configuring location conveyance in a multicluster logical partitioning environment.

Table 24-3 Location Conveyance Configuration Checklist 

Configuration Steps
Procedures and Related Topics

Step 1 

Define a set of geolocations in a new Geolocation Configuration window.

Geolocation Configuration

Step 2 

Assign geolocations to device pools, devices, SIP trunks, intercluster trunks, gateways, or MGCP ports for the devices that need to participate in location conveyance.

Device Pool Configuration Settings, Cisco Unified Communications Manager Administration Guide

Gateway Configuration Settings, Cisco Unified Communications Manager Administration Guide

Displaying the MAC Address of a Phone, Cisco Unified Communications Manager Administration Guide

Trunk Configuration Settings, Cisco Unified Communications Manager Administration Guide

Step 3 

Assign geolocations to a default geolocation that the Default Geolocation enterprise parameter specifies.

This assignment allows you to specify a default geolocation for a cluster.

For devices for which no associated geolocation exists at the device or device-pool level, the value that is specified by the Default Geolocation enterprise parameter applies.

Geolocation Configuration

Enterprise Parameter Configuration, Cisco Unified Communications Manager Administration Guide

Enterprise Parameters for Logical Partitioning, page 32-10

Step 4 

If geolocation information about devices needs to be communicated across clusters, ensure that location conveyance is configured.

To do so, check the Send Geolocation Information check box in the intercluster trunk (ICT) or SIP trunk for the devices that need to pass geolocation information across clusters as follows:

Check the Send Geolocation Information check box in the intercluster trunk (ICT) or SIP trunk of the local cluster.

Check the Send Geolocation Information check box in the ICT or SIP trunk of the remote cluster.

Trunk Configuration Settings, Cisco Unified Communications Manager Administration Guide

Additional Information

See the "Related Topics" section.

Introducing Geolocations

Geographical location information, or geolocation, describes a physical position in the world that may correspond to the past, present, or future location of a person, event, or device.

Cisco Unified Communications Manager Administration allows you to specify a geolocation for every device.

The Request for Comments (RFC) 4119 standard provides the basis for geolocations. Geolocations use the civic location format that specifies the following fields: country, A1, A2, A3, A4, A5, A6, PRD, POD, STS, HNO, HNS, LMK, LOC, FLR, NAM, and PC.

In Cisco Unified Communications Manager Administration, geolocations get configured manually.


Tip Do not confuse locations with geolocations. Locations, which you configure by using the System > Location menu option, allow you to define entities that a centralized call-processing system uses to provide call admission control (CAC). Geolocations, which you configure by using the System > Geolocation Configuration menu option, allow you to specify geographic locations that you use to associate Cisco Unified Communications Manager devices for features such as logical partitioning.


Additional Information

See the "Related Topics" section.

Overview of Geolocations

Configuration of geolocations entails provisioning the following elements:

Configure geolocation identifiers

You can define sets of geolocations (civic addresses).

You can assign these geolocations to VoIP phones, VoIP gateways, IP trunks, device pools, and enterprise parameters.

You can define geolocation filters that select a subset of fields from geolocation and associate with VoIP gateways, IP trunks, device pools, and enterprise parameters.

Additional Information

See the "Related Topics" section.

Geolocation Characteristics

Cisco Unified Communications Manager administrators must define the following item:

A geolocation for every device that participates in any feature that requires geolocations. The Request for Comments (RFC) 4119 standard provides the basis for geolocations. Geolocations use the civic location format that specifies the following fields: country, A1, A2, A3, A4, A5, A6, PRD, POD, STS, HNO, HNS, LMK, LOC, FLR, NAM, and PC. Geolocations get configured manually.

Cisco Unified Communications Manager administrators then assign geolocations to devices.

The following entities in a Cisco Unified Communications Manager cluster can have geolocation and geolocation filter values that are assigned:

Device pools

CTI route points

Phones (optional)

CTI ports


Note Phones do not specify a drop-down list box for associating a phone with a geolocation filter.


SIP trunks

Intercluster trunks (ICT)

H.323 gateways

MGCP ports of the following types: T1, E1, PRI, FXO

You do not need to associate media devices, such as media termination points (MTP), conference bridges (CFB), annunciators, and music on hold (MOH) servers, with geolocations.

Internally, the device layer of Cisco Unified Communications Manager associates with geolocation values that call processing uses. The following sequence takes place:

1. Devices read the GeolocationPkid and GeolocationFilterPkid for its configuration at device or device pool level.

2. The devices communicate this Pkid and deviceType information in CC (for example, CcRegisterPartyA) and PolicyAndRSVPRegisterReq messages during call signaling.

3. The intercluster trunk (ICT) or SIP trunk device layer that receives this information uses the information for location conveyance.

4. No communication of geolocation from Cisco Unified Communications Manager to a phone takes place.

Source of Geolocation Information

The following logic determines the geolocation value:

1. Read the value for geolocation from the device window. If it is not configured on device page, for phone device in roaming, read the device pool (DP) from the roaming configuration. For phone device that is not in roaming, read the DP from the device configuration.

2. For trunk, ICT, or MGCP port device, read the DP from the device configuration.

3. From the selected DP, read the value of geolocation from DP configuration window.

4. If DP is not configured with a value for Geolocation, use blank value.

5. If available geolocation value is blank, call processing uses the configured value that the Default Geolocation enterprise parameter specifies.

The standard record for a geolocation specifies Unspecified. Use this value when no geolocation needs to associate with a device. In such scenarios, any features that are based on geolocations do not execute. Also, devices for which no geolocation gets specified do not participate in geolocation information conveyance across clusters for intercluster calls.

Be aware that the Default Geolocation enterprise parameter can be configured from drop-down list boxes on the Enterprise Parameters Configuration window.

Additional Information

See the "Related Topics" section.

Geolocation Usage for Shared Lines and Route Lists

When the called party specifies a group device, a different geolocation can apply for each device in a group. For the early attended scenarios, you do not know the actual connected device until the device gets answered. Thus, the Geolocation information gets aggregated until the device answers.

The Call Control and Feature layer receives temporary geolocation information ("MixedDevice") until the device answers.

When a device answers, the actual geolocation information for the device becomes available and gets communicated to call control and to any features that are involved.

Geolocation Examples

Table 24-4 specifies examples of geolocations.

Table 24-4 Geolocation Examples 

Geolocation Name
Geolocation Data

IN-KA-BLR-BLD1

(country=IN, A1=KA, A3=Bangalore, A4= A4, A5=12, A6=Langford Road, PRD=12, LOC=BLD1, NAM=unified comm, PC=560001)

IN-KA-BLR-BLD2

(country=IN, A1=KA, A3=Bangalore, A4= A4, A6=Outer Ring Road, LOC=BLD2, NAM=unified comm, PC=560002)

IN-MH-MUM-BLD1

(country=IN, A1=MH, A3=Mumbai, A4= A4, LOC=bld1, NAM=unified comm, PC=220001)

IN-KA-BLR-ICTtoSJ

(country=IN, A1=KA, A3=Bangalore, NAM=ICTToSJ)


Additional Information

See the "Related Topics" section.

Geolocation Identifiers

Geolocation identifiers get constructed from a combination of geolocations, geolocation filters, and device types of Cisco Unified Communications Manager devices.

See the following sections for detailed descriptions of geolocations and geolocation filters:

"Introducing Geolocations" section

"Introducing Geolocation Filters" section

Geolocation filters allow selection of specific fields from the 17 geolocation fields. Use the System > Geolocation Filter menu option in Cisco Unified Communications Manager Administration to configure geolocation filters manually. Specific Cisco Unified Communications Manager features associate the geolocation filters by using drop-down list boxes in the configuration windows of the devices that get configured for a particular feature.

The Cisco Unified Communications Manager device type of a device specifies one of the following values:

Border—Use this value to specify accessing PSTN trunks, intercluster trunks (ICTs), gateways, and MGCP ports.

Interior—Use this value for VoIP phones or internal endpoints.

See Table 32-2 in the "Logical Partitioning" chapter for a detailed listing of the Cisco Unified Communications Manager devices that associate with the Border and Interior device types.

The following object specifies an example geolocation identifier:

{geolocPkid=9dc76052-3a37-78c2-639a-1c02e8f5d3a2, filterPkid=d5bdda76-6a86-56c5-b5fd-6dff82b37493, geolocVal=, devType=8}

where:

The geolocVal field gets used in cases where the Cisco Unified Communications Manager database does not reference the geolocation record but data for a geolocation comes from another source (for example, location conveyance PIDF-LO XML from a remote cluster).

In such cases, Cisco Unified Communications Manager constructs the name value pair for the geolocation fields.

Example: "country=US:A1=Texas:A3=Richardson:LOC=Building 6" where the value gets communicated through the geolocVal field.


Note In such a case, the geolocPkid is kept null and call control or features access the geolocVal field from a geolocation identifier.


The following string specifies the logical representation of a geolocation identifier:

"Border:country=US:A1=Texas:A3=Richardson:LOC=Building 6"


Note This geolocation identifier gets constructed from the member fields of a geolocation identifier.


Additional Information

See the "Related Topics" section.

Geolocation Interactions

The following interaction applies to geolocations:

Location conveyance

See the "Introducing Location Conveyance" section for a detailed discussion of location conveyance.

Additional Information

See the "Related Topics" section.

Geolocation Configuration


Tip Before you configure geolocations, review the "Configuration Checklist for Geolocations" section and the "Configuration Checklist for Geolocation Filters" section.


Use the System > Geolocation Configuration menu option in Cisco Unified Communications Manager Administration to configure geolocations.


Tip Do not confuse locations with geolocations. Locations, which you configure by using the System > Location menu option, allow you to define entities that a centralized call-processing system uses to provide call admission control (CAC). Geolocations, which you configure by using the System > Geolocation Configuration menu option, allow you to specify geographic locations that you use to associate Cisco Unified Communications Manager devices for features such as logical partitioning.


To configure geolocations, see the following sections:

Finding a Geolocation

Configuring a Geolocation

Deleting a Geolocation

Geolocation Configuration Settings

Additional Information

See the "Related Topics" section.

Finding a Geolocation

Because you might have multiple geolocations in your network, Cisco Unified Communications Manager lets you search for geolocations on the basis of specified criteria. Follow these steps to search for a specific geolocations in the Cisco Unified Communications Manager database.


Note During your work in a browser session, Cisco Unified Communications Manager Administration retains your geolocation search preferences. If you navigate to other menu items and return to this menu item, Cisco Unified Communications Manager Administration retains your geolocation search preferences until you modify your search or close the browser.


Procedure


Step 1 Choose System > Geolocation Configuration.

The Find and List Geolocations window displays. Records from an active (prior) query may also display in the window.

Step 2 To find all records in the database, ensure the dialog box is empty; go to Step 3.

To filter or search records

From the first drop-down list box, choose a search parameter.

From the second drop-down list box, choose a search pattern.

Specify the appropriate search text, if applicable.


Note To add additional search criteria, click the + button. When you add criteria, the system searches for a record that matches all criteria that you specify. To remove criteria, click the - button to remove the last added criterion or click the Clear Filter button to remove all added search criteria.


Step 3 Click Find.

All matching records display. You can change the number of items that display by choosing a different value from the Rows per Page drop-down list box.


Note You can delete multiple records from the database by checking the check boxes next to the appropriate record and clicking Delete Selected. You can delete all configurable records for this selection by clicking Select All and then clicking Delete Selected.


Step 4 From the list of records that display, click the link for the record that you want to view.


Note To reverse the sort order, click the up or down arrow, if available, in the list header.


The window displays the item that you choose.


Additional Information

See the "Related Topics" section.

Configuring a Geolocation

Perform the following procedure to add or update a geolocation.

Procedure


Step 1 Choose System > Geolocation Configuration.

The Find and List Geolocations window displays.

Step 2 Perform one of the following tasks:

To add a new geolocation, click Add New.

The Geolocation Configuration window displays.

To update a geolocation, locate a specific geolocation as described in the "Finding a Geolocation" section.

Step 3 Enter the appropriate settings as described in Table 24-5.

Step 4 Click Save.

If you added a geolocation, the list box at the bottom of the window now includes the new geolocation.


Additional Information

See the "Related Topics" section.

Deleting a Geolocation

Perform the following procedure to delete an existing geolocation.

Procedure


Step 1 Choose System > Geolocation Configuration.

The Find and List Geolocations window displays.

Step 2 To locate a specific geolocation, enter search criteria and click Find.

A list of geolocations that match the search criteria displays.

Step 3 Perform one of the following actions:

Check the check boxes next to the geolocations that you want to delete and click Delete Selected.

Delete all geolocations in the window by clicking Select All and then clicking Delete Selected.

From the list, choose the name of the geolocation that you want to delete and click Delete.

A confirmation dialog displays.

Step 4 Click OK.

The specified geolocation gets deleted.


Additional Information

See the "Related Topics" section.

Geolocation Configuration Settings

Geographical location information, or geolocation, describes a physical position in the world that may correspond to the past, present, or future location of a person, event, or device.

Cisco Unified Communications Manager Administration allows you to specify a geolocation for every device.

In Cisco Unified Communications Manager Administration, geolocations get configured manually.


Tip Do not confuse locations with geolocations. Locations, which you configure by using the System > Location menu option, allow you to define entities that a centralized call-processing system uses to provide call admission control (CAC). Geolocations, which you configure by using the System > Geolocation Configuration menu option, allow you to specify geographic locations that you use to associate Cisco Unified Communications Manager devices for features such as logical partitioning.


Table 24-5 describes the configuration settings that are used for configuring geolocations.

Table 24-5 Geolocation Configuration Settings 

Field
Description
Geolocation Configuration

Name

Enter a unique name for this geolocation.

The name can contain up to 50 ASCII characters. You can use all characters except quotes ("), close angle bracket (>), open angle bracket (<), backslash (\), ampersand (&), and percent sign (%).

Description

Enter a description for this geolocation.

This field can contain up to 50 ASCII or unicode characters.

Default value specifies blank.

Country using the two-letter abbreviation

Enter the two-letter country abbreviation for the country where this geolocation is located. Use the ISO 3166 code.

The country must comprise two ASCII characters.

Default value specifies blank.

Examples:

US for United States, IN for India

State, Region, or Province (A1)

Enter a national subdivision for this geolocation, such as a state, region, province, or prefecture.

This field can contain up to 50 ASCII or unicode characters.

Default value specifies blank.

Examples:

Texas, Karnataka, Maharashtra

County or Parish (A2)

Enter a county, parish, gun (JP), or district (IN) for this geolocation.

This field can contain up to 50 ASCII or unicode characters.

Default value specifies blank.

Examples:

Tarrant, Harris, Plaquemines

City or Township (A3)

Enter a city, township, or shi (JP) for this geolocation.

This field can contain up to 50 ASCII or unicode characters.

Default value specifies blank.

Examples:

Bangalore, New Delhi, Mumbai, Dallas, Tokyo, Sydney

Borough or City District (A4)

Enter a city division, borough, city district, ward, or chou (JP) for this geolocation.

This field can contain up to 50 ASCII or unicode characters.

Default value specifies blank.

Examples:

Manhattan, Brooklyn, Westminster, Hollywood

Neighborhood (A5)

Enter a neighborhood or block for this geolocation.

This field can contain up to 50 ASCII or unicode characters.

Default value specifies blank.

Examples:

Midtown, Soho, Southbank

Street (A6)

Enter a street for this geolocation.

This field can contain up to 50 ASCII or unicode characters.

Default value specifies blank.

Examples:

Main, Commerce, Champs-Elysees, Broadway

Leading Street Direction, such as N or W (PRD)

Enter a leading street direction for this geolocation.

This field can contain up to 10 ASCII or unicode characters.

Default value specifies blank.

Examples:

N, S, E, W (as in 43 N Wabash Avenue)

Trailing Street Suffix, such as SW (POD)

Enter a trailing street suffix for this geolocation.

This field can contain up to 10 ASCII or unicode characters.

Default value specifies blank.

Examples:

SW, NE, NW, SE (as in 245 E 45th St NW)

Address Suffix, such as Avenue, Platz (STS)

Enter an address suffix for this geolocation.

This field can contain up to 50 ASCII or unicode characters.

Default value specifies blank.

Examples:

Avenue, Boulevard, Platz, rue

Numeric house number (HNO)

Enter a numeric house number for this geolocation.

This field can contain up to 10 numeric characters.

Default value specifies blank.

Examples:

2666, 14, 12345

House Number Suffix, such as A, 1/2 (HNS)

Enter a house number suffix for this geolocation.

This field can contain up to 20 ASCII or unicode characters.

Default value specifies blank.

Examples:

A, 1/2, bis

Landmark (LMK)

Enter a landmark or vanity address for this geolocation.

This field can contain up to 50 ASCII or unicode characters.

Default value specifies blank.

Examples:

Central Library

Additional Location Information, such as Room Number (LOC)

Enter additional location information, such as a room number, for this geolocation.

This field can contain up to 50 ASCII or unicode characters.

Default value specifies blank.

Examples:

Room 222, Suite 555

Floor (FLR)

Enter a floor for this geolocation.

This field can contain up to 10 ASCII characters.

Default value specifies blank.

Examples:

23, 2nd

Name of Business or Resident (NAM)

Enter a business name or resident name or office occupant for this geolocation.

This field can contain up to 50 ASCII or unicode characters.

Default value specifies blank.

Examples:

Cisco Systems, Joe's Barbershop

Zip or Postal Code (PC)

Enter a zip code or postal code for this geolocation.

This field can contain up to 20 ASCII or unicode characters.

Default value specifies blank.

Examples:

75042-0401, SW1V 1RP


Additional Information

See the "Related Topics" section.

Introducing Geolocation Filters

Cisco Unified Communications Manager administrators define the following item:

A geolocation filter for every device that participates in a feature that uses geolocation filters. Filters allow selection of specific fields from the 17 geolocation fields for the purpose of creating an identifier from the selected fields. Geolocation filters get configured manually.

Cisco Unified Communications Manager administrators then assign geolocation filters to devices.

The following logic determines the geolocation filter value:

1. For phone device that is in roaming, read the geolocation filter value from DP in roaming configuration. For phone device that is not in roaming, read the geolocation filter value from DP in device configuration.

2. For trunk, intercluster trunk, or MGCP port device, read geolocation filter value from device window. If no value is configured, read from DP.

3. If DP is not configured with a geolocation filter value, use blank value.

4. If available filter is blank, call processing uses the value that the Default Geolocation Filter enterprise parameter specifies.

Geolocation Filter Examples

Table 24-6 specifies examples of geolocation filters.

Table 24-6 Geolocation Filter Examples 

Geolocation Name
Geolocation Filter Data

India-Filter1

(UseCountry, UseA1, UseA3, UseLOC)

India-GW-Filter2

(UseCountry, UseA1, UseA3, UseLOC, UseNAM)

India-ICT-Trunk-Filter3

(UseCountry, UseA1, UseA3, UseNAM)


Additional Information

See the "Related Topics" section.

Geolocation Filter Configuration


Tip Before you configure geolocations filters, review the "Configuration Checklist for Geolocation Filters" section.


Use the System > Geolocation Filter menu option in Cisco Unified Communications Manager Administration to configure geolocation filters.

To configure geolocation filters, see the following sections:

Finding a Geolocation Filter

Configuring a Geolocation Filter

Deleting a Geolocation Filter

Geolocation Filter Configuration Settings

Additional Information

See the "Related Topics" section.

Finding a Geolocation Filter

Because you might have multiple geolocation filters in your network, Cisco Unified Communications Manager lets you search for geolocation filters on the basis of specified criteria. Follow these steps to search for a specific geolocation filters in the Cisco Unified Communications Manager database.


Note During your work in a browser session, Cisco Unified Communications Manager Administration retains your geolocation filter search preferences. If you navigate to other menu items and return to this menu item, Cisco Unified Communications Manager Administration retains your geolocation filter search preferences until you modify your search or close the browser.


Procedure


Step 1 Choose System > Geolocation Filter.

The Find and List Geolocation Filters window displays. Records from an active (prior) query may also display in the window.

Step 2 To find all records in the database, ensure the dialog box is empty; go to Step 3.

To filter or search records

From the first drop-down list box, choose a search parameter.

From the second drop-down list box, choose a search pattern.

Specify the appropriate search text, if applicable.


Note To add additional search criteria, click the + button. When you add criteria, the system searches for a record that matches all criteria that you specify. To remove criteria, click the - button to remove the last added criterion or click the Clear Filter button to remove all added search criteria.


Step 3 Click Find.

All matching records display. You can change the number of items that display by choosing a different value from the Rows per Page drop-down list box.


Note You can delete multiple records from the database by checking the check boxes next to the appropriate record and clicking Delete Selected. You can delete all configurable records for this selection by clicking Select All and then clicking Delete Selected.


Step 4 From the list of records that display, click the link for the record that you want to view.


Note To reverse the sort order, click the up or down arrow, if available, in the list header.


The window displays the item that you choose.


Additional Information

See the "Related Topics" section.

Configuring a Geolocation Filter

Perform the following procedure to add or update a geolocation filter.

Procedure


Step 1 Choose System > Geolocation Filter.

The Find and List Geolocation Filters window displays.

Step 2 Perform one of the following tasks:

To add a new geolocation filter, click Add New.

The Geolocation Filter Configuration window displays.

To update a geolocation filter, locate a specific geolocation filter as described in the "Finding a Geolocation Filter" section.

Step 3 Enter the appropriate settings as described in Table 24-7.

Step 4 Click Save.

If you added a geolocation filter, the list box at the bottom of the window now includes the new geolocation filter.


Additional Information

See the "Related Topics" section.

Deleting a Geolocation Filter

Perform the following procedure to delete an existing geolocation filter.

Procedure


Step 1 Choose System > Geolocation Filter.

The Find and List Geolocation Filters window displays.

Step 2 To locate a specific geolocation filter, enter search criteria and click Find.

A list of geolocation filters that match the search criteria displays.

Step 3 perform one of the following actions:

Check the check boxes next to the geolocation filters that you want to delete and click Delete Selected.

Delete all geolocation filters in the window by clicking Select All and then clicking Delete Selected.

From the list, choose the name of the geolocation filter that you want to delete and click Delete.

A confirmation dialog displays.

Step 4 Click OK.

The specified geolocation filter gets deleted.


Additional Information

See the "Related Topics" section.

Geolocation Filter Configuration Settings

Cisco Unified Communications Manager administrators define the following item:

A geolocation filter for every device that participates in a feature that uses geolocation filters. Filters allow selection of specific fields from the 17 geolocation fields for the purpose of creating an identifier from the selected fields. Geolocation filters get configured manually.

Cisco Unified Communications Manager administrators then assign geolocation filters to devices.

Table 24-7 describes the configuration settings that are used for configuring geolocation filters.

Table 24-7 Geolocation Filter Configuration Settings 

Field
Description
Geolocation Filter Configuration

Name

Enter a unique name for this geolocation filter. Default name cannot be blank.

This field can contain up to 50 ASCII characters. You can use all characters except quotes ("), close angle bracket (>), open angle bracket (<), backslash (\), ampersand (&), and percent sign (%).

Description

Enter a description for this geolocation filter.

This field can contain up to 50 ASCII or unicode characters.

Default value specifies blank.

Country using the two-letter abbreviation

Check this box to use the Country field of a specified geolocation to create this geolocation filter.

State, Region, or Province (A1)

Check this box to use the State, Region, or Province (A1) field of a specified geolocation to create this geolocation filter.

County or Parish (A2)

Check this box to use the County or Parish (A2) field of a specified geolocation to create this geolocation filter.

City or Township (A3)

Check this box to use the City or Township (A3) field of a specified geolocation to create this geolocation filter.

Borough or City District (A4)

Check this box to use the Borough or City District (A4) field of a specified geolocation to create this geolocation filter.

Neighborhood (A5)

Check this box to use the Neighborhood (A5) field of a specified geolocation to create this geolocation filter.

Street (A6)

Check this box to use the Street (A6) field of a specified geolocation to create this geolocation filter.

Leading Street Direction, such as N or W (PRD)

Check this box to use the Leading Street Direction, such as N or W (PRD) field of a specified geolocation to create this geolocation filter.

Trailing Street Suffix, such as SW (POD)

Check this box to use the Trailing Street Suffix, such as SW (POD) field of a specified geolocation to create this geolocation filter.

Address Suffix, such as Avenue, Platz (STS)

Check this box to use the Address Suffix, such as Avenue, Platz (STS) field of a specified geolocation to create this geolocation filter.

Numeric house number (HNO)

Check this box to use the Numeric house number (HNO) field of a specified geolocation to create this geolocation filter.

House Number Suffix, such as A, 1/2 (HNS)

Check this box to use the House Number Suffix, such as A, 1/2 (HNS) field of a specified geolocation to create this geolocation filter.

Landmark (LMK)

Check this box to use the Landmark (LMK) field of a specified geolocation to create this geolocation filter.

Additional Location Information, such as Room Number (LOC)

Check this box to use the Additional Location Information, such as Room Number (LOC) field of a specified geolocation to create this geolocation filter.

Floor (FLR)

Check this box to use the Floor (FLR) field of a specified geolocation to create this geolocation filter.

Name of Business or Resident (NAM)

Check this box to use the Name of Business or Resident (NAM) field of a specified geolocation to create this geolocation filter.

Zip or Postal Code (PC)

Check this box to use the Zip or Postal Code (PC) field of a specified geolocation to create this geolocation filter.


Additional Information

See the "Related Topics" section.

Introducing Location Conveyance

Location conveyance involves configuration to make the following behavior possible:

Communicate geolocation information across clusters

Allow communication of geolocation information from one cluster to another, at call establishment as well as midcall joins and redirects.


Note Enterprise parameters and logical partitioning configuration do not control location conveyance. If a device that communicates through a trunk associates with geolocation information, check the Send Geolocation Information check box when you configure the trunk (either SIP or ICT) to convey the geolocation information across clusters.

For the logical partitioning feature in the current release, the Cisco Unified Communications Manager does not send the configured geolocation information to line devices (phones that are running SIP or SCCP).


This section covers the following topics:

Geolocation Conveyance Across SIP Trunks and Intercluster Trunks

SIP Trunk Error Handling for Geolocation Information

Intercluster Trunk Error Handling for Geolocation Information

Handling a Received Geolocation

Feature Interactions with Midcall Geolocation Change

Additional Information

See the "Related Topics" section.

Geolocation Conveyance Across SIP Trunks and Intercluster Trunks

Geolocation conveyance entails the following characteristics:

Geolocation gets sent from one cluster to another.

Geolocation information gets sent both at call establishment and at midcall joins and redirects.

The SIP trunk supports the location conveyance of Presence Information Data Format Location Object (PIDF-LO) as RFC 4119 describes, which specifies an encapsulation of location information within a presence document:

Location conveyance supports the subset of SIP extension as specified in Location Conveyance draft-ietf-sip-location-conveyance-10.

For communicating indication of device type, use User Agent Capability Presence Status, as specified in SIP extension draft-ietf-simple-prescaps-ext-08.

Location conveyance supports the PIDF-LO in the <device> element as specified in SIP extension draft-ietf-geopriv-pdif-lo-profile-11.

INVITE and UPDATE requests carry the PIDF-LO XML.

Geolocation fields support ASCII and unicode characters.

Intercluster trunk also supports location conveyance that is using PIDF-LO XML with reduction in some of the XML elements:

Elements include Setup, Alert, Progress, Connect, and Notify requests.

Geolocation fields support ASCII characters.

The SIP trunk or intercluster trunk uses the geolocation information and device type that the call control messages send to construct the PIDF-LO XML.

Additional Information

See the "Related Topics" section.

SIP Trunk Error Handling for Geolocation Information

Incoming requests that carry geolocation information for location conveyance get checked for compliance as follows:

1. Geolocation headers indicate inclusion of PIDF-LO, but message body does not carry PIDF-LO.

2. Geolocation header has a CID header that refers to a URI for which no corresponding Content-ID header with the same URI exists.

3. Geolocation header has a URI other than CID header (for example, SIP or SIPS URI for LbyR).

The SIP trunk that receives a noncompliant SIP request responds with a "424 Bad Location Information" response.

The following cases result in ignoring the processing of geolocation info. For information purposes, the SIP trunk sends a Geolocation-Error header in the next outgoing SIP response (for example, 180 or 200).

PIDF-LO lacks mandatory elements, such as "geopriv," "location-info," "civicAddress," or "usage-rules."

If usage-rules show a retention-expiry time that already elapsed when it is compared to the current time in GMT, processing gets ignored.

Because the received geolocation information gets ignored, the SIP trunk continues to use the locally configured geolocation information on the SIP trunk.

Additional Information

See the "Related Topics" section.

Intercluster Trunk Error Handling for Geolocation Information

If an error occurs while the received geolocation information on an intercluster trunk is being processed, locally configured geolocation information for the trunk gets used.

Additional Information

See the "Related Topics" section.

Handling a Received Geolocation

The cluster that receives the PIDF-LO XML parses the received geolocation information and passes the information as colon-separated name value pairs in the GeolocationInfo data structure of the CcNotifyInd signal.

Example: "Country=US:A1=NC:A3=RTP:LOC=BLD9"

The content of the received geolocation information of the PIDF-LO overrides any locally configured geolocation information on a trunk, which gets used for the device across the trunk.

Example: {geolocPkid=, filterPkid=d5bdda76-6a86-56c5-b5fd-6dff82b37493, geolocVal="Country=US:A1=NC:A3=RTP:LOC=BLD9", devType=4}

Additional Information

See the "Related Topics" section.

Feature Interactions with Midcall Geolocation Change

Outgoing Geolocation Change

The supplementary service (SS) feature interactions, such as Transfer, Conference, Park retrieval, and others, result in connected party change.

For such scenarios, if the SIP trunk or intercluster trunk device receives valid geolocation information from Call Control that differs from previously sent geolocation information, updated geolocation information gets communicated in an UPDATE (SIP trunk) or Notify (intercluster trunk) message.

Incoming Geolocation Change

For SS feature interactions in a remote cluster, the updated geolocation information gets received over an SIP trunk or intercluster trunk in an UPDATE or Notify message.

When such an update is received, the SIP trunk or intercluster trunk parses the PIDF-LO and passes the PIDF-LO to call control and to the LPSession process.

Example PIDF-LO

The following example shows a PIDF-LO that is sent across a SIP trunk. Be aware that the items that are shown in bold font are relevant for location conveyance.

UPDATE sip:4400@10.10.10.2:5060;transport=tcp SIP/2.0
Date: Sat, 12 Jul 2008 13:28:42 GMT
Call-Info: <urn:x-cisco-remotecc:callinfo>; security= NotAuthenticated
Geolocation: <cid:4900@10.10.10.1>;inserted-by="10.10.10.1"
Content-ID: 4900@10.10.10.1
From: <sip:4900@10.10.10.1>;tag=4d1edcb1-f546-4ee7-966c-2973fbc56475-31638661
P-Asserted-Identity: <sip:4900@10.10.10.1>
Content-Length: 1070
User-Agent: Cisco-CUCM7.1
To: <sip:4400@10.10.10.2>;tag=e1258ce2-8620-4005-9aa1-72d99cd54050-31642615
Contact: <sip:4900@10.10.10.1:5060;transport=tcp>
Content-Type: application/pidf+xml
Call-ID: bbb3f900-8781b563-b-47f54c0a@10.10.10.2
Via: SIP/2.0/TCP 10.10.10.1:5060;branch=z9hG4bK179f431e3
CSeq: 101 UPDATE
Max-Forwards: 70
<?xml version="1.0" encoding="UTF-8"?>
<presence xmlns="urn:ietf:params:xml:ns:pidf"
xmlns:gp="urn:ietf:params:xml:ns:pidf:geopriv10"
xmlns:cl=" urn:ietf:params:xml:ns:pidf:geopriv10:civicLoc"
xmlns:dm="urn:ietf:params:xml:ns:pidf:data-model"
xmlns:caps="urn:ietf:params:xml:ns:pidf:caps"
xmlns:cisco="http://www.cisco.com"
entity="pres:geotarget@example.com">
<dm:device id="sg89ae">
<caps:devcaps>
<cisco:gateway>false</cisco:gateway>
</caps:devcaps>
<gp:geopriv>
<gp:location-info>
<cl:civicAddress>
<cl:country>IN</cl:country>
<cl:A1>KA</cl:A1>
<cl:A2>a2</cl:A2>
<cl:A3>BLR</cl:A3>
<cl:A4>a4</cl:A4>
<cl:A5>a5</cl:A5>
<cl:A6>a6</cl:A6>
<cl:PRD>prd</cl:PRD>
<cl:POD>pod</cl:POD>
<cl:STS>sts</cl:STS>
<cl:HNO>123</cl:HNO>
<cl:HNS>hns</cl:HNS>
<cl:LMK>lmk</cl:LMK>
<cl:LOC>BLDG1</cl:LOC>
<cl:FLR>flr</cl:FLR>
<cl:NAM>nam</cl:NAM>
<cl:PC>pc</cl:PC>
</cl:civicAddress>
</gp:location-info>
<gp:usage-rules>
<gp:retransmission-allowed>yes</gp:retransmission-allowed>
<gp:retention-expiry>2008-09-03T17:58:19Z</gp:retention-expiry>
</gp:usage-rules>
</gp:geopriv>
<timestamp>2008-09-02T17:58:19Z</timestamp>
</dm:device>
</presence>

Additional Information

See the "Related Topics" section.

Location Conveyance Configuration

If geolocation information about devices needs to be communicated across clusters, ensure that location conveyance is configured. To configure location conveyance, follow the steps that Table 24-3 provides.

To associate devices with geolocations, see the "Configuration Checklist for Geolocations" section.


Tip Before you configure location conveyance, review the "Configuration Checklist for Location Conveyance" section.


Additional Information

See the "Related Topics" section.

Related Topics

Configuration Checklist for Geolocations

Configuration Checklist for Geolocation Filters

Configuration Checklist for Location Conveyance

Introducing Geolocations

Overview of Geolocations

Geolocation Characteristics

Geolocation Usage for Shared Lines and Route Lists

Geolocation Identifiers

Geolocation Interactions

Geolocation Configuration

Geolocation Configuration Settings

Introducing Geolocation Filters

Geolocation Filter Configuration

Geolocation Filter Configuration Settings

Introducing Location Conveyance

Geolocation Conveyance Across SIP Trunks and Intercluster Trunks

SIP Trunk Error Handling for Geolocation Information

Intercluster Trunk Error Handling for Geolocation Information

Handling a Received Geolocation

Feature Interactions with Midcall Geolocation Change

Location Conveyance Configuration

Device Pool Configuration, Cisco Unified Communications Manager Administration Guide

Enterprise Parameter Configuration, Cisco Unified Communications Manager Administration Guide

CTI Route Point Configuration, Cisco Unified Communications Manager Administration Guide

Gateway Configuration, Cisco Unified Communications Manager Administration Guide

Cisco Unified IP Phone Configuration, Cisco Unified Communications Manager Administration Guide

Trunk Configuration, Cisco Unified Communications Manager Administration Guide

Additional Cisco Documentation

Cisco Unified Communications Manager Administration Guide

Cisco Unified Communications Manager System Guide

Cisco Unified Serviceability Administration Guide

Cisco Unified Communications Manager Call Detail Records Administration Guide

Cisco Unified Real-Time Monitoring Tool Administration Guide

Cisco Unified Reporting Administration Guide

Cisco Unified Communications Manager Bulk Administration Guide

Cisco Unified Communications Solution Reference Network Design (SRND) for Cisco Unified Communications Manager

Cisco Unified Communications Manager Security Guide

Cisco Unified Communications Manager Assistant User Guide