3.1 Introduction

3.2 Adding AG Configurations to the OAM Database

3.3 Configuring the System Using oamsys

3.3.1 Creating a System Configuration File for oamsys

Sample System Configuration File

3.3.2 Launching oamsys

3.4 Changing Configuration Parameter Settings

3.4.1 Board Keyword Files

3.4.2 Specifying Configuration File Location

3.5 Configuring Board Clocking

3.5.1 Clocking References

3.5.2 Fallback Clocking

3.5.3 Configuring CT Bus Clocks With AG Keywords

Configuring the Primary Clock Master

Configuring the Secondary Clock Master

Configuring Clock Slaves

Configuring Standalone Boards

3.5.4 Multiple Board System Example

3.5.5 Clocking Rules and Restrictions

3.5.6 Clocking Priority in Mixed Board Systems

3.6 Configuring Call Control Resources

3.7 Sample Board Keyword Files

3.7.1 AG Quad T Board Keyword File

3.7.2 AG Quad E Board Keyword File

3.1 Introduction

This chapter describes how to configure and start the board after the software is installed. It also provides configuration information to use when adding the boards into the OAM database.

3.2 Adding AG Configurations to the OAM Database

For OAM to be able to configure and start the boards, each board must have a separate set of configuration parameters and values in the OAM database. Each parameter and value is expressed as a keyword name/value pair (for example, AutoStart = NO). You can query the OAM database for keyword values for any component. Keywords and values can be added, modified, or deleted.

To use OAM or any related utility, ensure that ctdaemon is running. For more information about ctdaemon, refer to the CT Access Developer's Reference Manual.

The following utilities are shipped with OAM:

Utility	Description
oamsys	Performs system-wide configuration and startup of boards. Configures the OAM database based on system configuration files you supply and then attempts to start all boards listed in the database.
oamcfg	Provides greater access to individual OAM service configuration functions. For more information about this utility, refer to the OAM System User's Manual.

Note: An application can control OAM programmatically through the OAM service API. For more information, refer to the OAM Service Developer's Reference Manual.

3.3 Configuring the System Using oamsys

To configure a system using the oamsys utility:

1. Install the boards and software as described in Chapter 2.

2. Determine the PCI bus and slot locations of the boards, using the pciscan utility. The pciscan utility identifies the NMS PCI boards installed in the system, and returns each board's bus, slot, interrupt, and board type.

3. Create a system configuration file describing the board configuration. In this file, give each board a unique name and board number.

4. Use oamsys to set up records in the OAM database based on this file and to start all installed boards.
   Note: If you want to determine the location of a specific board, use blocate to associate the PCI bus assignment to a physical board by flashing an LED on the board. To flash the LED on a board, call blocate with the PCI bus and PCI slot locations.

For more information about pciscan and blocate, refer to the OAM System User's Manual.

3.3.1 Creating a System Configuration File for oamsys

Create a system configuration file describing all of the boards in your system. oamsys creates the records, and then directs the OAM service to start the boards, configured as specified.

The system configuration file is typically named oamsys.cfg. By default, oamsys looks for a file with this name when it starts up.

Refer to the OAM System User's Manual for specific information on the syntax and structure of this file.

The following chart describes the AG board-specific settings to include in the system configuration file for each AG board:

Keyword	Description	Allowed Values for AG Boards
[name]	Name of the board to be used to refer to the board in the software. The board name must be unique.	Any string, in square brackets [].
Product	Name of the board product.	· AG_Quad_T1 · AG_Quad_E1 · AG_Dual_T1 · AG_Dual_E1
Number	Board number you will use in your CT Access application to refer to the board.	Each board's number must be unique.
Bus	PCI bus number. The bus:slot location for each board must be unique.	Values returned by pciscan.
Slot	PCI slot number. The bus:slot location for each board must be unique.	Values returned by pciscan.
File	Name of the board keyword file containing settings for the board. Several board keyword files are installed with the AG software, one for each country or region.	You can create your own custom board keyword file if you wish. For details, refer to Section 3.4, Changing Configuration Parameter Settings. You can specify more than one file after the File keyword: File=mya.cfg myb.cfg myc.cfg Alternatively, you can specify the File keyword more than once: File = mya.cfg File = myb.cfg File = myc.cfg Board keyword files are sent in the order listed. The value for a given keyword in each file overrides any value specified for the keyword in earlier files.

Sample System Configuration File

The following system configuration file describes two AG Quad T1 boards, both to be configured for the United States:

[First AG Quad]
Product = AG_Quad_T1
Number  = 0
Bus     = 0
Slot    = 15
File    = agpiqt1.cfg

[Second AG Quad]
Product = AG_Quad_T1
Number  = 1
Bus     = 0
Slot    = 16
File    = agpiqt1.cfg

3.3.2 Launching oamsys

To launch oamsys, enter oamsys on the command line.

If you invoke oamsys without command line options, it searches for a file named oamsys.cfg in the paths specified in the AGLOAD environment variable.

When invoked with a valid filename, oamsys:

• Checks the syntax of the system configuration file and verifies that all required keywords are present.
  Note: oamsys checks the syntax only on the system configuration file, and not on any board keyword files referenced in the system configuration file. oamsys reports all syntax errors it finds.

• Checks for uniqueness of board name, number and bus/slot.

• Deletes all board configuration information currently stored in the OAM database (if there is any).

• Sets up the OAM database and creates all records as described in the system configuration file.

• Attempts to start all boards as described in the database.
  Note: ctdaemon must be running for oamsys to operate. For more information about the CT Access Server (ctdaemon), refer to the CT Access Developer's Reference Manual.

3.4 Changing Configuration Parameter Settings

When you run oamsys, the parameter settings specified in the board keyword files are stored in the OAM database. All boards are then started in their specified configurations.

Parameters are communicated as keyword name/value pairs: AutoStart = NO. To change a parameter setting, you can:

• Use or modify one of the sample board keyword files corresponding to your country and board type. Specify the name of this new file in the File statement in oamsys.cfg and run oamsys again. (Refer to the OAM System User's Manual for information about board keyword file syntax.)

• Specify parameter settings using the oamcfg utility. Refer to the OAM System User's Manual for information about oamcfg.

• Create a new board keyword file, either with additional keywords, or keywords whose values override earlier settings.

• Specify the settings programmatically, using the OAM service API. (Refer to the OAM Service Developer's Reference Manual for more information.)

You may wish to:

• Change which software module files are downloaded to the board at startup. Refer to Section 3.4.2, Specifying Configuration File Location for more information.

• Specify board switching (Chapter 5).

• Configure CT bus clocking (Section 3.5, Configuring Board Clocking).

3.4.1 Board Keyword Files

A sample set of board keyword files are installed by the AG installation. These board keyword files are for the USA digital protocols:

File	Description
agpiqe1.cfg	AG Quad E1
agpiqt1.cfg	AG Quad T1
qfgdpi.cfg	AG Quad T, Feature Group D protocol
qgdspi.cfg	AG Quad T, Digital Ground Start protocol
qopspi.cfg	AG Quad T, Off-Premises Station protocol
qss5pi.cfg	AG Quad T, Signaling System 5 protocol
qwnkpi.cfg	AG Quad T, Two-way Wink Start protocol
agiqt1pi.cfg	AG Quad T, ISDN
agiqe1pi.cfg	AG Quad E, ISDN

Sample board keyword files are shown in Section 3.7, Sample Board Keyword Files. These board keyword files have many keywords in common. The differences in these files are related to the protocols, whose names appear as part of the name of the file. For more information about board keyword files, refer to the OAM System User's Manual.

3.4.2 Specifying Configuration File Location

Files to be downloaded on the AG boards are specified with keywords in the AG board's keyword file. For example:

DLMFiles[0] = filename

If filename contains a path specification, OAM searches for the file in the specified directory. Otherwise, OAM searches for the file in the current working directory of ctdaemon. If the file does not exist in the current working directory, OAM searches for the file in the search path defined by the AGLOAD environment variable.

3.5 Configuring Board Clocking

When multiple boards are connected to the CT bus, you must set up a bus clock to synchronize timing between them. In addition, you can configure alternative (or fallback) clock sources to provide the clock signal if the primary source fails.

Caution:

NMS strongly recommends that you do not mix H.100/H.110 systems with MVIP systems when doing clock fallback.

Refer to Section 3.5.5 for more information about clocking rules and restrictions.

Boards in a CT bus system can be configured in one of the following modes:

Board Mode	Description
Primary clock master	Drives the primary timing reference for boards connected to the CT bus. It can switch between its two specified timing sources to maintain the primary timing reference. However, if both of its timing references fail, the primary master stops providing a timing source (and the secondary master then provides bus synchronization).
Secondary clock master	Drives the secondary timing reference. When the primary clock fails, the secondary master continues to drive the secondary clocks using a fallback clock source as its timing reference.
Clock slave	References its timing from the primary clock master and uses the secondary clock master as a fallback source of clock timing.
Standalone	Does not reference the primary or secondary master and, consequently, may not make switch connections to the CT bus.

Note: CT bus clock fallback establishes a redundant system of timing references for the CT bus. It does not create an autonomous clock timing environment. When clock fallback occurs, you must intervene to reset system clocking before the specified fallback timing references are exhausted. If all of the timing references specified for the primary and secondary clock masters fail (and no intervention takes place), the boards on the system default to standalone mode.

3.5.1 Clocking References

Boards that act as clock slaves derive their timing from signals driven by the clock masters (primary or secondary). Clock masters can drive the following reference clocks:

• A_CLOCK

• B_CLOCK

Primary clock masters can synchronize their own timing signals from the following sources:

• NETWORK

• NETREF

• OSC

Secondary clock masters are hybrid systems. Their primary timing source must be A_CLOCK or B_CLOCK. Their fallback timing source must be:

• NETWORK

• NETREF

• OSC

For further information about configuring clocks on the H.100 bus, refer to the OAM System User's Manual and to the ECTF H.100 Hardware Compatibility Specification: CT Bus R1.0.

3.5.2 Fallback Clocking

The CT bus supports a system of fallback clocking that allows the system to use alternate timing references when one or more sources fail.

To implement fallback clocking:

1. Configure a primary clock master to drive the CT bus clock (A clocks or B clocks) based on a network timing reference. All slave boards will synchronize their timing through this clock.

2. Configure a secondary clock master to use the signal from the primary clock to drive the alternate CT bus clock (in other words, if the primary master drives the A clock, the secondary master should drive the B clock based on the A clock, or vice versa).

3. Specify a fallback network timing reference for the secondary clock master to use in the event the primary clock master fails.

4. Configure all slave boards to specify the secondary clock master as their fallback clock source.

When the boards are configured in this way, the secondary clock master continues to drive the secondary clock (based on its own timing reference) if the primary clock master fails. Slave boards within the system fall back to synchronize their timing from the secondary clock master.

3.5.3 Configuring CT Bus Clocks With AG Keywords

The AG Quad board configuration keywords allow you to configure:

• The board as the system's primary clock master

• The board as the system's secondary clock master

• The board as a slave to the system's primary clock master

• Standalone boards that may be physically attached but not connected to the CT bus, but not allowed to perform CT bus switching

• Fallback sources for all the modes above

The following sections describe how to use board configuration keywords to specify clocking configurations on multiple-board or multiple-chassis systems.

Configuring the Primary Clock Master

Use the following keywords to configure the primary clock master:

Keyword	Description
Clocking.HBus.ClockSource	Specifies the source from which this board derives its timing. This should be a network source (NETREF or NETWORK).
Clocking.HBus.ClockMode	Specifies the CT bus clock that the board drives. This must reference either the A clock (MASTER_A) or the B clock (MASTER_B).
Clocking.HBus.ClockSourceNetwork	Specifies the trunk number that the board uses as an external network clocking source for its internal clock. Trunk numbering is 1-based.
Clocking.HBus.AutoFallBack	Enables or disables clocking auto-fallback on the board.
Clocking.HBus.FallBackClockSource	Specifies an alternate timing reference to use when the master clock source fails. This should be a network source (NETWORK).
Clocking.HBus.FallBackNetwork	Specifies the trunk from which a fallback network timing source (for the fallback clock reference) can be derived.

Configuring the Secondary Clock Master

Use the following keywords to configure the secondary clock master:

Keyword	Description
Clocking.HBus.ClockSource	Specifies the source from which this board derives its timing. This must be set to the clocks driven by the primary clock master. For example, if the primary master drives the A clock, this should be set to A_CLOCK.
Clocking.HBus.ClockMode	Specifies the CT bus clock that the secondary master drives. This must reference the clock (MASTER_A or MASTER_B) not driven by the primary clock master.
Clocking.HBus.AutoFallBack	Enables or disables clocking auto-fallback on the board. This should be set to YES.
Clocking.HBus.FallBackClockSource	Specifies the alternate timing reference to use when the master clock does not function properly. This should reference a network source (NETREF or NETWORK).
Clocking.HBus.FallBackNetwork	Specifies the trunk from which a fallback network timing source (for the fallback clock reference) can be derived.

Configuring Clock Slaves

Use the following keywords to configure the clock slaves:

Keyword	Description
Clocking.HBus.ClockMode	Specifies the CT bus clock that the board derives its timing from. This should be set to SLAVE to indicate that the board does not drive any CT bus clock (although the board may still drive NETREF).
Clocking.HBus.ClockSource	Specifies the source from which this clock derives its timing. This must reference the clock driven by the primary clock master.
Clocking.HBus.AutoFallBack	Enables or disables clocking auto-fallback on the board.
Clocking.HBus.FallBackClockSource	Specifies the alternate clock reference to use when the master clock does not function properly. For clock slaves, this should point to the clocks (A or B) driven by the secondary clock master.

Configuring Standalone Boards

To configure a board in standalone mode so the board references its own clocking information, set Clocking.HBus.ClockMode = STANDALONE. The board can use either its own oscillator or a signal received from a digital trunk as a timing signal reference. However, the board will not be able to make switch connections to the CT bus.

3.5.4 Multiple Board System Example

The following example assumes a system configuration where three AG Quad boards reside on a single chassis. The boards are configured in the following way:

Board	Configuration
Board 0	System primary bus master (driving the A clocks)
Board 1	System secondary bus master (driving the B clocks)
Board 2	Clock slave (auto fallback enabled)

This configuration assigns the following clocking priorities:

Priority	Timing Reference
First	Board 0, digital trunk 1. A network signal from a digital trunk provides the primary master clock source.
Second	Board 0, digital trunk 3. A network signal from a digital trunk provides the fallback clock source.
Third	Board 1, digital trunk 2. A network signal from a digital trunk provides the secondary master fallback clock source.

Figure 19 shows a multiple-board system with a primary and secondary clock master:

Figure 19. Sample Board Clocking Configuration

The following table shows keywords used to configure the boards according to the configuration show in Figure 19:

Board	Role	Clocking Keyword Settings
0	Primary clock master	Clocking.HBus.ClockMode = MASTER_A Clocking.HBus.ClockSource = NETWORK Clocking.HBus.ClockSourceNetwork = 1 Clocking.HBus.AutoFallBack = YES Clocking.HBus.FallBackClockSource = NETWORK Clocking.HBus.FallBackNetwork = 3
1	Secondary clock master	Clocking.HBus.ClockMode = MASTER_B Clocking.HBus.ClockSource = A_CLOCK Clocking.HBus.AutoFallBack = YES Clocking.HBus.FallBackClockSource = NETWORK Clocking.HBus.FallBackNetwork = 2
2	Clock slave	Clocking.HBus.ClockMode = SLAVE Clocking.HBus.ClockSource = A_CLOCK Clocking.HBus.AutoFallBack = YES Clocking.HBus.FallBackClockSource = B_CLOCK

In this configuration, Board 0 is the primary clock master and drives the A clock. All slave boards on the system use the A clock as their first timing reference. Board 0 references its timing from a network timing signal received on its own trunk 1. Board 0 also uses its own trunk 3 as its fallback clock source. This means that if the network timing signal derived from trunk 1 fails, Board 0 will continue to drive the A clocks based on trunk 3.

If, however, both of the clocking signals used by Board 0 fail, then Board 0 stops driving the A clock. The secondary clock master (Board 1) falls back to a timing reference received on its own trunk 2, and uses this signal to drive the B clock. The B clock then becomes the timing source for all boards that use the B clock as their backup timing reference.

For this to take effect, all the clock slaves must specify the A clocks as their clock source and the B clocks as their fallback clock source.

3.5.5 Clocking Rules and Restrictions

This section describes the rules and limitations that apply to setting up CT bus clocking on AG Quad boards.

When an AG Quad board is configured as the system primary clock master:

• The board's first timing reference must be set to a network trunk, Netref1, or OSC.

• The board's fallback timing reference must be set to a network trunk.

• If the board's first timing reference is Netref1 and clock fallback occurs, reconfigure the board clock as soon as possible. If the Netref1 clock is recovered, the board it will try to switch back to the first timing reference. In this case, CT bus clocking will become indeterminate. Use the Switching service to reset the primary and secondary clock masters for the system.

When an AG Quad board is configured as the system secondary clock master:

• The board's first timing reference must be the system's primary clock master.

• The board's fallback timing reference must be one of the network trunks, Netref1, or OSC.

When an AG Quad board is configured as a clock slave:

• The board's first timing reference must be the system's primary clock.

• The board's fallback timing reference must be the system's secondary clock.

• If there is no secondary clock master for the system, the board's fallback timing reference must be set to OSC. However, if clock fallback occurs, the board will be out of sync with the system until you reconfigure the board's clocking.

  Caution:

  Versions C.2 or earlier of the AG Quad board do not support clock fallback and cannot act as system secondary clock masters.

3.5.6 Clocking Priority in Mixed Board Systems

When choosing which boards that act as primary and secondary clock masters in a mixed-board system, use the following priority system:

1. AG 4000

2. AG Quad

3. AG 2000 (secondary clock master only)

For example, if a system includes two AG 4000 boards and several other NMS boards, the AG 4000 boards should be configured as the system's primary and secondary clock masters. If the system includes one AG 4000 board, one AG Quad board, and several other boards, the AG 4000 board should be configured as the system primary clock master and the AG Quad as the system secondary clock master.

Following this priority system ensures the most reliable performance when CT bus clock fallback occurs.

3.6 Configuring Call Control Resources

The DSP resources on the AG Quad board are divided into two pools. One pool of resources is dedicated to call control. The second pool is used for all other functions including voice processing and tone generation.

The AG Quad board has DSP resources for up to 60 ports for simultaneous voice or call processing. These resources are shared across all 120 call control ports. By configuring the call control resource allocation, you can control the number of ports which are guaranteed to run call control even when performing extensive voice processing.

The CCMode keyword in the configuration file specifies the ratio of DSP resources to be reserved for call control processing. Valid options are:

Call Control Mode	Description
HIGH	Allocates resources for simultaneous call processing on 50% of the trunk ports.
MEDIUM	Allocates resources for simultaneous call processing on 25% of the trunk ports.
LOW	Allocates resources for simultaneous call processing on 10% of the trunk ports.
NONE	Turns off call control resource management. Note: This is the only valid value for the AG Dual variant boards.

The AG Dual T and AG Dual E boards can perform call control simultaneously on all ports and do not require resource management. If CCMode is set to any value other than NONE for a dual variant, the board will not be initialized.

Note: Do not use the CCMode keyword at all for AG Quad Connect board configurations.

When the Quad T board is used as a Quad Dual T board with the resource management feature disabled (CCMode = NONE), all existing T1 protocols are supported. If all four T1 trunks are used, then the resource management feature must be enabled (CCMode = LOW | MEDIUM | HIGH).

The higher the CCMode setting, the fewer DSP resources will be available for voice functions. The number of ports of voice capability varies depending on the functions running and may need to be determined by consultation with NMS or through experimentation.

The following table estimates the number of voice processing ports available for the various CCMode settings:

Board	Call Control Mode (CCMode)	Simultaneous Call Control Ports	Active Voice Ports (24 K play/record & DTMF)
AG Quad T	HIGH	60	20
	MEDIUM	40	40
	LOW	20	50
AG Quad E	HIGH	60	20
	MEDIUM	40	40
	LOW	20	50

3.7 Sample Board Keyword Files

This section presents sample board keyword files. They are located in the ag\cfg subdirectory under the Natural Access installation directory. They show the set of board keywords necessary to configure and start an AG Quad board.

Note: AG Quad boards do not support echo.dsp. If you configure echo.dsp for AG Quad boards, you will see the following warning when the board boots:

Warning: Board n: File "C:\NMS\AG\LOAD\echo.dsp" is loaded but is not on any task processor.

3.7.1 AG Quad T Board Keyword File

This is the agpiqt1.cfg file:

#
#  AG configuration file for AG Quad/Dual T1
#

# TCP files are shipped with the AG CAS sub-package of Natural Access.
# Be sure that you installed the protocols that are specified below before
# trying to start a board with this configuration file.

 TCPFiles[0] = nocc.tcp           # "no trunk control" protocol
 TCPFiles[1] = wnk0.tcp           # 2-way wink protocol

# DSP files to link in

 DSP.C5x.DSPFiles = tone.dsp callp.dsp dtmf.dsp voice.dsp

 XLaw = MU-LAW

 RunFile = sysqn.run

 Clocking.HBus.ClockSource = OSC
 Clocking.HBus.ClockMode = STANDALONE

# Uncomment to use all ports for voice processing.
# CCMode = NONE


# For AG Quad (comment other "NetworkInterface" lines if used)

 NetworkInterface.T1E1[0..3].LineCode = AMI_ZCS
 NetworkInterface.T1E1[0..3].FrameType = D4

# For AG Dual (comment other "NetworkInterface" lines if used)
#
# NetworkInterface.T1E1[0..1].LineCode = AMI_ZCS
# NetworkInterface.T1E1[0..1].FrameType = D4

3.7.2 AG Quad E Board Keyword File

This is the agpiqe1.cfg file:

#
#  AG configuration file for AG Quad/Dual E1
#

# TCP files are shipped with the AG CAS sub-package of Natural Access.
# Be sure that you installed the protocols that are specified below before
# trying to start a board with this configuration file.

 TCPFiles[0] = nocc.tcp           # "no trunk control" protocol
 TCPFiles[1] = wnk0.tcp           # 2-way wink protocol

# DSP files to link in

 DSP.C5x.DSPFiles = tone_a.dsp callp_a.dsp dtmf_a.dsp mf_a.dsp voice_a.dsp

 XLaw = A-LAW

 VoiceIdleCode = 0xd5
 SignalIdleCode = 0x9

 RunFile = sysqn.run

 Clocking.HBus.ClockSource = OSC
 Clocking.HBus.ClockMode = STANDALONE

# Uncomment to use all ports for voice processing.
# CCMode = NONE

# For AG Quad (comment other "NetworkInterface" lines if used)

 NetworkInterface.T1E1[0..3].LineCode = HDB3
 NetworkInterface.T1E1[0..3].FrameType = CEPT

# For AG Dual (comment other "NetworkInterface" lines if used)
#
# NetworkInterface.T1E1[0..1].LineCode = HDB3
# NetworkInterface.T1E1[0..1].FrameType = CEPT