esi Active Directory System Software Instruction Manual

Contents hide

1 esi Active Directory System Software

2 Product Information

3 Product Usage Instructions

4 FAQ

5 Introduction

6 The Active Directory

7 Setting up Active Directory via the phone’s GUI

7.1 Getting the phone IP address

8 Logging in to the phone’s GUI

9 Setting up the phonebooks

10 Viewing the phonebook on the ePhone8

11 Viewing phonebook on ePhone3/4x v1

12 Documents / Resources

12.1 References

13 Related Posts

esi Active Directory System Software

Specifications

Product Name: ESI eSIP and iCloud

Feature: ESI Phone LDAP Contacts with Active Directory

Product Information

This document serves as a guideline for setting up access to an Active Directory using Lightweight Directory Access Protocol (LDAP) from an ESI Phone.

It outlines the process of accessing a simple Active Directory and retrieving information such as names and phone numbers for users and contacts.

Product Usage Instructions

Introduction

The document provides instructions for accessing a simple Active Directory using LDAP. It emphasizes the importance of involving the Active Directory administrator to provide necessary information for setup.

The Active Directory

Each company will have a unique Active Directory structure. The network administrator should offer guidance on data entry and user credentials.
Access to the Active Directory should be secured, and the network administrator must ensure phones have secure access to the network.

Setting up Active Directory via the phone’s GUI

Getting the IP address for ePhone8
Getting the IP address for ePhone3/4x v2, ePhoneX/X-1

Getting the IP address for ePhone3/4x v1

Logging in to the phone’s GUI

Instructions on logging in to the phone’s GUI to set up access to Active Directory.

Setting up the phonebooks

Guidelines on configuring the phonebooks to retrieve names and phone numbers from the Active Directory.

FAQ

Q: Can this document be used for accessing any Active Directory?

A: This document is specific to setting up access to a simple Active Directory. The structure of each Active Directory may vary, so involvement from the administrator is crucial.

Q: How should secure access to the network be established?

A: Secure access methods like VPN connections should be set up by the network administrator. Specific setups will vary for each customer.

This document is intended to be followed as a general guideline to set up access to a simple Active Directory (AD) from an ESI Phone using Lightweight Directory Access Protocol (LDAP).

Introduction

This document describes the procedure used to access a simple Active Directory (AD) using Lightweight Directory Access Protocol (LDAP).
This document should not be interpreted as a universal “how to get access to any Active Directory”, but rather a guideline describing how ESI’s product Management set up one phone to retrieve information from a very simple Active Directory.

Please notice that the structures of Active Directories will be different in each company and therefore the administrator of the Active Directory needs to be involved in providing the appropriate information to enter into the phone via the GUI interface.
For the creation of this guideline document, a very simple Active Directory was created with fake values to illustrate the relationship between the data in the Active Directory and the information required in the phone’s GUI to be able to retrieve names and phone numbers for users and contacts.

The Active Directory

Each company will have a different structure for the Active Directory being used. The administrator of the Active Directory should provide assistance in identifying what data should be entered.
The network administrator should also provide guidelines as to what user should be used to gain access to the Active Directory. For this procedure, the credentials of one of the users were used, but that doesn’t have to be the case always.

Access to the company’s Active Directory is always protected and therefore the network administrator should also provide assistance in giving the phones secure access to the network where the Active Directory resides.
That may be setting up a VPN connection or something similar. Setting up the secured access to the network where the Active Directory resides is not covered in this document as it will be specific for each customer.

For this exercise, a very simple Active Directory was created on a virtual machine in a personal computer. Access to that virtual machine was therefore very easy and no VPN connection had to be set.
The IP address of the virtual machine happened to be 10.0.0.5, but in actual implementations, the IP address to be used should be the address of the server hosting the Active Directory.
The following figure shows three users defined in the Active Directory under the Users folder and at the top, the path where those users are located.
In this exercise, user Jose Mario Venta will use his credentials to access the Active Directory. The figure below shows the DN for this user which is one of the elements that need to be known.
The following figure shows the two external contacts defined in the Active Directory under the Phonebook folder.

Setting up Active Directory via the phone’s GUI

Getting the phone IP address

Getting the IP address for ePhone8

Obtain the IP address of the phone you want to set up to access the Active Directory. In an ePhone8 you can do that by sliding your finger from the top of the screen down, which will open a small window where the IP address can be seen.
Alternatively, you can also find the IP address by selecting Settings (gear icon) on the main screen, and then selecting Network.
Here you will find the IP address.

Getting the IP address for ePhone3/4x v2, ePhoneX/X-1

Press the Menu key on the phone.
Then select Status and press OK.
You will find the IP address under the Network tab as shown below.

Getting the IP address for ePhone3/4x v1

Press the Menu key on the phone.
Select Status and press Enter.
Under Status, you will find the phone IP address.

Logging in to the phone’s GUI

Open a web browser, enter the phone’s IP address in the URL field and press Enter.
Then enter the User and Password into the login window and click Login.

Setting up the phonebooks

ePhone8, ePhone3/4x v2, ePhoneX/X-1

Now you are in the phone’s GUI. Go to Phonebook > Cloud Phonebook.
We will create two Active Directory Cloud Phonebooks, one for the PBX users and one for the external contacts. You can have up to 4 Active Directory Phonebooks.
Select LDAP from the dropdown menu, then click LDAP Phonebook.

To create the first phonebook, select LDAP1 from the dropdown menu under LDAP settings, enter the necessary information as shown in the example below, and click Apply.
Display Title: Give this phonebook a name, in this case, “PBX Phonebook”
Server Address: Enter the IP address of the server hosting the AD.

LDAP TLS Mode: Use LDAP
Authentication: Select “Simple” from the dropdown menu
Username: Enter the complete DN (as shown in the AD) for the user that will give access to the AD. Search Base: Enter the path in the AD where the search should begin, in this example, the users are listed under testdomain.com/Users so, this is CN=Users,

DC=testdomain, DC=com
Telephone: Enter the field in the AD where the extension number is specified, in this example, iPhone Other: If there are other fields populated in the AD you can enter one of them here
Sort Attr and Name Filter are automatically populated but if they are not just copy what’s shown in the figure above.

Version: Select Version 3 from the dropdown menu
Server Port: 389
Calling Line and Search Line: Enter the phone line for which you want this Phonebook to show, in this case, there is only one line so you can use “AUTO”

Password: Enter the AD password for the specified username
Name Attr: cn sn
Display name: cn

Number filter: should be automatically populated but if it is not, enter (|(ipPhone=%)(mobile=%)(other=%))
Please notice that the first field name (ipPhone) should be the same one you have entered in the Telephone field above.
Checkmark the “Enable In Call Search” and “Enable Out Call Search”

Click on the Apply button.
NOTICE: fields Telephone, Mobile, and Other, can be populated with whatever values of the AD you want to retrieve (where phone numbers may have been stored).
The users retrieved from the Active Directory should now be listed in the Cloud phonebook section, and you will see a new button that reads PBX Phonebook as shown below.

To create the second phonebook named Business Contacts, select LDAP2 from the dropdown menu under LDAP settings, enter the necessary information as shown in the example below and click Apply.
The users retrieved from the Active Directory should now be listed in the Cloud phonebook section, and you will see a new button labeled Business Contacts as shown below.

ePhone3/4x v1

LDAP settings for ePhone3 v1 and ePhone4x v1 are similar to the above, with a few minor differences in how a few of the settings are named. You can click the question mark for a description of the setting.
Once configured, the phonebook will appear in the Cloud phonebook list.

Viewing the phonebook on the ePhone8

Viewing ePhone8 individually created Phonebooks

On your ePhone8, tap on the Phonebook icon on the main screen.
Now tap on the web phonebook on the menu to the right of the screen.
Both Cloud Phonebooks should be listed on your screen, identified with the names you gave them before.

You will see the IP address of the server hosting the Active Directory underneath each name.
Tap on the PBX Phonebook.
You will see the contents retrieved from the PBX Phonebook Active Directory as shown below. In this example is the contents of the folder that contains the Users.

Other Active Directories may be structured differently, with Organization Units and such, in this example you can see a “Guest” user with a phone number and a user for extension 1010.
Go back to the previous screen and tap on the Business Contacts.
Now you will see the external contacts and their phone numbers defined in the Business Contacts Active Directory.

Configure the Phonebook icon to access Active Directory directly

You can set up the ePhone8 Phonebook icon to access the Active Directory directly.

Select Settings Gear Icon which is located on the ePhone8 home screen.

Scroll down to System, and then select Display.
Scroll down, and then select Select Phonebook Type.
Select Network Phonebook.
- Press the Phonebook icon on the home screen and the Active Directory contacts will be displayed where the user can scroll through the directory list or search by either Name or Number.

Search by number:

Search by name:

Viewing phonebook on ePhone3/4x v2, ePhoneX/X-1

Configure a Contacts Softkey to access Active Directory

Set the contacts Softkey to access the Active Directory as default.

Select Menu.
Use the arrow keys to scroll to Basic and press OK
Select 6. Keyboard and press OK

Select 2 Soft DSS Key Settings and press OK
Configure the Soft DSS Key Settings as follows:
- a. Softkey: 1-1
- b. Type: Key Event
- c. Key: LDAP Group
- d. Line: LDAP Group1
- e. Name: Contacts (or configure your own key name)
- f. Press OK
From the Keyboard menu select 3. Softkey and press OK

Select 2. Contact and press OK
Using the left/right arrow keys select the soft DSS Key previously configured in step 5 and press OK (Dsskey1 = Softkey 1-1, Dsskey2 = Softkey 1-2, etc)
Return to the idle screen
- Press the Contacts softkey and the full Active Directory is displayed where the user can scroll through the directory list or search by either Name or Number.

Search by number:

Search by name:

Viewing phonebook on ePhone3/4x v1