Nec Xn120 Cti Guide

Download as pdf or txt
Download as pdf or txt
You are on page 1of 34

This guide explains the installation, configuration and operation of the XN120 CTI application.

Further information will be supplied with any optional equipment that you have purchased.
Please keep all information supplied for future reference.
Regulatory Notice.
Refer to the Getting Started Guide (991409-5) supplied with the XN120 Main Unit for the Declaration
of Conformity related to the product.
Warning: This is a class A product. In a domestic environment this product may cause radio
interference in which case the user may be required to take adequate measures.
Microsoft,Windows,Outlook,Small Business Server are registered trademarks of the Microsoft
Corporation in the United States and other countries. Screen shot(s) reprinted by permission from
Microsoft Corporation.
Other company and product names used in this manual are company trademarks or registered
trademarks.

XN120
CTI Getting Started Guide
Rev 1.0 March 2005
991456-5

Contents
Description ........................................................................................................................ 3
What is XN120 CTI .......................................................................................................... 3
What this guide covers .................................................................................................... 3
Requirements .................................................................................................................... 4
Telephone System........................................................................................................... 4
MyCTI TapiServer PC (0 10 Users) .............................................................................. 4
MyCTI TapiServer PC (10+ Users).................................................................................. 4
MyCTI Client PC .............................................................................................................. 4
XN120 Programming Sequence .................................................................................... 5
Installing the NEC TAPI Driver ......................................................................................... 6
Installing the NEC MyCTI TapiServer ............................................................................ 12
Location Details ............................................................................................................. 17
TapiServer Administration ............................................................................................. 19
Licensing TapiServer ..................................................................................................... 19
Hardware-ID .................................................................................................................. 19
Entering License ............................................................................................................ 20
Installing the NEC MyCTI Client ..................................................................................... 21
Using the NEC MyCTI Client........................................................................................... 28
Outgoing Calls ............................................................................................................... 29
Manual Dialing............................................................................................................... 29
Phonebook Dialing......................................................................................................... 29
Incoming Calls ............................................................................................................... 30
Show NEC MyCTI Window............................................................................................ 30
Show Quickinfo Bubble Window.................................................................................... 31
Open found contacts automatically................................................................................ 31
Open created Journal entries automatically................................................................... 32
Setting additional contacts folders to pop ...................................................................... 32
Setting journal entries automatically .............................................................................. 33

XN120 CTI Guide

XN120 CTI Guide


Description
What is XN120 CTI
The NEC Infrontia XN120 has capability to use Computer Telephony Integration (CTI). It uses the Telephony
Application Programming Interface (TAPI) 2.1 Protocol. To allow CTI an Ethernet interface is present on the
EXIFU-A1 option card. Further information relating to the EXIFU-A1 option card is available in the EXIFU
Guide.

What this guide covers


This guide contains the installation procedure for installing MyCTI in a Client/Server environment. This is
installed in three stages as follows:

TAPI Driver installation (AspireTSP)


MyCTI TapiServer installation
MyCTI Client installation

The TAPI Driver is installed to a PC which acts as the TapiServer; the TAPI driver provides real time
communication between the XN120 PBX and PC acting as TapiServer.
The TapiServer application is installed to a PC which acts as the TapiServer. The Server application should be
installed to a PC containing the TAPI driver (AspireTSP). The TapiServer application is used to distribute the
TAPI to client PCs where the MyCTI Client is installed.
The Client side is installed to Client PCs. The Client application consists of a dialer module which integrates
into Microsoft Outlook. The Client application then connects to the MyCTI TapiServer to allow monitoring and
control of Telephones.
The on-line help available within MyCTI provides further information for installing MyCTI into any other
environment not covered in this guide.

XN120 CTI Guide

XN120 CTI Guide


Requirements
Telephone System
XN120 Main Cabinet
EXIFU-A1 option card

MyCTI TapiServer PC (0 10 Users)


Operating System: Windows 2000 Professional, Windows XP Professional, Windows 2000 Server, Windows
Server 2003
CPU: Pentium based 800MHz
Memory: 256MB +
Free Disk Space: 10GB or over
Network Card: TCP/IP Protocol (Fixed IP Address)
NEC Aspire TSP (NEC Infrontia Aspire TAPI 2.1 driver software)

MyCTI TapiServer PC (10+ Users)


Operating System: Windows 2000 Server, Windows Server 2003
CPU: Pentium based 800 MHz
Memory: 256MB +
Free Disk Space: 10GB or over
Network Card: TCP/IP Protocol (Fixed IP Address)
NEC Aspire TSP (NEC Infrontia Aspire TAPI 2.1 driver software)

A Dedicated CTI Server is strongly recommended


Microsoft Small Business Server is not supported
The Server OS should include the appropriate number of Client Access Licenses
The backup procedure and virus defence is the responsibility of the customer

MyCTI Client PC
Operating System: Windows 2000 Professional, Windows XP Professional
CPU: Pentium based 800 MHz
Memory: 256MB +
Network Card: TCP/IP Protocol
The Ethernet interface is on the EXIFU-A1 option card. This is a 10/100Mb RJ45 Ethernet connection.

Ethernet Port

XN120 CTI Guide

XN120 CTI Guide


XN120 Programming Sequence
! You will need a fixed IP address and the appropriate Sub Net Mask for the XN120; this must be
specified by the Network Administrator responsible for the customers LAN.
1

Program 10-12-01
Enter the IP Address of the
XN120 system.

10-12-01
172.16 .0

.10

Enter the IP Address


of the XN120 system

Enter the Sub Net Mask.

Enter the IP Address; you must enter three digits for each
field. Example 172 016 000 010 you do not need to enter the
decimal points.
Press HOLD to confirm the entry.
10-12-02
255.255.0

.0

Enter the Sub Net


Mask

You must power the XN120


system off/on for the new IP
address to take effect.
2

Program 10-20-01
Enter the TCP Port used for
CTI.

Enter the Sub Net Mask; you must enter three digits for each
field. Example 255 255 000 000 you do not need to enter the
decimal points.
Press DC several times when you are done to return to the
Program Mode.
(Press SPK to save changes and exit if you are finished).

10-20-01
TCP Port

ExDev1
8181

Enter the TCP Port


used for CTI

Enter the Keep Alive Timer.

Enter the TCP Port, 8181 recommended.


Press HOLD to confirm the entry.
10-12-03
ExDev1
KeepAlive TM 30
Enter the Sub Net
Mask

XN120 CTI Guide

Enter the Keep Alive Timer, 30 seconds recommended.


Press HOLD to confirm the entry
Press DC several times when you are done to return to the
Program Mode.
(Press SPK to save changes and exit if you are finished).

XN120 CTI Guide

Installing the NEC TAPI Driver


Double click on the setup.exe file. Click NEXT when you see the following Welcome screen.

At the Aspire Telephony Service Provider Setup screen select Server and click next.

Choose Destination Location screen appears allowing you to choose the destination folder where you install the
TAPI driver. Click Next to accept the default target folder. If necessary, click Browse to choose a different drive
or folder.

XN120 CTI Guide

XN120 CTI Guide


The Setup Address screen appears. Enter the IP address of the computer, the IP address for the PBX, and the
PBX port No. Use dot "." between numbers. The IP addresses, and port no. must match the entry within
the telephone system programming (Commands 10-12 and 10-20). (e.g., TAPI: 192.168.1.76, PBX IP:
192.168.1.75, TCP Port: 8181) When you enter the information, click Next. Note, this address should be given
to you by the network administrator.

The time the TSP will wait for a response from the Aspire before deciding it will not respond. This value should
be left at the default value (10 Sec).

The Register for Service Setup screen appears. Select Register and click Next to begin the installation.

XN120 CTI Guide

XN120 CTI Guide

XN120 CTI Guide

XN120 CTI Guide


Select Single Line Mode.

Check Installation settings before clicking Next to complete Installation.

When copying files is complete, the following Setup Complete screen appears. Select Yes, I will restart my
computer . Select Finish.

XN120 CTI Guide

XN120 CTI Guide


Once the server has restarted. To verify that the TAPI driver installed correctly and is using the proper settings
double-click the Telephony icon from within the Control Panel (Start - Settings - Control Panel). The following
screen is displayed.
Click on the Telephony Drivers tab to see that the Aspire TSP is installed.

Click on the Configure button to see the configuration of TAPI driver. On Configuration tab, you can see the
Server/PBX IP addresses, TCP port no. and the Display Call Status Dialog option you set during installation. If
necessary, change data.

Click on the Device tab to confirm the system extension ports' status. You can not change any data on this
screen.

10

XN120 CTI Guide

XN120 CTI Guide


By selecting a Device and clicking Detail the Call Mode can be set. Select the mode required. Auto Speaker
Mode if the extension has no headset or Auto Headset Mode if extension has headset.

To exit, click CANCEL then click OK until you have exited to the Control Panel. Double-click in the upper left
hand corner of the Control Panel to close the window.

XN120 CTI Guide

11

XN120 CTI Guide


Installing the NEC MyCTI TapiServer
Double click on the setup.exe file. Click Next when you see the following Welcome screen.

Read the license agreement carefully. If you agree to the terms stated in the license, select I Agree to continue
the Installation.

Enter the Name and Organization of the registered owner of NEC MyCTI TapiServer, click next to proceed.

12

XN120 CTI Guide

XN120 CTI Guide


Select a folder where the application will be installed, click next to proceed.

Select which Installation type you require. Select CTI Network Server Installation, click next.

You are now ready to begin installation, click next to proceed.

XN120 CTI Guide

13

XN120 CTI Guide


You should now specify Login to the TapiServer Admin program. Ensure that you make a note of the User
name and Password. Click Next to proceed.

You should now specify the TCP ports for communication. It is recommended to leave these as default.

The following screen prompts you to license the TapiServer, select TapiServer Trial option. This entitles you to
use the software for a period of 45 days.

14

XN120 CTI Guide

XN120 CTI Guide


The next screen confirms your license settings, click next to proceed.

You should now define User Management settings, TapiServer User Management is recommended.

Leave the default option Windows Username selected, for User Authentication.

XN120 CTI Guide

15

XN120 CTI Guide


Leave the Installation with user assistance selected, for User Installation.

At the Location screen, select the appropriate settings for the following. Select next on completion.
Location
Example
Country/Region = United Kingdom
Area Code = 01509

Important See Location Details overleaf before selecting next!

16

XN120 CTI Guide

XN120 CTI Guide


Location Details
Select the Details button, to specify settings for telephone system. Click OK on completion.
Outgoing calls from the PC
You should specify the Trunk access code to allow TAPI Clients to out dial to external numbers correctly
Example
Access code for local calls = 9
Access code for national calls = 9
Access code for international calls = 9
PBX system (switchboard)
You should specify the correct Number of digits for internal calls
Example
Number of digits for internal calls = 3
Phone number format
If access codes are to be removed from incoming/outgoing Caller IDs, enter the code in the following fields.
It is recommended to remove the 0 from the incoming/outgoing access code fields; otherwise this will affect the
screenpop facility within MS-Outlook.
Example
Remove incoming access code(s) = blank
Remove outgoing access code(s) = blank

XN120 CTI Guide

17

XN120 CTI Guide

You should now specify the TAPI Lines that are to be assigned to the NEC MyCTI TapiServer. The following
screen displays the available TSPs (Telephony Service Providers). Select Next to proceed.

Expand the Aspire Telephony Service Provider, to display available Extensions.


Select the applicable extension(s) which you wish to assign to the NEC MyCTI TapiServer.
Example
X = Extension 200 Keyset
X = Extension 201 Keyset
X = Extension 202 Keyset

The setup is now complete, select Finish to complete.

18

XN120 CTI Guide

XN120 CTI Guide


TapiServer Administration
After successfully installing the NEC MyCTI TapiServer, it is possible to perform administrative tasks using the
TapiServer Administration user interface.
This enables the administrator to perform a variety of tasks; the majority of these are detailed within the online
help available within the TapiServer Administration.
Locate the TapiServer Administration utility, under Start/Programs/NEC/TapiServer/TapiServer Admin
Click on to Configuration/General/License Settings

Licensing TapiServer
You can use the TapiServer with all available features for 45 days. After the 45 day period you are required to
buy licenses and enter the license codes.

Hardware-ID
TapiServer licenses consist of 35 characters, which are bound to the Hardware-ID created on installation of the
TapiServer.
In order to display the Hardware-ID bound to your installation of TapiServer, perform the following.
Open the TapiServer Administrator, click on to Configuration/General/License Settings.

The Hardware ID is located in the lower right of the screen

XN120 CTI Guide

19

XN120 CTI Guide


Entering License
Click the Add button under Configuration/General/License settings.

Enter the license exactly as provided by your authorized reseller, click ok to apply.
Example Code
ABCD1234-ABCD1234-ABCD1234-ABCD1234

20

XN120 CTI Guide

XN120 CTI Guide


Installing the NEC MyCTI Client
Double click on the setup.exe file. Click Next when you see the following Welcome screen.

Read the license agreement carefully. If you agree to the terms stated in the license, select I Agree to continue
the Installation.

Enter the Name and Organization of the registered owner of NEC MyCTI TapiServer, click next to proceed.

XN120 CTI Guide

21

XN120 CTI Guide


Select a folder where the application will be installed, click next to proceed.

Select which Installation type you require. Select CTI Network Client Installation for default, click next

You should now specify the desired MyCTI client, MyCTI Enterprise for Outlook is recommended.

22

XN120 CTI Guide

XN120 CTI Guide


You are now ready to begin installation, click next to proceed.

After installation is complete, you are required to specify the client computer type. It is recommended to leave
the Normal Workstation option selected.

You should now specify the TapiServer, either using host name or IP Address.

XN120 CTI Guide

23

XN120 CTI Guide


You are now required to enter the extension numbers of telephones located near to the Client Computer.
These extensions are assigned to the CTI Monitor. Click Next to proceed.
Example
First Telephone = 201
Second Telephone = 202

The following part of setup can be used to Activate MyCTI, and integrate into Microsoft Outlook.

Setup is almost complete, select Finish.

24

XN120 CTI Guide

XN120 CTI Guide


Enter how the Current user should login to the TapiServer. The only available option is Windows Login, as this
was specified earlier during TapiServer setup.

Now enter the extension numbers of your personal telephones. This enables you to specify the Extensions for
use with MS Outlook. Click Next to proceed
Example
First telephone = 200

XN120 CTI Guide

25

XN120 CTI Guide


Enter your personal information into the following screen. Click Next to proceed.
Example
Display Name = John Smith
E-Mail Address = [email protected]

Enter any additional extensions into the CTI monitor. Adding additional extensions into the CTI monitor
enables you to monitor your colleagues extension status.
Here you can also set permissions for extensions within the CTI Monitor. As an example you are able to pick
up calls ringing at extensions listed within the CTI monitor.

26

XN120 CTI Guide

XN120 CTI Guide


Select Finish to complete. MyCTI will now integrate into Microsoft Outlook, to enable you to out dial and
screenpop using your devices configured in the previous steps.

XN120 CTI Guide

27

XN120 CTI Guide


Using the NEC MyCTI Client
MyCTI has now been added into Microsoft Outlook, and is activated alongside Microsoft Outlook. On activation
of Microsoft Outlook, note that the MyCTI toolbar has been added along with the MyCTI dialer within the
Windows System Tray (Highlighted below).

MyCTI Toolbar

MyCTI Dialer
Double click either the Phone Call button or the Dialer icon, which opens the Dialer.

28

XN120 CTI Guide

XN120 CTI Guide


Outgoing Calls
There are a number of ways to out dial using the MyCTI dialer. These are summarized below, further detailed
information can be found in the MyCTI online help.

Manual Dialing
To out dial manually, it is possible to enter the called number into the Number field of the Dialer.

Enter number using number pad

Enter number using keyboard

Example
Enter Telephone number 01509643100 into number field, select Begin Call. Number is dialed automatically.

Phonebook Dialing
It is also possible to out dial by searching the phonebook using the Contact and Number fields within the MyCTI
dialer.

Search Contact using Contact field

Search Contact using number field

Example
Enter valid contact into contact field, for example XN120. Select Find to display relevant contact and
Telephone number. Select Begin Call, to out dial automatically.

XN120 CTI Guide

29

XN120 CTI Guide


Incoming Calls
As with Outgoing calls, there are a number of ways using MyCTI to identify incoming calls. These are
summarized below, further detailed information can be found in the MyCTI online help.
For specifying how the MyCTI behaves on incoming calls, perform the following via the MyCTI Dialer.
Click Settings within the Dialer

Select General, under incoming calls check the relevant option.

Show NEC MyCTI Window


As soon as an incoming call is detected, it will be displayed in the MyCTI window.

30

XN120 CTI Guide

XN120 CTI Guide


Show Quickinfo Bubble Window
As soon as an incoming call is detected, it will be displayed in the MyCTI quickinfo bubble window.

Open found contacts automatically


As an incoming call is received, the CLI will be check against the Contacts folder within Microsoft Outlook. If a
match is found, the appropriate contact will be popped. Selecting the appropriate folder(s) to be popped can be
found under setting additional contacts folders to pop.

MyCTI will by default search for Contacts within Private folders (i.e. local contacts folder)

XN120 CTI Guide

31

XN120 CTI Guide


Open created Journal entries automatically
If this option is checked and a journal entry is created automatically for an incoming call, it will also be opened
automatically. Setting journal entries automatically can be found under setting journal entries automatically.

Setting additional contacts folders to pop


Additionally it is possible to specify either all folders, or specific folder (i.e. Public Contacts folder).
To specify additional folders, click Settings within the Dialer

Select Search, under Search phone numbers on incoming call.

Example
To allow MyCTI to search Public Folder contacts, select Search only particular folders and click the details
button.
Select Add, and select the appropriate folder.

Select the appropriate folder, and click ok several times.

32

XN120 CTI Guide

XN120 CTI Guide

Setting journal entries automatically


To specify additional folders, click Settings within the Dialer

Select Journal, under the section Journal creation for incoming calls specifies whether journal entries are
created for unanswered and answered calls. Additionally you can specify an additional journal folder under
Microsoft Outlook, by clicking Browse and selecting the appropriate folder.

XN120 CTI Guide

33

XN120 CTI Guide


Call Forwarding
Using MyCTI you may control call forwarding at your local extension(s). It is possible to setup multiple profiles
for call forwards; these settings can be found below.
Select the Call Forwarding Setup button.

Name
Enter a name for each call forwarding profile you create. This name will be displayed in the drop down
menu and on the call forwarding button.
Options
Enter the type of call forwarding here. The most common type of call forwarding is, forward all calls.
Phone number
Enter the extension number to which you wish to set the forward to i.e. 203.

Example
Name=Tony Jones
Options=All Calls are forwarded
Number=203

34

XN120 CTI Guide

You might also like