# Multilingual Name Display Using External LDAP

## Overview

The Multilingual Name Display Using External LDAP functionality (extension of the Multilingual Name Display feature) uses an external LDAP server to display names for external numbers, speed calls, groups, and other numbers that do not exist in the User and Services Configuration form. That is, when a user dials or receives a number that is not stored in the User and Services Configuration form, the MiVoice Business system queries the number in the external LDAP server. If the number is stored as a contact in the external LDAP server, the external LDAP server returns a name to the MiVoice Business system that is displayed on the 69xx series IP phone.

The MiVoice Business system supports the following external LDAP server directories:

- OpenLDAP

- Active Directory

- Mitel Meta Directory

When you configure a valid external LDAP server, the MiVoice Business system uses the following precedence for the name display based on the search results:

1. User and Services Configuration form

2. External LDAP server

3. Telephone Directory form

If a name is not returned from these sources, then the MiVoice Business system displays the name it receives from the Public Switched Telephone Network (PSTN).

## Connecting to the external LDAP server

The MiVoice Business system connects to an external LDAP server when the external LDAP server is configured or during the start-up of the MiVoice Business system. Once connected, the MiVoice Business system maintains the connection by querying the external LDAP server every 10 minutes. If the connection is lost, the MiVoice Business system requests for the connection during the next search or idle timeout.

## Searching the external LDAP server

You can provide the search criteria for name lookup in the external LDAP server through the following fields of the LDAP Client Configuration form:

- Number Search Filter

- Number Search Length

- LDAP Base DN

- Search Scope

If the Number Search Filter is telephoneNumber=%, then the system replaces % with the number and searches the external LDAP server for the number. Based on the number search length specified in the Number Search Length field, the system inserts * (reserved LDAP character for wildcard) to truncate the number to the specified length. For example, if the number search length is 10, then a search for:

- 96135922122 returns telephoneNumber=*6135922122

- 6135922122 returns telephoneNumber=*6135922122

- 5922122 returns telephoneNumber=5922122

- 14161234567 returns telephoneNumber=*4161234567

NOTE: If the Number Search Filter field includes *, then the system truncates and replaces % with the truncated number without adding an extra *.

### Timeout

- MiVoice Business Display Timeout - It is the duration for which the MiVoice Business system delays the name display to the sets for potential name display from the external LDAP server. The default value of this timeout is 50 milliseconds (ms). If no updates are received from the external LDAP server within the timeout period, the existing name received from the Telephone Directory form or the PSTN is displayed. If the updates are received after this timeout, the system caches the updates.

- Idle Timeout - It is the idle time duration of the Multilingual Name Display Using External LDAP functionality after which the MiVoice Business LDAP client performs a basic search to check the connection status of the external LDAP server. The default value of this timeout is 10 minutes. If the connection to the external LDAP server is disconnected, the connection is re-established after the next timeout period or during the next name display.

NOTE: If the idle timeout of the external LDAP server is configurable, then Mitel recommends an idle timeout duration greater than 10 minutes.

## Interpreting search results

The values specified in the following fields of the LDAP Client Configuration form determine the fields in the external LDAP server that the MiVoice Business LDAP client uses to look up the first and the last names for the name display:

- First Name

- Last Name

- Common Name Attribute (used if the first and the last names are not specified, or when no results are returned)

## Cache

- All search results are cached in the MiVoice Business system.

- The system stores a cache of 3000 entries, with an expiry time of seven days. As new entries are added to the cache, the system scans and deletes expired entries. If the cache is full and there are no expired entries, the system deletes the least used entries.

- The cache is not shared through SDS and is not retained over a system reboot.

- For more information on when the system cache is cleared, see External LDAP server for Multilingual Name Display in the LDAP Client Configuration form.

## Conditions and Feature Interactions

- The LDAP Client Configuration Profile ID #2 field in the System Options form must specify an external LDAP Server.

- The Client Status field in the LDAP Client Configuration form must be set to Enabled.

- Supports only an IP address for the LDAP server( FQDN is not supported). Ensure an IP address is configured in the FQDN or IP Address field in the Network Elements form.

- Alpha Tagging must be enabled to display consistent results.

- The Multilingual Name Display feature must be enabled to use the Multilingual Name Display Using External LDAP functionality. Disabling t he Multilingual Name Display feature disables the Multilingual Name Display Using External LDAP functionality.

- The Multilingual Name Display Using External LDAP functionality is disabled when the connection to the external LDAP server is lost. For more information, see External LDAP server for Multilingual Name Display in the LDAP Client Configuration form.

- If a number is marked as private by the PSTN, then there is no call display. Additionally, if an internal number from the Telephone Directory is marked as private, then only the name is displayed.

- Sets display full names if space is available.

- SIP devices query their names upon registration.

## Programming

1. System Options form

2. In the LDAP Client Configuration Profile ID #2 field, enter the profile number of the external LDAP server configured.

3. Set AlphaTag Enabled to Yes.

4. Set Multilingual Name Display to Yes.

2. LDAP Client Configuration form

3. In the LDAP Client Configuration table, click to select the profile ID.

4. In the Configuration tab, do the following:

- (Optional) In the Profile Name field, enter a name (up to 20 characters) displayed with the Profile ID when selecting profiles in the System Options form.

- In the LDAP server field, select the LDAP server for the client.

- In the LDAP Server Port field, enter the LDAP port number of the external directory server.

- In the LDAP Base DN field, enter the root directory to perform the search. The name can be up to 255 characters in LDAP distinguished named (LDAP-DN) format.

- (Optional) In the Username field, enter the user name required to access the directory server.

- (Optional) In the Password field, enter the password required to access the directory server.

- Set Client Status to Enabled.

- In the Search Scope field, enter the scope for search.

- In the Number Search Filter field, enter the filter for the LDAP number search. The string (0 to 256) must contain the % character. No search is performed if the field is left blank.

- In the Number Search Length field, enter the maximum number of digits (1 to 15) of the telephone number to be used for the search.

- (Optional) In the Connection Security option field, select the level of security of the LDAP connection.

5. In the Mapping Attribute List tab, do the following:

- In the First Name field, enter a comma separated list of LDAP attributes (up to 64) that corresponds to the first name.

- In the Last Name field, enter a comma separated list of LDAP attributes (up to 64) that corresponds to the last name.

3. Class of Service Options form

4. Set Display ANI/DNIS/ISDN Calling/ Called Number as Yes for external calls.

4. (Optional for SIP devices) SIP Devices Capabilities form

- Set Multilingual Name Display to Yes.

5. (Optional for SIP trunks) SIP Peer Profile form

6. Set Multilingual Name Display to Yes.

## Device Support

- Supported on all devices.

## Operation

None.

Related Topics

- Multilingual Name Display