(Page 1 of 1 in this chapter)
Chapter 2
Installing and Configuring the Software
2.1 Introduction
2.2 Installing the Software
2.2.1 Upgrading NMS TAPI
2.3 Configuring the NMS TSP
2.3.1 Configuring TSP Settings
2.3.2 Configuring NMS Hardware
2.3.3 Configuring TAPI Lines
2.3.4 Configuring Telephony Parameters
2.3.5 Creating Custom Configurations
2.3.6 Testing the Configuration
2.4 Verifying the Installation
2.5 Enabling and Disabling NMS TAPI Components
2.5.1 Enabling and Disabling the NMS TSP
2.5.2 Enabling and Disabling the NMS WAVE Driver
2.1 Introduction
This chapter describes how to install NMS TAPI on Windows NT systems. It also explains how to enable and disable the NMS TSP and NMS WAVE driver through the Windows NT Control Panel.
Refer to
readme_tapi.txt
for a complete list of the files installed with NMS TAPI and a list of important notices, documentation corrections, or changes from previous releases. This file is found on the first installation diskette. The installation diskette images are available either on the Natural Access CD or the NMS web site (
www.nmss.com
).
For information about removing NMS TAPI software, refer to
Appendix B
.
2.2 Installing the Software
NMS TAPI can be installed in two ways. First, it is included on the NMS Natural Access CD, which contains most NMS software. The master installation program on the Natural Access CD includes NMS TAPI. Second, the NMS TAPI setup program can be run separately. The stand-alone setup program (
setup.exe
) is available either from the NMS web site (
www.nmss.com
) or on the Natural Access CD in the following directory:
\nmstapi\disk1
. The following instructions describe installing NMS TAPI from the stand-alone setup program.
To install NMS TAPI software under Windows NT:
Log on as a member of the Administrators group.
From the
Start
menu select
Run...
The Run dialog box appears.
Run the setup program by first entering the full path name for
setup.exe
and then clicking
OK
. For example, if you are running the setup program from the Natural Access CD, enter the following:
d:\nmstapi\disk1\setup.exe
where
d:
is the CD ROM drive letter.
Follow the prompts as appropriate for your system.
To configure NMS TAPI for use by TAPI applications, see
Section 2.3,
Configuring the NMS TSP
.
Reboot Windows NT.
The setup program automatically adds the NMS TSP and NMS WAVE drivers to device lists kept by the Windows NT Telephony and Multimedia applets. Refer to
Section 2.5
for instructions about enabling or disabling NMS TAPI components through the Windows NT Control Panel.
Note:
If no other audio devices are installed, Windows NT attempts to use the NMS WAVE driver as an audio output device for playing sounds. For example, Windows NT may attempt to play sounds when programs display message boxes and at startup or shutdown. If a line is open and a call is connected by the NMS TSP, this output is heard through the telephone. Avoid this by installing another audio device or disabling sounds using the Sounds applet on the Windows NT Control Panel.
2.2.1 Upgrading NMS TAPI
To upgrade to a new version of NMS TAPI:
Remove any previously installed versions of NMS TAPI using the Add/Remove Programs applet in the Windows NT Control Panel as described in
Appendix B
.
Reboot Windows NT.
Install new NMS TAPI software according to the instructions in
Section 2.2
.
2.3 Configuring the NMS TSP
The NMS Configurator allows you to configure the NMS TSP to work with NMS hardware on your system. It provides a central way to configure the boards and lines that run on the NMS TAPI system. The NMS Configurator appears during installation, but you can also run it at any time from the telephony applet in the Windows NT Control Panel.
The following sections describe how to use the NMS Configurator to:
Configure basic NMS TSP settings
Configure NMS board settings on the host machine
Configure TAPI lines
Configure telephony parameters
2.3.1 Configuring TSP Settings
To configure the NMS TSP:
From the
Start
menu, select
Settings
, and then
Control Panel
.
The Windows NT Control Panel appears.
Double-click the
Telephony
icon on the Control Panel.
The Dialing Properties dialog box appears.
Click the
Telephony Drivers
tab.
The Telephony Drivers tab displays a list box containing the names of all TSPs available to applications. In the Telephony Drivers tab, select the
Natural MicroSystems Service Provider
entry.
Click the
Configure
button.
The NMS Configurator dialog box appears:
Select a board from the
Installed Boards
list.
In the
Country
list, click the country in which the board is being used.
If you are using an ISA bus, select a free ISA interrupt in the
ISA Interrupt
list.
Select the
H.100
check box to use the H.100 bus to connect multiple boards in the system. This is an advanced feature for applications that perform their own switching.
Note:
If this check box is checked, but the application
does not
perform switching, the default switch connections are maintained.
Click
OK
.
2.3.2 Configuring NMS Hardware
To add or configure telephony boards:
From the NMS Configurator dialog box, click
Add Board
, or select a board in the
Installed Boards
list and click
Edit Board
.
The Configure Boards dialog box appears.
NMS TAPI provides a default board name. If you want to change the default name, type a new name in the
Board Name
box.
In the
Board Type
list, click the type of board you are configuring (e.g., AG-8, AG-T1 etc.).
In the
TAPI Lines
list, click the number of
lines to enable for NMS TAPI
.
The list displays the total number of lines available for the specified board type. To enable all of the lines accept the default value. To enable a subset of the available lines for NMS TAPI, select a smaller number.
In the
Protocol
list
,
click the protocol to be used by all lines on the selected board (e.g., Loop Start, Wink Start, etc.).
In the
ISA
or
PCI
box, specify the setting appropriate for the host system bus and the specified board (NMS TAPI enables
ISA
or
PCI Bus
based on the board type selected in Step 3):
ISA Bus
: Select an address in the
Address
box or click
Change
. When the Change Board Address dialog box appears (shown below), change the address by clicking the appropriate jumper toggles, or typing an address in the
Address
option box. The specified address must match the board settings, and each board must have a unique address.
PCI Bus
: From the
Bus
and
Slot
lists, select a bus and slot number.
Select the
Extended Super Frame
check box to enable the host system to use this frame type (enabled for digital boards only).
To enter configuration information for the current board for which there is no user interface control in the configuration dialog box, click
Config File
. A text entry dialog box appears. Enter free-form text in the same format used by Natural MicroSystems configuration files. See the NMS installation and developer's manual for your NMS hardware for details concerning configuration file entries. See the
AG Runtime Configuration and Developer's Manual
for instructions on configuration file format.
In the
Voice Codec
checkboxes, select the voice compressions you will use in your TAPI application(s).
Click
OK
to exit and keep your changes. Click
Cancel
to exit without saving your changes.
2.3.3 Configuring TAPI Lines
There are two aspects of configuring lines for use with TAPI. The first involves specifying which hardware lines are made available to TAPI applications. The second involves specifying attributes of individual lines.
Making Hardware Lines Available to TAPI Applications
NMS TAPI implements voice channels or ports available on NMS hardware as TAPI lines. Some or all of these ports can be made available to TAPI applications using the
Configure Board
dialog box described in
Section 2.3.2,
Configuring NMS Hardware
.
Note:
If you select a number in the
TAPI Lines
field that is less than the number of ports on the hardware, then only the first ports can be used by any TAPI application. For example, consider the QX 2000, a 4-port analog board. If you select
3
in the
TAPI Lines
field, then the first 3 ports are mapped as TAPI lines. The fourth port is unavailable to any TAPI application.
Specifying TAPI-specific Attributes of Individual Lines
From the NMS Configurator dialog box, select a board from the
Installed Boards
list box and click the
Advanced
button.
The NMS TAPI Advanced System-Level Configuration dialog box appears.
Click the
All Lines
tab.
The All Lines tab appears.
Select a line from the displayed list and click the
Edit
button.
The Edit Line dialog box appears.
Enter the following information for the selected line and click
OK
:
Name
(accept the default line name or type a new line name.)
Line Address
(type in a telephone number to associate with the line.)
Repeat Steps 3 and 4 for each line you want to configure.
Click
OK
in the All Lines tab dialog box.
2.3.4 Configuring Telephony Parameters
The NMS Configurator provides a way to configure parameters that affect telephony operations on NMS boards. Parameters can be set in the Telephony Parameters tab of the NMS Configurator.
For more information about NMS board default runtime (CT Access) parameters refer to
Appendix D
or your board's
Installation and Developer's Manual
.
To configure NMS TAPI parameters:
From the NMS Configurator dialog box, select a board from the
Installed Boards
list box and click the
Advanced
button.
The NMS TAPI Advanced System-Level Configuration dialog box appears.
Click the
Telephony Parameters
tab.
The Telephony Parameters tab appears.
Configure telephony parameters as follows:
Edit
an existing parameter by selecting it from the list and clicking the Edit button. When the Change Parameter dialog box appears (shown below), enter a new name for the parameter and click
OK
.
Add
a parameter by entering a parameter name in the text box and clicking the
Add New Parameter
button. Use this if the parameter you want to set does not show up in the Telephony Parameters list.
Delete
a telephony parameter by selecting it from the list and clicking the
Delete
button.
Refer to
Appendix D
for a list of NMS board configurable parameters.
Click
OK
.
2.3.5 Creating Custom Configurations
NMS TAPI provides two ways to enter configuration information for which there is no user-interface control in the configuration dialog box. Both methods allow you to enter this information as free-form text in the same format used by Natural MicroSystems configuration files. For more information on configuration files, see the NMS installation and developer's manual for your NMS hardware for details concerning configuration file entries.
To enter custom configuration information for a specific board, see
Section 2.3.2,
Configuring NMS Hardware
. To enter custom information that applies to all NMS hardware:
From the NMS Configuration dialog box, click the
Advanced
button. The NMS TAPI Advanced System-Level Configuration dialog box appears.
Click the
Common Configuration Lines
tab. The Common Configuration Lines tab appears.
Enter your information into the text box, one configuration item option per line as shown in the example.
4. Click
OK
.
2.3.6 Testing the Configuration
To verify that the configuration you have specified will work on the installed hardware:
From the NMS Configuration dialog box, click the
Advanced
button. The NMS TAPI Advanced System-Level Configuration dialog box appears.
Click the
Test Boards
tab. The Test Boards dialog box appears.
Click the
Run Test
button. Results are displayed when the test is complete.
WARNING:
To run the test, NMS TAPI re-initializes the hardware. Make sure that no applications are using NMS hardware before you run the test.
Click
OK
.
2.4 Verifying the Installation
To verify the NMS TAPI and NMS WAVE driver installation, run the
intapi
demonstration program described in
Chapter 7
of this manual.
Note:
If you experience problems with
intapi
, or if you receive error messages during installation, refer to
Appendix C
.
2.5 Enabling and Disabling NMS TAPI Components
NMS TAPI components can be enabled and disabled through the Windows NT Control Panel. The following sections describe how to enable and disable the NMS TSP and the NMS WAVE driver.
2.5.1 Enabling and Disabling the NMS TSP
To enable or disable the NMS TSP:
From the Windows NT
Start
menu, choose
Settings
, then
Control Panel
.
The Windows NT Control Panel appears.
Double-click the
Telephony
icon.
The Dialing Properties dialog box appears.
Click the
Telephony Drivers
tab.
The Telephony Drivers tab displays a list of installed drivers.
To
enable
the NMS TSP (when the TSP does not appear in the displayed list):
Click
Add
.
The Add dialog box appears.
Select
Natural MicroSystems Service Provider
, and click
Add
.
In the Telephony Drivers tab, select
Natural MicroSystems Service Provider
.
Click
Configure
.
The NMS TSP configuration dialog box appears.
Configure the TSP according to the instructions in
Section 2.3
.
Click
OK
to exit the NMS TSP configuration dialog box.
To
disable
the NMS TSP (when the TSP appears in the displayed list):
Select
Natural MicroSystems Service Provider from the displayed list
.
Click
Remove
.
Click
Yes
to confirm removal.
When finished enabling or disabling the NMS TSP, click
OK
to exit the Telephony applet.
2.5.2 Enabling and Disabling the NMS WAVE Driver
To enable or disable the NMS WAVE Driver:
From the Windows NT
Start
menu, choose
Settings
, then
Control Panel
.
The Windows NT Control Panel appears.
Double-click the
Multimedia
icon.
The Multimedia Properties dialog box appears.
Click the
Devices
tab.
The Devices dialog box displays a list of multimedia device categories.
Click the
Audio Devices
entry.
The Audio Devices tab displays a list of installed audio devices.
To
enable
the NMS WAVE driver (when the driver does not appear in the displayed list):
Click
Add
.
The Add dialog box appears.
Select the
Unlisted or Updated Driver
entry and click
OK
.
The Install Driver box appears.
Click
Browse
.
Select the
nmstapi
directory under the directory where NMS TAPI is installed (normally this is
c:\nms\nmstapi
) and click
OK
.The Devices tab of the Multimedia Properties dialog box appears.
Select
Audio for Natural MicroSystems Telephony Hardware
and click
OK
.
To
disable
the NMS WAVE driver (when the driver appears in the displayed list):
Select
Audio for Natural MicroSystems Telephony Hardware
from the displayed list.
Click
Remove
.
Click
Yes
to confirm removal.
When finished enabling or disabling the NMS WAVE driver, restart the computer.
(Page 1 of 1 in this chapter)
tech_support@nmss.com
Copyright © 1999, Natural MicroSystems, Inc. All rights reserved.