2.1 Configuring NMS TAPI

2.1.1 Configuring the System with the NMS Configurator

2.2 Adding an NMS Board

2.3 Configuring Board-Level Settings

2.4 Configuring System-Level Settings

2.4.1 Specifying the NMS TAPI Line Configuration

2.4.2 Specifying Configuration Files and Locations

2.4.3 Configuring Telephony Parameters

2.5 Testing the Configuration

2.6 Verifying the Installation

2.7 Enabling and Disabling NaturalFax for TAPI

2.1 Configuring NMS TAPI

The NMS Configurator allows you to configure the NMS TSP to work with the NMS hardware on your system. It provides a central way to configure the boards and lines that run on the NMS TAPI system. You can run the NMS Configurator at any time from the telephony applet in the Windows Control Panel.

Board configuration cannot be performed using NMS OAM when NMS TAPI is running.

Note: Before running NMS TAPI with Natural Access, you must stop ctdaemon (using the Windows Control Panel or by entering net stop ctdaemon from a command prompt). Replace the following entry in your cta.cfg file: Service = oam, oammgr

with:

#Service = oam, oammgr

This chapter describes how to use the NMS Configurator to:

• Configure basic NMS TSP settings

• Add a board

• Configure board-level settings

• Configure system-level settings

• Configure resource boards

• Test the configuration

• Configure NaturalFax for NMS TAPI

This chapter also includes instructions for verifying the installation and enabling and disabling the NMS WAVE driver. For more information on configuring Natural Access, refer to the Natural Access Developer's Reference Manual.

2.1.1 Configuring the System with the NMS Configurator

To perform system configuration with the NMS Configurator for the first time:

1. From the Start menu, select Settings, and then Control Panel.
   The Windows Control Panel appears.

2. Double-click the Telephony icon (Windows NT users) or the Phone and Modem Options icon (Windows 2000 users) on the Control Panel.
   The Dialing Properties dialog box appears.

3. Click the Telephony Drivers tab (Windows NT users) or the Advanced tab (Windows 2000 users). The Telephony Drivers tab displays a list box containing the names of available TSPs.

4. Select the Natural MicroSystems Service Provider entry.
   Note: If the Natural MicroSystems Service Provider does not appear in the TSP list, there is a problem with the NMS TAPI installation. Refer to Appendix A for more information.

5. Click Configure.
   The NMS Configurator dialog box appears:
   
   

The following table describes the fields on the NMS Configurator dialog box:

Use this field...	To...
Country	Specify the country where the system runs.
Enable CT Bus	Enable the CT bus for the board you are configuring.
Advanced...	Access the Advanced System-Level Configuration dialog box.
Add Board	Add a new board to the Installed Boards list.
Remove Board	Delete a selected board from the Installed Boards list.
Configure Board	Reset configuration settings for a selected board in the Installed Boards list.
Remove All	Remove all boards from the Installed Boards list.
Move Up	Move a selected board up one space in the Installed Boards list.
Move Down	Move a selected board down one space in the Installed Boards list.
Set Master	Set a selected board as the CT bus clock master.
Reset Master	Change a selected board from the CT bus clock master to a CT bus clock slave.
Export Registry	Export the current NMS Configurator configuration settings to a Windows registry file.
Import Registry	Import configuration information from NMS Configurator settings contained in a registry file.
Run Test	Test the current configuration and display the test results.

Note: For board-specific information, refer to the documentation for the board.

2.2 Adding an NMS Board

Perform the following steps to add NMS telephony boards using the NMS Configurator:

1. In the NMS Configurator dialog box, click Add Board.
   The Board Type dialog box appears:
   

2. Configure the following board settings:

   Field	Setting
   Board Name	Type a name for the board.
   Board Type	Select the type of board you are configuring.
   Protocol	Select the trunk control protocol you want to use (for example, wink start, loop start, or no call control).
   Clock Source	Select the timing source you want the board to reference.
   Select Impedance	Select the line impedance for the board.
   TAPI Lines	Enter the number of TAPI lines the board will be using.

3. Click Next. The Board Address dialog box appears:
   

4. Configure the following board address settings:

   Field	Setting
   PCI Bus	Type the PCI Bus number for the board you are configuring.
   PCI Slot	Set by the NMS Configurator based on the board that is selected. Modify this number if necessary.
   Serial Number	Enter the serial number for the board you are configuring (QX boards only).
   Select Board	(Optional.) Select the board you want to configure from the list of installed boards. The PCI bus and PCI Slot number will be updated to match the board you selected.

5. Click Next. The Board Functions dialog box appears:
   

6. Select the voice codecs you will use in your TAPI application(s). Select the boxes for the play and record functions you want to use. Select the Fax Enabled check box if you plan to use fax.

7. Click Finish.
   The NMS Configurator dialog box appears with the new board added to the Installed Boards section of the window.

8. Click OK.
   A Confirm exit the configurator message appears:
   

9. Click Yes.

The board has been successfully added.

2.3 Configuring Board-Level Settings

Perform these steps to configure NMS boards using the NMS Configurator:

1. In the NMS Configurator dialog box, select the board you want to configure and click Configure Board. The Configure Board dialog box appears:
   

2. Configure the following board settings:

   Field	Setting
   Board Name	Type a name for the board.
   Board Type	Select the type of board you are configuring.
   Protocol	Select the trunk control protocol that is applicable to the board type (for example, wink start, loop start, or no call control).
   Clock Source	Select the timing source you want the board to reference.
   Line Code	Select the line encoding for your T1 trunks (digital boards only).
   Extended Super Frame	Select the frame type (digital boards only).
   Select Impedance	Select the line impedance for the board.
   TAPI Lines	Enter the number of TAPI lines the board will be using.

3. Select the Board Address Tab.
   The Board Address dialog box appears:
   

4. Configure the following board address settings:

   Field	Setting
   PCI Bus	Type the PCI Bus number that is running on the board you are configuring.
   PCI Slot	Set by the NMS Configurator based on the board that is selected. Modify this number if necessary.
   Select Board	Select the board you want to configure.
   Flash LEDs	Click this button to blink the LED for the board you are currently configuring.

5. (Optional) Select the Configuration Lines tab.
   The Configuration Lines dialog box appears. Enter free-form text in the same format used by Natural MicroSystems configuration files. Refer to the appropriate hardware installation and developer's manual for information about appropriate configuration file entries and format.
   

6. Select the Board Functions tab.
   The Board Functions dialog box appears:
   

7. Select the voice codecs you will use in your TAPI application(s). Select the boxes for the play and record functions you want to use. Select the Fax Enabled check box if you plan to use fax.

8. Click OK to exit and keep your changes.
   The NMS Configurator dialog box appears showing the updated board configuration in the Installed Boards section of the window.

9. Click OK.
   A Confirm exit the configurator message appears:
   

10. Click Yes.

The board has now been successfully configured.

Note: After moving a PCI board, you must reconfigure NMS TAPI to reflect the new PCI bus and slot numbers. For AG boards, run the following command to determine the correct bus and slot number: pciscan

For QX boards, run the following command:

qxload -cfg

2.4 Configuring System-Level Settings

The Advanced Features dialog box provides several tabs for configuring
system-level settings. This section describes how to use these tabs to specify:

• The NMS TAPI Line Configuration

• Configuration Files and Locations

• Telephony Parameters

2.4.1 Specifying the NMS TAPI Line Configuration

To specify the NMS TAPI line configuration:

1. In the Advanced System-Level Configuration dialog box, click the TAPI tab. A list of installed boards and models appears:
   
   The following table describes the checkboxes on the Advanced System-Level Configuration TAPI dialog box:

   Field	Description
   Load Board Drivers	Indicates if board drivers will be automatically loaded. A check in this box indicates that the board drivers are automatically loaded using agmon when NMS TAPI is initialized.
   Start Protocol	Indicates if start protocol will be used. A check in this box indicates the protocol will be automatically started when the lines are open.

2. Select the board you want to update and click Edit.
   The NMS TAPI Line Configuration dialog box appears:
   

3. Enter the name of the line this board will use in the Line Name field.

4. Enter the address of the line in the Line Address field.

5. Click Set Default to set the line name as the default.

6. Click OK to exit and save your changes or click Cancel to exit without saving your changes.

2.4.2 Specifying Configuration Files and Locations

Perform the following steps to specify configuration files and locations:

1. In the Advanced System-Level Configuration dialog box, click the File Names tab.
   

2. Enter a full path to (or click Browse and select) the appropriate configuration files.

2.4.3 Configuring Telephony Parameters

The NMS Configurator provides a way to configure parameters that affect telephony operations on NMS boards. For more information about NMS board default parameters (Natural Access), refer to Appendix B or to the board's installation and developer's manual.

To configure NMS TAPI parameters:

1. In the Advanced System-Level Configuration dialog box, select the Parameters tab.
   

2. Double-click on an existing parameter from the list. The Change Parameter dialog box appears.
   

3. Enter a new value for the parameter and click OK to change the parameter value or select Set Default to set the new value as the default for this parameter. To clear a parameter value, select the value and press the Delete key.
   Note: Parameter values entered through the Telephony Paramters tab in the NMS Configurator do not take effect until you restart tapisrv.exe. For information on restarting tapisrv.exe, see Section 5.1.1, Making Parameter Changes Take Effect.

Refer to Appendix B for a list of NMS board configuration parameters.

For information about the Natural Access parameters, refer to the Natural Access Developer's Reference Manual.

2.5 Testing the Configuration

To verify that the configuration you specified will work on the installed hardware:

1. In the NMS Configurator, click the Run Test button.
   The Test Configuration dialog box appears.
   

2. Click the Test Configuration button.
   Test results are displayed when the test is complete.

   WARNING:

   To run the test, NMS TAPI re-initializes the hardware. Before you run the test, make sure that no applications are using NMS hardware.

The following image shows sample test results of a successful board configuration:

The following image shows sample test results of a failed board configuration:

2.6 Verifying the Installation

To verify the NMS TAPI and NMS WAVE driver installation, run the intapi demonstration program described in Chapter 6 of this manual.

Note: If you experience problems with intapi, or if you receive error messages during installation, refer to Appendix A.

2.7 Enabling and Disabling NaturalFax for TAPI

Use the NMS Configurator to configure NaturalFax for TAPI to work with the NMS hardware on your system. You can run the NMS Configurator at any time from the telephony applet in the Windows Control Panel. NaturalFax for TAPI is enabled on a board by board basis.

To enable NaturalFax for TAPI:

1. From the Start menu, select Settings, and then Control Panel.
   The Windows Control Panel appears.

2. Double-click the Telephony icon (Windows NT users) or the Phone and Modem Options icon (Windows 2000 users) in the Control Panel.
   The Dialing Properties dialog box appears.

3. Click the Telephony Drivers tab (Windows NT users) or the Advanced tab (Windows 2000 users).
   The Telephony Drivers tab displays a list box containing the names of all TSPs available to applications.

4. Select the Natural MicroSystems Service Provider entry.

5. Click Configure.
   The NMS Configurator dialog box appears.

6. Select a board from the Installed Boards list.

7. Click OK.

8. In the NMS Configurator dialog box, click Add Board, or select a board in the Installed Boards list and click Edit Board.
   The Configure Board dialog box appears.

9. Click on the Board Functions tab.

10. In the Fax field, click the Enabled check box to enable or disable NaturalFax for TAPI for that board.

11. Click OK to exit and save your changes.