music on hold service guide

NN10378-113Multimedia Communication Portfolio

Media Application ServerMusic on Hold Service Guide

MCS 5100 3.5 Standard 6.0 December 2006

Media Application Server Music on Hold Service Guide

Copyright © 2006 Nortel Networks

Finding the latest updates on the Nortel web site

The content of this documentation was current at the time the product was released. To check for updates to the latest documentation and software for MCS 5100, click one of the following links:

Link to Takes you directly to the

Latest Software Nortel page for MCS 5100 software located at http://www130.nortelnetworks.com/cgi-bin/eserv/cs/main.jsp?cscat=SOFTWARE&resetFilter=1&tranProduct=12482

Latest Documentation Nortel page for MCS 5100 documentation located at http://www130.nortelnetworks.com/cgi-bin/eserv/cs/main.jsp?cscat=DOCUMENTATION&resetFilter=1&tranProduct=12482

http://support.avaya.com/supportfaqs


NN10378-113 MCS 5100 3.5 Standard 6.0 December 2006

4Copyright © 2006 Nortel Networks



How to get help

This section explains how to get help for Nortel products and services.

Getting help from the Nortel web site

The best way to get technical support for Nortel products is from the Nortel Technical Support web site:

www.nortel.com/support

This site provides quick access to software, documentation, bulletins, and tools to address issues with Nortel products. From this site, you can:

• download software, documentation, and product bulletins

• search the Technical Support Web site and the Nortel Knowledge Base for answers to technical issues

• sign up for automatic notification of new software and documentation for Nortel equipment

• open and manage technical support cases

Getting help over the phone from a Nortel Solutions Center

If you do not find the information you require on the Nortel Technical Support web site, and you have a Nortel support contract, you can also get help over the phone from a Nortel Solutions Center.

In North America, call 1-800-4NORTEL (1-800-466-7835).

Outside North America, go to the following web site to obtain the phone number for your region:

www.nortel.com/callus

http://support.avaya.com

http://www.avaya.com/gcm/master-usa/en-us/tasks/connect/contacts/sales/salescontact.htm



Getting help from a specialist by using an Express Routing Code

To access some Nortel Technical Solutions Centers, you can use an Express Routing Code (ERC) to quickly route your call to a specialist in your Nortel product or service. To locate the ERC for your product or service, go to:

www.nortel.com/erc

Getting help through a Nortel distributor or reseller

If you purchased a service contract for your Nortel product from a distributor or authorized reseller, contact the technical support staff for that distributor or reseller.




Music on Hold basics

This chapter contains the following sections:

• Overview

• Hardware platform and OS

• Services and features

• System scalability

• OAM&P

OverviewThe Music on Hold service allows a user, who receives a call and places that call on hold, to play music to the person on hold until the call is retrieved. The purpose of the music is to reassure the person on hold that the call has not been disconnected or dropped.

To activate this service, the system administrator must provision music folders containing audio files, and configure the MAS to play this music to callers of users at either the domain or sub-domain levels.

Note: Nortel does not supply any default audio files with the Music on Hold service software. It is the responsibility of the system administrator to obtain and provision the music files.

Music On Hold is enabled through the user’s service package. If a user has Music On Hold enabled, and then puts a caller on hold (end-user hold, transfer hold, or call park hold), then the caller on hold hears music. The music that the caller hears is the music that is assigned to the domain or sub-domain of the called party.

If the user does not have Music On Hold enabled through their service package, and receives and places a call on hold, then the person on



hold does not hear music. This is true even if music is assigned to the domain or sub-domain of the called party.

Hardware platform and OSFor the Music on Hold service, the Media Application Server hardware platform varies, depending on the individual requirements of the network. For smaller deployments, the MAS platform is an IBM xSeries 336 (or 335) rack optimized server. For larger deployments, the platform is an IBM eServer BladeCenter or BladeCenter T chassis with the IBM HS20 blade servers.

Note 1: The IBM xSeries 336 server replaces the IBM xSeries 335 server; however the 335 server is still supported and you should consider these two servers to be interchangeable as MAS platforms.

Note 2: You must use the IBM xSeries 336 (or 335) for multi-application MAS deployment.

The Restriction of Hazardous Substances (RoHS) directive applies to hardware in the European Union (EU) and the European Economic Area (EEA). New hardware that is RoHS compliant, and hardware that is converted to be compliant, function the same way and support the same software as non-compliant hardware. RoHS-compliant hardware is backwards compatible. The HS 20 Blade Servers in RoHS-compliant units are identical in form, fit, and function to the blades in non-compliant units. Individual components

ATTENTIONYou (the system administrator) may wish to disable the Music on Hold service for a user that typically connects to non-Multimedia Communication Portfolio (MCP) hosted conferences (time division multiplex, or third-party SIP conferences.)

The Music on Hold service software is able to detect when an MCP user is connected to a Media Application Server-based conference. If this happens, the Music on Hold service does not play music if a caller is placed on hold by one of the conference participants.

However, if an MCP user dials into a non-MCP hosted conference, such a user may place one of these TDM or third-party SIP conference participants on hold thus triggering music to be played to the on-hold participant (as well as everyone else on the conference bridge). In this case the Music on Hold service does not automatically determine that music should not be played.



in the non-RoHS eBladeCenter hardware are not interchangeable with the RoHS-compliant BladeCenter T. Most RoHS-compliant units have a modified product equipment code (PEC) or a modified Common Language Equipment Identifier (CLEI) to indicate that unit is RoHS-compliant.

IBM xSeries 336 hardwareThe following figure shows a rack-mountable IBM xSeries 336 server.

Figure 1 IBM xSeries 336 server

The required IBM xSeries 336 hardware configuration and operating system for the Media Application Server is listed in the following table.

IBM eServer BladeCenter hardwareThe IBM eServer BladeCenter is a 7U high chassis, which provides slots for up to 14 IBM HS20 blade server host boards. Also included is a CD-ROM/floppy module that is accessible to all 14 slots for any local software installation that might need to be done. This unit is powered by 220 volt (200 to 240 Vac) hot-swap power modules. The following figure shows a rack-mountable IBM eServer BladeCenter chassis.

Description Quantity

3.6 GHz Intel Xeon CPU 2

Preloaded Windows 2000 Server (operating system) 1

1 GB RAM 1

73 GB Integrated Single Channel SCSI Hard Drive 1

Gigabit Ethernet Interface 2



Figure 2 IBM eServer BladeCenter

The IBM HS20 blade server provides a dual Intel Xeon processor, 4 DIMM slots, for up to 4GB of RAM, space for two IDE hard disks, a connector to an optional SCSI expansion module, and dual gigabit ethernet network interfaces.

IBM eServer BladeCenter-T hardwareThe IBM eServer BladeCenter-T is a rack-mounted, high-density, high-performance blade-server system developed for NEBS telecommunications network applications and other applications requiring additional physical robustness. The following figure shows the front of the BladeCenter-T.

Figure 3 IBM BladeCenter-T

The BladeCenter-T( BCT) unit supports up to eight Blade servers. The BCT unit provides common resources that are shared by the Blade servers, such as power, cooling, system management, network connection, backplane and input/output (CD-ROM drive and connectors for USB, keyboard, video, mouse, and network interfaces).



IBM HS20 blade serverThe following figure shows an IBM HS20 blade server. The figure shows the IBM HS20 blade server with the protective metal cover removed.

Figure 4 IBM HS20 blade server

Several variants of the HS20 Blade server are supported:

• HS20 Blades (Nortel PEC NTVW01CG)

— 1 Gbyte RAM

— 40 Gbyte 540 RPM EIDE hard drive

— supports the HS20 SCSI Storage Expansion Unit

• HS20 SCSI Storage Expansion Unit (NTVW01CH)

• HS20 Blade (NTVW01CL)

— 1 Gbyte RAM

— 73 Gbyte 10,000 RPM SCSI hard drive

— does not support the HS20 SCSI Storage Expansion Unit

• HS20 Blade (NTVW01CV)

— 2 Gbyte RAM

— 73 Gbyte 10,000 RPM SCSI hard drive

— does not support the HS20 SCSI Storage Expansion Unit

When using the NTVW01CG Blade, the Media Application Server uses two distinct configurations of the IBM HS20 blade server to provide service to the network: a single-slot node and a dual-slot node.



The following table shows the required IBM HS20 NTVW01CG blade server hardware configuration for a Media Application Server single-slot node.

The following table shows the required IBM HS20 NTVW01CG blade server hardware configuration for a Media Application Server dual-slot node.

When using the NTVW01CL and NTVW01CV Blades in the BladeCenter or BladeCenter-T, only one slot is required for simplex or duplex operation.


2.8GHz Intel Xeon CPU (w/ 533MHz FSB) 2

Windows 2000 Server 1

1GB RAM 1

40GB 5400RPM EIDE hard drive(for booting, application store, and data store)

1

1000 Mbps channel to the chassis backplane for connectivity to Ethernet Switch Modules

2


2.8GHz Intel Xeon CPU (w/ 533MHz FSB) 2

Windows 2000 Server 1

1GB RAM 1

40GB 5400RPM EIDE hard drive(for booting)

1

Dual SCSI Expansion Unitwith on 73GB Ultra-320 SCSI hard drive

1

1000 Mbps channel to the chassisbackplane for connectivity to EthernetSwitch Modules

2



Services and featuresThe features of the Music On Hold service are described in the following list:

• is available for calls on End-User Hold, Transfer Hold, and Call Park Hold

• supports continuous music—the music does not restart from the same point for each new call on hold

• allows for chained music files—you can specify more than one music file to be played.

• can be configured to operate at the domain or sub-domain levels

• is enabled through service packages

• supports the Microsoft Wave file audio format (single channel (mono) linear 16-bit PCM sampled at 8 kHz)

• automatically normalizes the amplitude of the media (music files) to raise or lower the amplitude as soon as the files are placed on the Music on Hold Media Application Server

• does not support external media sources—all media source files must be resident on the Music on Hold Media Application Server

• generates accounting information consisting of the duration and type of media file that is played

• allows an administrator to swap the standard in-service media files with media files that are in reserve on the MAS, by means of the Provisioning Client

• supports a redundant configuration

Note: For the multi-application MAS deployment only the simplex architecture is supported.

• supports the streaming of music through a gateway to an on-hold caller who is located on the public switched telephone network, or a private branch exchange

• generates performance data

RTCP SupportThe Music on Hold service supports reception and generation of Real-Time Transport Control Protocol (RTCP) Sender reports.

The Music on Hold service transmits RTCP packets to each participant, detailing the perceived quality of the session from the service perspective.



QoS supportThe Music on Hold service supports Differentiated Service (DiffServ) packet marking on outgoing Real-Time Transport Protocol (RTP) streams. The Media Application Server framework sets the DiffServ Control Point (DSCP) to expedited forwarding (EF), which is a widely supported indicator for QoS enabled networks.

Network routers that are QoS enabled, examine the DSCP information in a packet, and provide priority (with respect to routing and handling) to those packets marked with expedited forwarding. Routers drop generic data packets when overloaded before they drop DiffServ marked packets. The Music on Hold service strategy follows RFC 2598, which designates the EF bit pattern.

The Media Application Server platform uses QoS packet scheduling to reserve 70 percent of all available network bandwidth to voice traffic and gives a higher priority to voice traffic packets, delivering them to the network first.

System scalabilityThere are currently two hardware platforms for the Music on Hold service:

• IBM xSeries 336 (or 335)

• IBM HS20 Blade servers (single or dual slot) on an IBM eServer BladeCenter or BladeCenter T

Note: The IBM xSeries 336 server replaces the IBM xSeries 335 server; however the 335 server is still supported and you should consider these two servers to be interchangeable as MAS platforms.

For smaller deployments, you use the IBM xSeries 336 (or 335) platform. You have two deployment options for this platform:

• the single application deployment consisting of the Music on Hold service, and (optionally) the Announcements service

• the multi-application MAS deployment consisting of up to five MAS services (Music on Hold, Ad Hoc Audio Conferencing, Meet Me Audio Conferencing, or Meet Me Premium Audio Conferencing, Announcements and IM Chat)

Note: The multi-application MAS configuration supports up to 250 subscribers (in a domain or sub-domain). This configuration is standalone only, and does not support pooling of ports across other MAS.



Table 1 shows the defined port limits for the five MAS services in the multi-application MAS deployment. These port restrictions are fixed, and do not change if for example, you only install three of the five services.

For the higher density deployments of the Music on Hold service, you use the IBM HS20 Blade Servers within the IBM eServer BladeCenter or BladeCenter T chassis.

Several variants of the HS20 blade server exist. The NTVW01CG blades support the Dual SCSI expansion unit, which is required for additional storage in duplex mode. The NTVW01CL and NTBW01CV HS20 blades do not require additional storage and can be used for simplex or duplex mode. The requirements are shown in the following table.

For the single-application deployment of the IBM xSeries 336 (or 335), and for the IBM HS20 blade server, the maximum number of simultaneous Music On Hold users is limited only by the number of

Table 1 Port limits for Multi-application MAS services

Service Number of ports

Ad Hoc Audio Conferencing 20 (G711 or G.729)

Meet Me Audio Conferencing or Meet Me Premium Audio Conferencing

60 (G711 or G.729)

Music on Hold 20 (G711 or G.729)

Announcements 20 (G711 or G.729)

IM Chat 30

HS20 Blade Mode Requires the expansionunit?

Number of slots

NTVW01CG simplex yes 2

NTVW01CG duplex yes 4

NTVW01CL orNTVW01CV

simplex no 1

NTVW01CL orNTVW01CV

duplex no 2



channel licenses purchased, and the capacity of the scaled system. Ports are allocated on a first-come, first-served basis until the license keys are exhausted, or available capacity is exceeded.

The Music on Hold service takes advantage of the Media Application Server platform’s scalable, multiple server capabilities and makes use of the Media Application Server’s replicated persistent content storage for storing media source files that are used for Music On Hold. There are a maximum of two active content storage components in Music On Hold service instance (pooled entity).

Note: The multi-application MAS deployment is a simplex standalone architecture that does not support pooling of ports across more than one MAS.

The Media Application Server platform can scale from a small single-machine solution to a large multi-machine cluster. The Media Application Server provides scalability across multiple machines through system-level replication. New Media Application Servers may be added to the pool of servers at any time to meet expanding capacity requirements. Each new server must be added to the Pooled Entity at using the Provisioning Client before user traffic will be routed to it.

The available Media Application Server scaling options are

• Simplex: One Media Application Server within one service instance. There is one active content storage component for the media source files. (See Figure 5.)

Note: You must use the simplex architecture for the multi-application MAS deployment.

• Duplex: Two Media Application Servers in one service instance. There are two active content storage components, which are active reflections of each other. These two content storage components provide storage redundancy for the media source files. (See Figure 6.)

The following figures show network diagrams for the various Media Application Server scaled configurations.



Figure 5 Simplex Media Application Server configuration

Figure 6 Duplex Media Application Server configuration

For the Music on Hold service, a pooled entity is made up of one-to-two Media Application Servers. This Pooled Entity is considered one service instance (when the Sip Application Modules are included).

The capacity of a service instance can be increased by adding more Media Application Servers to the pooled entity. You can add a maximum of two Media Application Servers for each Music on Hold pooled entity. You can also increase the capacity of a service by increasing the number of pooled entities in the network. This type of scaling is required when you require more capacity (storage or processing) than can be achieved using one pooled entity.

Note: The capacity of the multi-application MAS cannot be increased by adding more servers (MAS) to the pooled entity. For the



multi-application MAS deployment you must use only one server (simplex).

Your network may contain multiple service instances, of the Music on Hold service, that are separated by considerable distance. If this is true, you will want to avoid the cost of backhauling to a remote service instance when one is available locally. You can ensure that local service instances are always used, by assigning service packages to sub-domains.

Note 1: For more information on setting up sub-domains and assigning service packages to sub-domains, see Provisioning Client User Guide (NN42020-105).

Note 2: For the multi-application MAS deployment, multiple service instances are not supported.

Figure 7 gives a high-level view of how a sub-domain can be mapped to a group of users, and to a local service instance (pooled entity).

Figure 7 Using sub-domains to map users to local service instances

Figure 8 shows a network diagram for a scaled Media Application Server configuration using multiple service instances.



Figure 8 Multiple service instances

OAM&PThe Media Application Server builds directly into the Microsoft Management Framework (Win2K/NT5 platform) to expose logs and operational measurements using built-in features of the operating system. The Microsoft Management Console (MMC) provides access to components and utilities (called Snap-ins) embedded in the Operating System that can be used to build a custom management console.

The Media Application Server integrates seamlessly with the MMC to provide logs, alarms, operational measurements, monitoring, reporting and service management.

The MAS Console is the tool that you use for managing the MAS. The MAS Console software runs on the MAS platform. You access the MAS Console software remotely from your own PC using the Microsoft Terminal Services Advanced Client (TSAC).

• •

•

Service

Service

(Pooled Entity)

Instance 1

(Pooled Entity)Instance n



In addition, you have the option of sending MAS alarms to a third-party management console for viewing. Also, you may choose to view MAS logs on one or more remote SysLog servers.



Upgrades

This chapter provides information about Music on Hold service upgrade procedures. For complete information on installing and configuring the Music on Hold service on a Media Application Server, please refer to Appendix B, Music on Hold service Installation Guide, on page 125.

General information relating to MAS software upgradesUpgrades are performed using many of the same procedures as those used during installation. However, the order of the procedures is slightly different for upgrades.

Note: Configuration data is preserved during the upgrade.

The Music on Hold service is installed using an intuitive InstallShield™ installation program. For every new release, or patch release of the Music on Hold service executable, a new installation program is created. During an upgrade, the installation program will stop the current Music on Hold service instance, replace its executable, and restart the Music on Hold service instance again.

Note: Patch releases are cumulative, the latest patch bundle installation program will contain all previous patches.

During a Media Application Server framework upgrade, the Music on Hold service running on the targeted Media Application Server becomes temporarily unavailable in the network. This Music on Hold service becomes available once the service is restarted (upon successful restarting of the Media Application Server framework).

In scaled networks, continuous access to the Music on Hold service during upgrades is achieved by performing Media Application Server upgrades one server at a time. Prior to upgrading an instance of the Music on Hold service, or of the Media Application Server that instance is running on, the service is set to Pending Lock. While the service is in the pending lock state, all new Music on Hold service requests are rejected by this instance, and are routed to one of the remaining in-service Music on Hold service instances (located on different Media



Application Servers). Existing Music on Hold traffic on the Media Application Server to be upgraded can be allowed time to clear on its own, as Music on Hold sessions end.

Once the target Media Application Server has no more (or an acceptable minimal amount of) active traffic on it, the service is set to Lock. Once locked, the Music on Hold service (and/or the Media Application Server hosting that service) can be upgraded. After the upgrade is complete, the service can be restarted and unlocked. Once the service is unlocked, incoming Music on Hold service requests can be handled by the Media Application Server, instead of being routed to another Music on Hold service running on a different Media Application Server.

It is recommended that upgrades be performed during the maintenance window, or at some other off peak usage time. Locking the upgrade target service instance several hours prior to the actual maintenance window helps ensure that a minimum number of Music on Hold sessions, if any, will still be present on the upgrade target when the service is actually upgraded during the maintenance window.

Supported software upgrade pathsThe following software upgrade paths are supported for the MAS Music on Hold service:

• Release 3.0 to 3.5

• Release 3.0 (single application MAS) to 3.5 Multi-application MAS

CAUTIONTemporary loss of serviceA software upgrade of the simplex architecture results in a service outage. The service outage period of time is under five minutes. There is no service outage during a software upgrade of the duplex architecture.



Release 3.0 to 3.5 software upgrade proceduresFigure 9 outlines the procedures used to upgrade the Music on Hold service from the 3.0 to 3.5 release.

Note 1: In addition, use the procedures outlined in Figure 9 for any 3.x to 3.x software maintenance releases (MR) involving the upgrade of the Music on Hold service.

Note 2: This document only contains procedures relating to the Music on Hold service. If the MAS server to be upgraded also contains the Announcements service, then see the Upgrade Chapter in the MCS 5100 Announcements Service Guide for the appropriate procedures for installing and uninstalling the Announcements service software.

(See Figure 10 for the procedures to upgrade to the Multi-application MAS deployment.)



Figure 9 Music on Hold 3.0 to 3.5 upgrade flowchart

Put MAS inPending Lock

state:Procedure B-20

on page 221

Check for Active Sessions:

Procedure B-23 on page 227

Lock theMAS system:


Deactivate theMAS system:


Uninstall Music On Hold service software:


Note: If Announcements service software is also on this MAS, then uninstall it as well (see the

Upgrade chapter in the Announcements Service Guide for the appropriate procedure.

Uninstall MAS platform software:Procedure B-27

on page 231

Install MAS platform software:Procedure B-5 on page 180

Install Music On Hold

service software: Procedure B-6 on page 188. If required, install Announcements service software

using the appropri-ate procedure.

Activate MASservice:


Unlock theMAS system:


Are you

No

Yes

software as well as the

upgrading the

Music on Hold service

MAS platform

software?

1

1

End



Multi-application MAS upgrade proceduresThis section outlines the supported upgrade paths and software upgrade procedures for the Multi-application MAS deployment. The underlying assumption is that you are upgrading a MAS server with the Music on Hold service to a Multi-application MAS server. The Multi-application MAS deployment enables you to install the following MAS services on the same MAS platform:

• Ad Hoc Audio Conferencing service

• Meet Me Audio Conferencing service

• Music on Hold service

• Announcements service

• IM Chat service

Release 3.0 to release 3.5 multi-application MAS software upgradesThe flow chart in Figure 10 outlines the procedures used to upgrade the software on a MAS platform from the 3.0 release (single application MAS) to the 3.5 release Multi-application MAS deployment.

Note: To perform a 3.5 Multi-application MAS maintenance release (MR) use the flowchart in Figure 10. All the steps are the same for an upgrade and an MR, except for one: When you are told, in the flowchart, to uninstall the Music on Hold service software (Procedure B-25 on page 230), in addition, you must also uninstall all the other MAS services (one after another) that are part of the Multi-application MAS deployment. You must use the procedures in the appropriate MAS service guides to do this. (Check the Upgrades chapter in each MAS service guide for the uninstall and install procedures.)

ATTENTIONFor the Multi-application MAS deployment you can install from two to five MAS services on the same MAS platform; however, in order to simplify the explanation, this document assumes that you are installing all five MAS services. You may install the five MAS services in any order.

The actual procedure for installing each MAS service is found in the respective MAS service guide. For example, the Announcements procedures are found in the Announcements service guide, IM Chat procedures are found in the IM Chat service guide, and so on. (Check the Upgrades chapter in each service guide for the right procedure.)



Figure 10 Release 3.0 to 3.5 Multi-application MAS software upgrade flowchart

Put MAS inPending Lock

state:Procedure B-20

on page 221

Check for Active Sessions:


Lock theMAS system:


Deactivate theMAS system:


Uninstall Music On Hold service software:


Note: If Announcements service software is also on this MAS, then uninstall it as well (see the

Upgrade chapter in the Announcements Service Guide for the appropriate procedure.

Uninstall MAS platform software:Procedure B-27

on page 231

Install MAS platform software:Procedure B-5 on page 180

Install Music On Hold

service software: Procedure B-6 on page 188.

Activate MASservice:


Unlock theMAS system:


Are you

No

Yes

software as well as the

upgrading the


MAS platform

software?

1

1

End

Install Ad Hoc, Meet Me,

Announcements, and IM Chat ser-

vice software (one after the other).



Fault management

This chapter provides information on the following topics:

• MAS fault management strategy

• Viewing alarms on the MAS Console

• MAS alarms

• Viewing logs on the MAS Console

• MAS logs

• Viewing MAS alarms on a third-party management console

• Viewing MAS logs on SysLog servers

MAS fault management strategyThe MAS platform software is configured as an operating system service (NT service) that is started and monitored by the operating system (OS) automatically. If any MAS platform software subcomponent fails, the OS restarts the component immediately and a log is generated. An alarm is also raised to report this condition until the component is registered with the remainder of the system, at which point the alarm is cleared.

The Media Application Server (MAS) generates alarms in response to fault conditions that degrade or interrupt operation of the service. In general, MAS alarms may require you to take action to correct the fault condition. MAS services rely on the MAS platform software to provide alarm generation mechanisms.

After you, or the system, have corrected a fault, the MAS software automatically clears the alarm condition. All alarms are logged, and a second log is generated to record the new status once an alarm is cleared.

The MAS platform software also provides an event logging mechanism. The event logging mechanism is a standardized and centralized way to report relevant software and hardware events.



You have three options for viewing MAS alarms and logs:

• the MAS Console

• a third-party management console such as HP OpenView® (for viewing alarms)

• SysLog server (for viewing MAS logs)

Viewing alarms on the MAS ConsoleThe MAS Console is the primary tool for managing the MAS. The MAS Console software runs on the MAS platform. You access the MAS Console remotely from your own PC (see Figure 11) by using the Microsoft Terminal Services Advanced Client (TSAC).

Figure 11 Remote access to the MAS Console

User interface on the MAS ConsoleThe MAS Console provides a number of graphical elements in the interface. The most important of these, from a Media Application Server perspective, are the console tree and the details panel (see Figure 12). Located below the standard console menus and toolbar in the MAS Console are two panels. The panel on the left contains the console tree,

Network

RemoteDesktopProtocol

System Administrator’s PC



and the panel on the right displays the details of the selected node in the console tree. Together, these two panels form the namespace.

Note: The MAS platform hardware configuration and network topology affects the visual appearance of MAS console; therefore the appearance of your MAS Console may be different from what is shown in the illustrations in this document.

Figure 12 MAS Console GUI

The console tree contains the snap-in nodes that make up the management console tree tool. For the currently selected node in the console tree, the details panel contains the child nodes, information about the node, or a user interface to perform a task on the node (See Figure 12).

The MAS Console is composed of a console tree containing the following snap-in components and utilities:

• Counters and Gauges

• Event Viewer (Local)

Toolbars

Details panelConsole tree



• Performance Logs and Alerts

• Disk Management (Local)

• Active Sessions

• Configuration

• Control Panel

MAS subcomponents viewed on the MAS ConsoleThe Media Application Server contains the following internal subcomponents:

• Multimedia Conductor is a SIP user agent that provides a network signaling endpoint for accessing platform services.

• Multimedia Controller provides system monitoring capabilities and hosts multiple service execution environment.

• Interactive Voice Response (IVR) Media Processor provides media processing functions such as DTMF detection, announcements and prompts, and recording.

• Conference Media Processor provides conference media processing functions such as audio mixing, active speaker detection, voice activity detection, automatic gain control and more.

• Multimedia Content Store provides reliable content storage and related capabilities.

• Stream Source provides channel-based continuous audio streaming for music on hold and other related functions.

Each internal subcomponent executes a simple-state machine:

The overall state of the Media Application Server is an aggregation of the individual states of these internal subcomponents. Therefore in order to monitor the health of the system, it is necessary to monitor the health of its constituent parts.

OFFLINE

Stop

Start

OfflineOfflineOnlineOnline



The Media Application Server internal subcomponents are each configured as a service that is started and monitored by the operating system automatically. If a Media Application Server internal subcomponent fails, then the OS immediately restarts the subcomponent and generates a log to report the event. In addition, an alarm is raised until the subcomponent recovers, at which point the alarm is cleared.

Subcomponent status on the MAS ConsoleEach internal subcomponent of the Media Application Server provides indicators designed to provide a real-time “at a glance” view into the current state of the system. Each internal subcomponent can occupy either of the following states:

Monitoring subcomponents on the MAS ConsoleComponent monitoring is provided by the control panel snap-in located in the Media Application Server Console's tree. The control panel is used to monitor and control internal subcomponent (and, by implication, the entire Media Application Server) movement between these states.

Component monitoring capabilities consist of visual cues and textual information that convey the system’s operational status. Visual cues appear in the details panel as icons associated with each internal subcomponent. For example, the Conference Media Processor may either be online:

or offline

Textual information is also provided as to the state of each subcomponent in the Status column located in the details panel. The status of each subcomponent is identified in this field as Online or Offline.

Online: The component is running normally.

Offline: The component is disabled.

Conference Media Processor

Conference Media Processor



The final piece of subcomponent status is provided in the Alarm column of the details panel where the highest severity alarm is displayed (if available).

Procedure 1 Viewing the state of the MAS platform and subcomponents

From the MAS Console

1 Select the Control Panel snap-in icon in the console tree pane. The details panel displays the current status of the Media Application Server.

2 View the individual MAS subcomponents by right-click on the Control Panel snap-in icon and selecting View System Components.

Status for the MASStatus, state, and alarm severity information



3 You have completed this procedure.

Alarm severity on the MAS Console The Control Panel snap-in, located in the MAS Console tree (see the previous figure), allows the user to toggle between the following two types of views:

• The Service view shows an overall system display of the software providing a single point at which to aggregate the status and management of all subcomponents.

• The Component view shows each internal subcomponent, allowing users the ability to individually monitor subcomponents.

Note: Starting and stopping of individual subcomponents is not allowed. The MAS platform subcomponents are configured to restart automatically (and immediately) by the operating system if they should fail.

In the course of monitoring the system and managing the service it may be necessary to take advantage of both of these views.

Active alarms are displayed in the Media Application Server Console Control Panel (under the Alarm columns). As well, every occurrence of an alarm (and its subsequent clearing) is recorded as a logged event that is viewable in the Event Viewer.



Both the Service and Component views support the same columns or fields of information as follows:

• Status:

— Offline: The service is stopped.

— Online: The service is started.

• State:

— Unlocked: The service is accepting traffic.

— Pending Lock: The service is preserving existing traffic, but is rejecting new traffic.

— Locked: The service is not accepting new traffic.

• Alarm Severity: This field indicates the severity of the service's highest active alarm.

— Normal: The service status is Online and there are no active alarms.

— Critical: A critical problem is identified.

The system is not processing calls.

The Critical severity indicates that a service-affecting condition has occurred, and an immediate corrective action is required. Such a severity can be reported, for example, when a resource becomes totally out of service, and its capability must be restored. The user should check the logs immediately and begin diagnostics.

— Major: A major problem is identified.

The system is still processing calls.

The Major severity level indicates that a service-affecting condition has developed, and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the resource, and its full capability must be restored. The user should check the logs for details.

— Minor: A minor problem is identified.

The system is still processing calls.

The Minor severity level indicates the existence of a non-service-affecting fault condition and that corrective action should be taken in order to prevent a more serious, possibly service-affecting fault. Such a severity can be reported, for example, when the alarm condition is not currently degrading the



capacity of the resource.The user should check the logs for details.

— Unavailable: The service status is Offline.

• Alarm Name: This field shows a descriptive name for the active alarm with the highest severity.

— Example Name: LicenseKeyNot Found

— Normal: The service status is Online and there are no active alarms.

— Unavailable: The service status is Offline.

Viewing alarm status on the MAS ConsoleThe Control Panel snap-in provides a quick view of the running status of the internal subcomponents and the Media Application Server system as a whole. Both alarm severity and the alarm name are displayed in the details panel.

If a component has uncleared alarms, the panel will indicate the most severe of the alarms. The actual alarm is not displayed through this mechanism, only a visual indicator that should prompt the administrator that there is something of interest occurring. The administrator can then browse the Event Viewer snap-in for logs reporting the alarm event to gather more information.



Procedure 2 Viewing alarm logs on the MAS Console

From the Media Application Server Console

1 To view the alarms under Event Viewer in the Console tree, click Application. The Application logs appear in the details panel.

2 Check the Category column for alarms.

3 Double click on the alarm entry n the details panel.

The Event Properties dialog opens.

Note: The Event Properties dialog contains the following event fields: Data Source, Time, Category, Type, Event ID, Computer, User, and Description. If the event is an alarm, then the Description field contains information about the alarm, and should indicated any actions that you need to take to correct the problem.


Event logging on the MASThe Media Application Server provides an event-logging mechanism as a standardized and centralized way for applications (and the operating system) to report relevant software and hardware events.

Events logged by the Media Application Server are time stamped and grouped under the category Media Application Server. This grouping facilitates easy filtering by built-in event viewer features. The source identifies the Media Application Server internal subcomponent that generated the event. The source should not be confused with the machine that generated the log. The machine that generated the log is identified in the Computer field of the event.

There are three types of event logs:

The Media Application Server can automatically archive and rotate logs as needed.

Information

Warning

Error



When an error occurs, you must

• determine what caused the error

• attempt to recover any lost data

• prevent the error from recurring

You can use the event log to help determine the context and conditions that caused the error. By periodically viewing the event log, you may be able to identify problems before they result in damage.

Note: For information on viewing event logs, see the MAS Console Event Viewer, and Procedure 3 Viewing MAS Application logs.

MAS alarmsCurrently, there are thee categories of MAS alarms:

• MAS provisioning alarms

— MAS 102 alarm

— MAS 103 alarm

— MAS 504 alarm

— MAS 701 alarm

Note: MAS provisioning alarms are generated by the Provisioning Module.

• Multimedia Controller alarms

• Multimedia Content Store Alarms



MAS provisioning alarmsThese alarms may occur while you are provisioning the MAS using the Provisioning Client.

The MAS 102 alarm is raised when the Provisioning Module is unable to communicate with the database. The Provisioning Module continues to attempt to connect to the database at regular intervals and clears the alarm when communication with the database has resumed.

MAS 102 alarm

Family Name: MAS/MEDAPSVR

Alarm Name: Database Communication Error

Alarm ID: MAS102

Category: Communication

Severity: Critical

Description: The following problem text appears while you are provisioning the MAS using the Provisioning Client:

“Media Application Server (MAS) Provisioning Module cannot communicate with database. If there are any pending transactions in the database, those may not be processed correctly. As a result, subscriber data on the MAS may not be current.”

Corrective Action: 1) Ensure that there is network connectivity between the Web server and the database. 2) Ensure that the database is up and running. 3) If the problem persists, contact your next level of support.

Note: This alarm clears when the database connection is re-established.



The MAS 103 alarm is raised when the Provisioning Module is unable to communicate with one of the Media Application Server(s) configured in the system. The Provisioning Module continues to attempt to connect to the MAS with which it has lost communication, and clears the alarm when the connection is restored.

MAS 103 alarm


Alarm Name: Media Application Server Unreachable

Alarm ID: MAS103

Category: Communication

Severity: Critical


“The connection with the Media Application Server has been lost. As result the subscriber data on the MAS may not be current. Details of the MAS and the affected domains are as follows: <IP Address of the MAS, and the list of domains and the pooled entities for which that MAS has been configured.>”

Corrective Action: 1) Use the Provisioning Client to verify that the IP addresses of the MAS are configured correctly in the pooled entities assigned to the domains. 2) Verify that the configured Media Application Server(s) are up and running. 3) Verify that there is network connectivity. 4) If the problem persists, contact your next level of support.

Note: This alarm clears when the connection with the MAS is re-established.



The MAS 504 alarm is raised when the number of pending transactions in the database exceeds 100,000. These transactions correspond to the subscriber information that needs to be updated on the corresponding Media Application Server (MAS). This alarm indicates that the subscriber information on the MAS is not up to date. The transactions are processed periodically by the Provisioning Module and the alarm is cleared when the number of pending transactions falls below the upper threshold.

MAS 504 alarm


Alarm Name: Pending Transactions Table Size Exceeded Error

Alarm ID: MAS504

Category: Threshold

Severity: Warning


“The number of pending transactions corresponding to the subscriber data stored on the Media Application Server (MAS) has exceeded the upper threshold. The subscriber data on the MAS may not be current. The number of pending transactions are <a numeric value greater than 100,000 appears here indicating the number of pending transactions in the database when the alarm is raised>”

Corrective Action: 1) Verify that there is network connectivity between all the Media Application Server(s) and the Web server. 2) Verify that all the configured MAS(s) in the system are up and running.3) Verify that there are no other MAS provisioning alarms in the system.4) If the problem persists, contact your next level of support.

Note: This alarm clears when the pending transactions are processed successfully, and deleted from the pending transactions table.



The MAS 701 alarm is raised when any error is encountered during the initialization of the Provisioning Module. This alarm is cleared by a Web server restart.

Multimedia Controller alarmsTable 2 displays alarms that the Multimedia Controller (MediaController) subcomponent generates.

MAS 701 alarm


Alarm Name: MAS Prov Manager Initialization Error

Alarm ID: MAS701

Category: Abnormal

Severity: Critical


“A Media Application Server (MAS) Provisioning Module initialization error has occurred. Provisioning changes affecting subscribers with MAS services will not be reflected on the associated MAS.”

Corrective Action: Contact your next level of support.

Note: This alarm clears once the problem is fixed and after the next restart of the Web server.

Table 2 Multimedia Controller (MediaController) alarms (Sheet 1 of 2)

Name Severity Description

PendingConnections Minor This alarm indicates that all initial connections upon startup are being established. This alarm will be activated at every MediaController initialization and will be deactivated once all the connections are established.

G711LicenseThreshold Minor This alarm indicates that the G711 license counter is getting close to exhaustion. As the licenses are released, this alarm will be cleared.



G729LicenseThreshold Minor This alarm indicates that the G729 license counter is getting close to exhaustion. As the licenses are released, this alarm will be cleared.

MissedHeartbeats Minor This alarm indicates that the MediaController is having some difficulty communicating with a particular process.

G711LicenseExhausted Major This alarm indicates that all G711 licenses for the adhocAudioConf service have been exhausted. This alarm will be cleared when licenses become available.

G729LicenseExhausted Major This alarm indicates that all G729 licenses for the adhocAudioConf service have been exhausted. This will be cleared when licenses become available.

LicenseKeyNotFound Major This alarm indicates that the MediaController could not find the license key. The MediaController will not process calls without a valid license key.

ConnectionsLost Major This alarm indicates that the MediaController has lost connection with one or more MediaServer components.

InvalidLicenseKey Major This alarm indicates that the license key provided to the MediaController was invalid. A corresponding log is generated that gives more detail as to the error.

InitialConnectionFailure Critical This alarm is used in conjunction with the PendingConnections alarm. This is raised if the initial MediaController connections cannot be made after a few initial attempts. The alarm is cleared once the connection is established.

Table 2 Multimedia Controller (MediaController) alarms (Sheet 2 of 2)




Multimedia Content Store AlarmsTable 3 displays alarms that the Multimedia Content Store (CStore) subcomponent generates.

Viewing logs on the MAS ConsoleThe MAS uses an event-logging mechanism for applications, and the operating system to report relevant software and hardware events. Events logged by the MAS are time stamped and grouped under the category “Media Application Server.” Events are viewed on the MAS Console using the Event Viewer. There are several categories of events such as logs, alarms and events that provide general information.

Events logged by the MAS are time stamped and grouped as “MediaServer” events. This grouping facilitates easy filtering using built-in event viewer features. Logged events also identify the MAS

Table 3 Multimedia Content Store (CStore) alarms


Mirror Messaging Connection Unavailable

Major If a CStore is configured with a Content Store Mirrored Peer Server but is not connected to it then this alarm is raised. If the connection comes up, then the alarm is deactivated. If mirroring is not desired then clear the Content Store Mirrored Peer Server parm on the MAS Console and the alarm will be deactivated

Storageroot Data Incompatible

Critical CStore determines if the pre 3.0 data format is present in the storage root. If so, the alarm is raised and messaging API is disabled so processing stops.

Data Synchronization in Progress

Minor MAS console visible alarm so that it is known that a sync is in progress and that data may still be in the process of being copied with the peer. Depending on the situation, service may or may not be desired until sync is complete. Deactivation of this alarm gives the administrator an indication the system is ready for service. If both CStores are suspected to be in a synced state already, then the minor alarm can be ignored.

Component Shutdown Critical The CStore has been shutdown and is not running.



internal platform software subcomponent which generated the event. The MAS generates the following classifications of events:

• Information

• Warning

• Error

MAS logs are delivered to the event viewer. The system automatically archives and rotates the logs as needed.

Typically, whenever an error condition occurs, the system administrator (or support technicians) must determine what caused the error, attempt to recover from the error, and take measures to prevent the error from recurring. The event logging capabilities of the MAS are an indispensable help in determining what conditions caused the error and the context in which the error occurred. Also, periodic viewing of the event log enables a more proactive preventive posture that identifies problems before they impact service delivery.

MAS Console Event ViewerThe local event viewer is accessible through the Event Viewer snap-in located in the Media Application Server Console. The Event Viewer snap-in can be configured to limit log files to a specific size, and rotate/archive log files. Event logs can be archived to disk as “.evt” files (binary) or text (ASCII) log files. Logs stored as ASCII text can be viewed using any text editor/viewer. MAS logs stored as binary can be viewed using the Event Viewer.



Procedure 3 Viewing MAS Application logs


1 Click Application in the console tree to view the application logs in the details panel. All Media Application Server-originated logs appear here.



Note: The details panel displays all current Application logs in a tabular format.

Each row of the table contains all of the information for a particular event. There are three categories of event logs:

2 Double-click a row to open an Event Properties display and view all of the information for a particular log.

Note: Similar capabilities exist for Security and System logs.

The following figures show four Multimedia Controller sample logs:

Information

Warning

Error



Figure 13 Sample – Information log

Figure 14 Sample – Minor Alarm Warning log



Figure 15 Sample – Major Alarm Warning log

Figure 16 Sample – Error log




Procedure 4 Customizing the Event Viewer


1 Right-click the Event Viewer (local) snap-in icon to display the following shortcut menu:

Note: The Open Log File menu item can be used to view an archived log file.

2 Select View > Choose Columns... to access the Modify Columns dialog box:



3 To hide columns, select an item in the Displayed columns list and click Remove.

4 To change the order of columns, click the Move Up or Move Down buttons.

5 Click Ok to apply the changes.


Procedure 5 Clearing Application events


1 Right-click on the Application icon (located under the Event Viewer (Local) snap-in icon) to display the following shortcut menu:



2 Select the Clear all Events menu item. The MAS Console allows you to save the event log prior to clearing it.

3 Click Yes to save the event log or No to delete the log without saving it.




Setting Application propertiesThe Application Properties dialog box provides information about the size of the log file as well as the dates it was created and last modified. Through the Application Properties dialog box you can specify the following parameters:

• maximum log size (KB)

what happens with the log when it reaches the maximum size

— overwrite events

— overwrite events older than a configured day

— only allow events to be manually cleared

• restore default setting

• clear logs

• indicate a low speed access connection

The Application Properties dialog box consists of two tabs: General and Filter. Configure log maintenance (archival, rotation) at the General tab. At the Filter tab you can apply various filters to reduce visual clutter of the details panel with unimportant log events.

Procedure 6 Setting Application properties


1 Right-click on the Application icon.

2 Select Properties to open the Application Properties display:



3 Click the General and Filter tabs to move between the two displays. Select and enter the Application properties parameters you want.



4 Click OK to save the changes.


MAS logsCurrently there exists two groups of MAS logs:

• MAS Provisioning Module logs

— MAS 752 log

— MAS 753 log

— MAS 754 log

• Multimedia Controller logs



MAS Provisioning Module logsCurrently there are three MAS Provisioning Module logs: MAS 752, MAS 753, and MAS 754.

The MAS 752 log indicates that an error occurred while processing a pending transaction.

MAS 752 log

Attribute name Attribute value

Family Name (S/L) MAS/MEDAPSVR

Event Type ABNORMAL

Severity ALERT

Report Text Pending Transaction Processing Error: An Error occurred while processing a pending transaction. As a result, subscriber data may not be current on the MAS. Following is the cause of the failure and the details of the transaction that failed: <text appears here providing information such as the domain name, subscriber name, subscriber mailbox and the type of transaction (mailbox creation or mailbox deletion)>

Action Check the validity of referenced subscriber data that is provided at the end of the Report Text. For example the domain name, subscriber name, subscriber mailbox, and the type of transaction.

Associated Operational Measurements

None



The MAS 753 log indicates a communication failure between the provisioning server and the MAS.

The MAS 754 log indicates that a connection with the MAS has been re-established.

MAS 753 log



Event Type COMMUNICATION

Severity ALERT

Report Text Ping Timeout Error. Media Application Server (MAS) did not respond to ping messages. As a result, the connection loss has been detected with those MAS. Verify network connectivity. MAS IP Address: <the IP address of the MAS that did not respond to the PING message appears here>

Action Verify network connectivity and configuration parameters for the MAS.


None

MAS 754 log (Sheet 1 of 2)



Event Type COMMUNICATION

Severity INFO

Report Text Connection Established OK: Connection with the Media Application (MAS) has been established successfully. MAS IP Address: <the IP address of the MAS with which the connection has been established successfully appears here.>



Multimedia Controller logsThe Multimedia Controller (MediaController) subcomponent logs the following events.

Action None.


None

MAS 754 log (Sheet 2 of 2)


Table 4 Multimedia Controller logs (Sheet 1 of 2)

Event ID Type Log Text Description

10100 Information Call Event:<SIP status code>;CallID: <cid>;Request-URI: <uri>

A service request has been denied at the Media Application Server. The <uri> indicates the service that was requested, and the <SIP status code> indicates the failure reason.

11006 Error Invalid license key An invalid license key was provided in the License Key system configuration parameter.

11100 Information MediaController Initialized

The Multimedia Controller subcomponent has been started.

11101 Information MediaController Shutting down

The Multimedia Controller subcomponent has been stopped.

11102 Information System Locked The Media Application Server has been set to the locked state.

11103 Information System Unlocked The Media Application Server has been unlocked.

11104 Information System Lock Pending The Media Application Server has been set to the pending lock state.



Viewing MAS alarms on a third-party management consoleYou have the option of sending MAS alarms to a third-party management console such as HP OpenView® for viewing. Alarm data is sent from the MAS in the form of Simple Network Management Protocol (SNMP) traps. In order to view MAS alarms on a third-party

11118 Information New ConfMP connection has been made to <server>

The Conference Media Processor subcomponent has connected to the Multimedia Controller subcomponent.

11119 Error The ConfMP connection has dropped for server <server>

The Conference Media Processor subcomponent has lost connection to the Multimedia Controller subcomponent.

11137 Information New MMC connection has been made to <server>

The Multimedia Conductor subcomponent has connected to the Multimedia Controller subcomponent.

11138 Error The MMC connection has dropped for server <server>

The Multimedia Conductor subcomponent has lost connection to the Multimedia Controller subcomponent.

11146 Information New CStore connection has been made to <server>

The Multimedia Content Store subcomponent has connected to the Multimedia Controller subcomponent.

11147 Error The CStore connection has dropped for server <server>

The Multimedia Content Store subcomponent has lost connection to the Multimedia Controller subcomponent.

11156 Information New IvrMP connection has been made to <server>

The IVR Media Processor subcomponent has connected to the Multimedia Controller subcomponent.

11157 Error The IvrMP connection has dropped for server <server>

The IVR Media Processor subcomponent has lost connection to the Multimedia Controller subcomponent.

Table 4 Multimedia Controller logs (Sheet 2 of 2)

Event ID Type Log Text Description



management console, you must configure the following two parameters on the MAS Console: the SNMP Community String parameter, and SNMP Management Server parameter. For information on configuring these two MAS parameters see the appendix in this document called Music on Hold Installation Guide, in the section that deals with configuring the MAS platform and service software. Consult the third-party management console documentation for information about configuration, and alarm viewing.

Viewing MAS logs on SysLog serversYou have the option of viewing MAS logs on one or more remote SysLog servers. In order to view MAS logs on a SysLog server, you must configure the SysLog Server parameter on the MAS Console. For information on configuring this parameter, see the appendix in this document called Music on Hold Installation Guide, in the section that deals with configuring the MAS platform and service software.



Configuration management

This section describes the tasks (from a high-level viewpoint) that you must perform to configure the Music on Hold service to run on a Media Application Server.

For complete information on installing and configuring the Media Application Server platform, and the Music on Hold service software, refer to Appendix B, Music on Hold service Installation Guide, on page 125

Configuration tasksProper operation of the Music on Hold service requires the following configuration steps be performed:

• Network Configuration – Configuring connectivity to the Media Application Server where the Music on Hold server resides.

• Media Application Server Configuration – Configuring the Media Application Server platform and the Music on Hold service software.

• Service Access Configuration – Configuring the Music on Hold pooled entity and routable service information to allow routing to the Music on Hold service.

Network ConfigurationLike any other node in the network, the Media Application Server must be configured to allow it to communicate with the rest of the network. During installation of the Media Application Server, the system administrator must provide the following information:

• SIP UDP port – The signaling port where SIP messages will originate and terminate to this Media Application Server.

• SIP Application Servers– The address(es) of Sip Application Module(s) that this Media Application Server allows incoming service requests to come from. Incoming service request messages from nodes not configured for this Media Application Server are rejected.



Media Application Server ConfigurationAfter network configuration is complete, the Media Application Server platform software must be configured using the Media Application Server Console. The administrator only needs to configure system level configuration parameters.

Note: You do not need to configure Music on Hold software on the Media Application Server Console. There are no configuration parameters for Music on Hold on the MAS Console.

Service Access ConfigurationAfter the Media Application Server platform software and the Music on Hold service software have been configured, the Music on Hold pooled entity must configured for the network. This allows the network to route service requests to the Music on Hold service pooled entity. Configuring the Music on Hold service consists of the following steps:

• Place Music on Hold music folders on a Media Application Server within the service instance (pooled entity)

• Create a pooled entity for Music on Hold service

• Configure routable services information for Music on Hold service pooled entity

• Enable Music on Hold service in the service packages

Configuration of the multi-application MAS The multi-application MAS deployment allows you to install five MAS services on a single MAS platform.

The multi-application MAS deployment is standalone (simplex) using the IBM xSeries 336 (or 335) platform and does not support pooling of ports across other MAS. MAS platform configuration for this deployment involves setting the system, and service parameters at the MAS Console for each service (one after another). MAS service configuration involves setting the necessary parameters on the Provisioning Client for each service, one after another.

Bulk provisioning the Music on Hold serviceYou have the option of using the Bulk Provisioning Tool (BPT) to configure the Music on Hold service. For information on downloading the BPT to your PC, see the Provisioning Client User Guide.

For complete information on the Bulk Provisioning Tool, see the Open Provisioning Interface (NN42020-123), and Bulk Provisioning Tool Reference Guide (NN42020-501).



Accounting

Internet Protocol Detail Records (IPDRs) are collected for the Music on Hold service. Table 5 shows the connect Egress record and field descriptions for the Music on Hold service IPDR.

Figure 17 shows a connect Egress record for Music on Hold.

Table 5 Connect Egress record field descriptions

Field Name XML tagRecord type

Element found within Description

Supplementary Service

supplementaryService Egress UE Indicates the service name

Main Folder serviceURI Egress UE, supplementaryService

Gives the URI containing the detailed parameters of the service (for example, folder name, file name, and locale).



Figure 17 Connect Egress record for Music on Hold

For more information on accounting, refer to the MCS 5100 Accounting Module Basics (NN10279-111).

<ipdr:IPDR seqNum="31" time="2003-04-18T14:29:53.721Z"><ipdr:SS service="ConnectEgress">

<ipdr:SC xsi:type="SC-VoIP-Type"><subscriberID>[email protected]</subscriberID>

</ipdr:SC><ipdr:SE xsi:type="SE-VoIP-Type">

<appSrvID>Acct2</appSrvID><appSrvVer>ims_3.0_build264</appSrvVer>

</ipdr:SE></ipdr:SS><ipdr:UE xsi:type="UE-VoIP-Type">

<uID>12db0e8_f4a24105b5@bigcorp</uID><corrID>[email protected]</corrID><recTime>2003-04-18T14:29:52.279Z</recTime><protocol>sip</protocol><startTime>2003-04-18T14:29:51.098Z</startTime><tUA>IMS IPCM 2.0</tUA><ansTime>2003-04-18T14:29:52.269Z</ansTime><aband>false</aband><ansInd>true</ansInd><outpulsedDigits>[email protected]:5070</outpulsedDigits><routing>

<routingDest>[email protected]</routingDest><routeBlock>

<type>SEQ</type><numAttempts>1</numAttempts><routes>

<route>sip:[email protected]:5070;maddr=47.1.1.1</route></routes>

</routeBlock></routing>

<connParty>sip:[email protected]:5070;maddr=47.1.1.1</connParty><supplementaryService>

<routableService><serviceURI>sip:[email protected];early=no;play=domain.com\JazzFolder</serviceURI>

</routableService></supplementaryService>

</ipdr:UE></ipdr:IPDR>



Performance management

The Media Application Server (MAS) Console is the tool you use to manage the performance of the Media Application Server (MAS) platform and the Music on Hold service.

Operational measurementsThe MAS supports two types of operational measurements: counters and gauges.

Counters are used to record and track activity on the system. Gauges provide real-time information about the running system. The MAS also supports internal OM thresholds. The MAS is able to trigger an alarm when a set threshold for a gauge is exceeded.

Counters and gauges support performance monitoring, which is the process of capturing and analyzing the system performance data to identify system bottlenecks and fine-tune system and application performance. System performance data can be graphed according to specifications or written to a file for archiving and further analysis.

Counters are named registers that start from zero and increment upward only. Counters are reset automatically when a component restarts. A counter may increment in chunks of any size. Counters are visible through the Microsoft Management Console only.

Gauges are named registers that start from zero and support incrementing and decrementing. Gauges may increment or decrement in chunks of any size. Gauges are very useful to an administrator because they provide a real-time view into the operations of the system. Gauges are visible through the Microsoft Management Console only.

Counters and gauges are organized by an Media Application Server internal subcomponent and are updated at periodic time intervals (minimum 1-second granularity). Each internal subcomponent generates its own performance data. The OS platform also exposes many useful counters and gauges: UDP counters provide a relatively accurate view of the RTP traffic levels to and from a given machine;



processor and disk utilization gauges provide an indication of the relative load on the machine.

The Media Application Server management framework also supports OM alarm thresholds. The system is able to set a threshold level for a gauge which will trigger an alarm when the threshold is exceeded. The system is also able to set an abatement level (which can be different from the alarm threshold) that defines the point at which an OM threshold alarm will be cleared.

Procedure 7 Viewing operational measurements


1 Click on the Counters and Gauges snap-in icon.

Note: The first page of operational measurements contains the statistics.

2 Use the scrollbar on right side of the details panel to view the following pages of operational measurements.


Setting up Counters and GaugesThe Counters and Gauges snap-in is responsible for gathering and reporting the Operational Measurements (OM) generated by the Media Application Server.



Counters and Gauges is a dynamic snap-in whose display can be manipulated in real time, meaning that it is possible to view only specific performance data of interest, and to add/drop any of these counters/gauges on the fly.

Procedure 8 Setting up Counters and Gauges


1 Select the Counters and Gauges snap-in icon to view the performance data in the details panel.

Note: Initially the details panel for Counters and Gauges may be empty.

If the details panel for Counters and Gauges is empty, a view of the performance statistics can be built by adding counters and gauges to the dynamic view.

2 Right-click in the details panel to display the counter and gauges shortcut menu:

3 Select Add Counters to display the Add Counters dialog box:



4 Select the Performance object of interest at the drop-down menu.

5 Select Media Server Performance objects (the internal subcomponents: ConfMP, CStore, IVRmp, and MediaController) by selecting each in turn from the drop-down menu.



6 Select ConfMP to display the list of counters or gauges provided by that internal subcomponent.

7 Select the All counters button and click the Add button to add all ConfMP counters to the details panel. Alternatively, a subset of the ConfMP counters can be added to the details panel by selecting the Select counters from list button and adding one counter and gauge at a time (by selecting the counter or gauge of interest, and click the Add button).

The selected counters and gauges will appear in the details panel of the console each time the Add button is clicked.

8 Continue for remaining Performance objects of interest or, to return to the console, click Close.


Dynamic customizingIt is possible to dynamically manipulate the performance statistics displayed in the Counters and Gauges details panel.

The process of adding more performance statistics to the details panel is the same procedure as that described previously for configuration.



Procedure 9 Removing counters and gauges


1 Click on the item of interest (for example, NumG711Parties). The selected item will be highlighted.

2 Press the Delete key on the keyboard (or click the Delete icon in the details panel) to remove the selected item.


Collecting performance dataThe MAS Console supports real-time recording of system performance using snapshots of counters and gauges.

A system administrator is able to provide a list of monitored counters or gauges, which are periodically polled and recorded by the system. The timestamp, name, and value of these counters and gauges are recorded to a file in a text, binary, or Excel spreadsheet format. The interval is configurable and can be scheduled. After the data is collected, it is easily analyzed using applications or scripts.

The MAS Console also supports triggering “alerts” based upon any existing counter or gauge. The criteria for generating alerts is configurable, but is usually based upon counter thresholds. Additional actions may be configured when an alert is triggered. For example, it is possible to start collecting performance data, send messages, and invoke an application or script.

For more information on how to accomplish this, refer to System Monitor help. To do this, click the System Monitor help icon in the Counters and Gauges details panel. The System Monitor help window appears.

For additional information on MAS performance management, see the MAS Network Deployment and Engineering Guide.



Multimedia Controller counters and gaugesThe following Multimedia Controller (MediaController) counters and gauges are available:

Table 6 Multimedia Controller (MediaController) counters and gauges (Sheet 1 of 5)

Name Type Description

ActiveConferenceParties gauge Reports the total number of parties for all active conferences.

ActiveConferences gauge Reports how many conferences are currently active.

ActiveServices gauge Reports the number of unique services currently assigned to active sessions.

ActiveSessions gauge Reports the number of sessions currently active within the Media Controller.

AllocatedSessions counter Counts number of sessions that have been allocated on the Media Controller.

annc::AnnouncementServiceUses counter Counts how many times the announcement service has been used.

annc::InvalidRequestReceivedannc::UnknownMediaReceivedInRequest

counters Counts how many of the respective announcement service requests have been received

AvailableServices gauge



CFAddPartyRequestsCFCreateConferenceRequestsCFDeleteConferenceRequestsCFGlobalMFConferencePortRequestsCFMessagesReceivedCFMessagesSentCFModifyPartyRequestsCFPartyMFConferencePortRequestsCFRemovePartyRequests

counters Counts number of requests and messages with the Conference Media Processor subcomponent.

CSAdminRequestsCSDeliverRequestsCSIngestRequestsCSMessagesReceivedCSMessagesSentCSModifyRequestsCSQueryRequestsCSStatRequests

counters Counts number of requests and messages with the Multimedia Content Store subcomponent.

InstantMessageRequestsSentInstantMessageResponsesReceived

counters Counts how many instant messages have been sent and received by the MAS.

MFAdjustRequestsMFASRRequestsMFCancelRequestsMFCollectRequestsMFEventsReceivedMFMessagesReceivedMFMessagesSentMFPauseRequestsMFPlayRequestsMFRecordRequestsMFReleaseRequestsMFReserveRequestsMFResumeRequestsMFTSRequests

counters Counts how many messages of the respective requests have been received by the Multimedia Controller.

MMCMessagesReceivedMMCMessagesSent

counters Counts how many messages have been sent and received by the Multimedia Controller.





moh::MusicOnHoldServiceUses counter Counts how many times the music on hold service has been used.

moh::InvalidRequestReceivedmoh::UnknownMediaReceivedInRequest

counters Counts how many of the respective music on hold service requests have been received

NumG711LicensesInKey: anncNumG711LicensesInKey: chatNumG711LicensesInKey: conferenceNumG711LicensesInKey: CStoreAdministrationNumG711LicensesInKey: meetmeNumG711LicensesInKey: mohNumG711LicensesInKey: ucomm

gauges Reports the maximum number of G711 licenses available for use by the MAS.

NumG711LicensesInUse: anncNumG711LicensesInUse: chatNumG711LicensesInUse: conferenceNumG711LicensesInUse: CStoreAdministrationNumG711LicensesInUse: meetmeNumG711LicensesInUse: mohNumG711LicensesInUse: ucomm

gauges Reports how many G711 licenses are actively in use.

NumG729LicensesInKey: anncNumG729LicensesInKey: chatNumG729LicensesInKey: conferenceNumG729LicensesInKey: CStoreAdministrationNumG729LicensesInKey: meetmeNumG729LicensesInKey: mohNumG729LicensesInKey: ucomm

gauges Reports the maximum number of G729 licenses available for use by the MAS.

NumG729LicensesInUse: anncNumG729LicensesInUse: chatNumG729LicensesInUse: conferenceNumG729LicensesInUse: CStoreAdministrationNumG729LicensesInUse: meetmeNumG729LicensesInUse: mohNumG729LicensesInUse: ucomm

gauges Reports how many G729 licenses are actively in use.





NumVideoParties gauge Reports the number of video-enabled users that are currently in active conference sessions on the MAS.

OriginatingAcksOriginatingByesOriginatingInvitesOriginatingNotifiesOriginatingRefersOriginatingStatus200OriginatingStatus400

counters Counts how many of the respective SIP messages have been sent by the MAS.

RegisterRequest

SignaledDigit

TerminatingAcksTerminatingByesTerminatingInvitesTerminatingNotifiesTerminatingRefersTerminatingStatus200

counters Counts how many of the respective SIP messages have been received by the MAS.

VxmlCStoreRequestsVxmlDocumentStartedVxmlDocumentStopped

counters

VxmlIvrMPAdjustRequestsVxmlIvrMPAsrRequestsVxmlIvrMPCollectRequestsVxmlIvrMPEventsVxmlIvrMPPlayRequestsVxmlIvrMPStopRequestsVxmlIvrMPTerminateAsrRequests

counters

VxmlMmcByeVxmlMmcINFOVxmlMmcNotifyVxmlMmcReferVxmlMmcWebPush

counters





Conference Media Processor counters and gaugesThe following Conference Media Processor (ConfMP) counters and gauges are available:

VxmlNumReleasedFibers-Engine 0VxmlNumReleasedFibers-Engine 1VxmlNumReleasedFibers-Engine 2VxmlNumReleasedFibers-Engine 3

counters

VxmlNumReservedFibers-Engine 0VxmlNumReservedFibers-Engine 1VxmlNumReservedFibers-Engine 2VxmlNumReservedFibers-Engine 3

gauges

VxmlQueueDepth-Engine 0VxmlQueueDepth-Engine 1VxmlQueueDepth-Engine 2VxmlQueueDepth-Engine 3

gauges Reports the length of respective queue

VxmlServiceRequests counter

WebpushRequests counter Counts how many web push requests have been received by the MAS.



Table 7 Conference Media Processor (ConfMP) counters and gauges (Sheet 1 of 3)


AddParty counter Counts the number of requests received to add a party to a conference.

ConfMPLoadFactor

CorruptCreateConfDeleteConfEarlyPackets

counters Counts how many of the respective requests messages have been received by the ConfMP.



FourWayMixThreeWayMixTwoWayMixZeroWayMix

FourWayMixExceeded

IvrConfIvrParty

counter Counts how many requests were received to activate the broadcast IVR channel.

LatePackets counter Counts how many request messages were received late by the ConfMP.

MaxPercentUsedAudioRtpBufsMaxPercentUsedRtcpBufsMaxPercentUsedVideoRtpBufs

gauges Reports the maximum percentage of the respective buffers that have been used by the ConfMP.

ModParty counter Counts how many modify requests have been received by the ConfMP.

NumConferences gauge Reports how many active conferences there are.

NumFreeConfCmdBlocks gauge Reports how many unused conference controls blocks are remaining.

NumFreeMPUs gauge Reports how many unused Media Processing Units are remaining.

NumG711aLawPartiesNumG711uLawPartiesNumG29PartiesNumPartiesNumVideoParties

gauges Reports how many of the respective parties are actively in a conference.

NumPremiumConferencesNumStandardConferences

gauge Reports how many active conferences of the respective type there are.

NumReplacementVidStreamsUsed gauge Reports how many replacement video streams are active.





IVR Media Processor counters and gaugesThe following IVR Media Processor (IvrMP) counters and gauges are avail-able:

PercentUsedAudioRtpBufsPercentUsedRtcpBufsPercentUsedVideoRtpBufs

gauges Reports the percentage of the respective buffers that are being used by the ConfMP.

PremiumConfCreates counter Counts how many premium conferences have been created.

RegisterRemoveParty

counters Counts how many request messages were received by the ConfMP.

StandardConfCreates counter Counts how many standard conferences have been created.

Unknown counter Counts how many unknown requests messages were received by the ConfMP.

VADReinitialized counter Counts how many times the VAD has been re-initialized.



Table 8 IVR Media Processor (IvrMP) counters and gauges (Sheet 1 of 3)


BuffCurrPercent gauge Reports the percentage of buffers currently allocated by the IVR.

BufferAged counter Counts the number of RTP buffers that aged themselves into the buffer free pool.

BuffMaxPercent gauge Reports the maximum percentage of buffers that have been allocated by the IVR.

CacheFileKBSizeCacheFilePercent CacheAviKBSize CacheAviPercent

gauges



CodecDivxCodecG721CodecG729CodecH263CodecPcmuCodecPcmaCodecL16CodecL8

counters Counts the number of the times a respective CODEC has been used.

CodecG711Recv CodecG711Send CodecG729Recv CodecG729Send

gauges Number of respective CODEC send/receive requests

CodecRecvTotal CodecSendTotal

gauges Number of send/receive requests

Connections gauge Number of IVR connections

ConnectionsLost counter Counts the number of server connections that were broken to the IvrMP subcomponent.

EngineOverload counter Counts the number of reservations that were rejected because of CPU overload detection.

EngineRelease counter Counts the engine release request success count (release messages received)

EngineReserve counter Counts the engine reservation success count (session count)

Engines gauge Number of IVR engines.

EngineTimeout counter Counts the number of engines whose sanity timer expired and were released. This count is also reflected in the release count.

EngineUnderflow counter Counts the number of read underflows at the engine (empty stream cache when streaming).





InvalidSSRC LoadDeltaLoadFactor PulseAveragePulseMax

gauges

ReqAdjustReqErrorsReqEventReqPauseReqPlayReqRecordReqReleaseReqReservationReqResumeReqStopReqUnknown

counters Counts the number of respective engine requests received by the IVR.

RtpAudioOverflow counter Counts the number of write overflows during audio RTP receive (full stream cache when handling a packet).

RtpCorruptPackets

RtpOvertime counter Counts the audio packet latency (packet send interval too long by 50%).

RtpSocketsOpen

RtpUndertime counter Counts the audio packet latency (packet send interval too short by 50%).

RtpVideoOverflow counter Counts the number of write overflows during video RTP receive (full stream cache when handling a packet).





Stream Source counters and gaugesThe following Stream Source (StreamSource) counters and gauges are available:

Table 9 Stream Source (StreamSource) counters and gauges


ActiveIvrMPConnections gauge Reports how many connections to the IVR are currently active.

AllocatedAudioBuffers gauge Reports how many audio buffers are currently allocated by the Stream Source.

BytesProcessedPerSecond gauge Reports how many bytes per second have been processed by the Stream Source.

BytesStreamedPerSecond gauge Reports how many bytes per second have been sent by the Stream Source.

ExternalProviderConnection

PendingIvrMPConnections gauge Reports how many pending connection requests to the IVR are currently present.

TotalFilesTranscoded counter Counts how many files have been transcoded by the Stream Source.



Multimedia Content Store counters and gaugesThe following Multimedia Content Store (CStore) counters and gauges are available:

Table 10 Multimedia Content Store (CStore) counters and gauges


AdminAuditStorageAdminBackupAdminCreateMailboxAdminCreateNamespaceAdminDeleteMailboxAdminDeleteNamespaceAdminGetMailboxesAdminGetNamespacesAdminQueryMailboxPresenceAdminQueryMailboxSizeAdminQueryNamespacePresence

counters Counts how many times the respective message has been received

AdminQueryNamespaceSizeAdminRenameMailboxAdminRestoreAutoIngestDeliverIngestMirrorRTFTReadsFailedMirrorRTFTReadsTotalMirrorSyncRequestMirrorSyncResponseModify


NotifyQueryRegistrationReportStatSubscribeTokenGrantTokenRequestTransactionsTotalXMLModifyXMLQuery


DeliverPendingRequestQueueDeliverRequestQueuePrimaryRequestQueue

gauges Reports the length of respective queue



Security and Administration

The Media Application Server platform provides security and administration for the Music on Hold service. These procedures are performed primarily through the Media Application Server Console (MAS Console).

You use Media Application Server Console (MAS Console) to perform security and administration procedures relating to the IM Chat service. The MAS platform uses a hardened Windows 2000 operating system.

Note: The MAS supports the encryption of instant messages (IMs).

Security strategy overviewRefer to the MAS Network Deployment and Engineering Guide (NN10313-191) for more information about the Media Application Server security strategy.

AdministrationThe Media Application Server is monitored and managed using the MAS Console. You access the MAS Console by means of the Microsoft Terminal Services Advanced Client (TSAC). TSAC provides remote access capabilities to the MAS platform where the MAS Console application is running.

Establishing the managed environmentThe process for establishing the managed environment on the MAS involves starting a remote access session to each of the Media Application Servers in the site, and then starting the Media Application Server Console within the context of those sessions.

All available remote access connections to Media Application Servers in the site are visible in the Client Connection Manager and the Terminal Services Client program group. Either of these can be used to initiate remote sessions with the target Media Application Server



Procedure 10 To start the Client Connection Manager

At the system administrator’s PC

1 Select Start > Programs > Terminal Services Client > Client Connection Manager.

The Client Connection Manager is displayed, showing all available remote access connections to Media Application Servers in the site:


Procedure 11 Creating new remote access connection icons

From the Client Connection Manager

1 Select File > New Connection…

2 This starts a simple wizard. Follow the steps to create a connection icon for a remote Media Application Server.

Note: There are a number of ways to enable a connection. The first is to double-click the entry in the Client Connection Manager display. Another is to right-click an entry (for example, NORTEL-X49) in the Client Connection Manager display to display a shortcut menu, and then select Connect from the shortcut menu as shown.




Using Terminal Services Client program group icons All available remote access connections are visible in the Terminal Services Client program group.


1 Select Start > Programs > Terminal Services Client.

2 Select on the Media Application Server connection you want.




Using the Terminal Services Client to manually connect to the MASInstead of creating Terminal Services Client connection icons, you can run the Terminal Services Client program directly and then provide the IP address of the remote machine.


1 Select Start > Programs > Terminal Services Client > Terminal Services Client.

The Terminal Services Client window appears.

2 Enter the IP address, or if available, select the hostname from the Available Servers list, of the machine you wish to connect to.

3 Click Connect to start a connection to the specified IP address or machine name.


Starting the MAS ConsoleAny of the methods previously discussed will start a TSAC session from the system administrator’s PC to the Media Application Server. The TSAC attempts to automatically log on to the Media Application Server upon connecting (according to the configuration) and, if successful, displays the actively running remote desktop for this user.



Figure 18 TSAC display window

Once general access is gained through TSAC, you can start the local MAS Console for this Media Application Server.

From the TSAC window that displays the remote MAS desktop

1 Select Start > Programs > Nortel Networks Media Application Server > Media Application Server Console.

The MAS Console opens in the TSAC window

MAS Console shortcut

Start menu button




Accessing MAS Console help filesThe MAS Console help menu includes information about the console as well as the native OS snap-ins used to build the MAS Console.



Procedure 12 Viewing MAS Console help files


1 Click the Help menu item.

2 Select Help Topics to open the MAS Console help display. This display contains help topics for the Microsoft Management Console (MMC) as well as the native operating system snap-ins used to build the MAS Console.



3 Select Microsoft on the Web to access the Microsoft web site, or select About Microsoft Management Console... to view the software version.


MAS subcomponentsThe MAS platform consists of six subcomponents. Each internal subcomponent executes a simple-state machine. The overall state of the MAS is an aggregation of the individual states of the seven subcomponents. The MAS Console allows the system administrator to display and control the MAS platform and subcomponents.

Controlling MAS subcomponents from the MAS ConsoleSubcomponents are not individually controllable. The MAS platform service is a collection of subcomponents, each of which is responsible for a specific area of MAS platform functionality. Stopping one subcomponent affects the others. As such, control operations are performed on the entire MAS platform service and not on an individual subcomponent basis.

There are six control commands that can be issued to the MAS platform:

• Unlock

• Pending Lock

• Lock

• Start

• Stop

• Restart

Note: Not all control operation commands are available at any instant. Only valid operations are enabled for the administrator. For example, if the MAS has been stopped, the Stop operation is no longer available.

The Stop and Restart commands are service affecting operations and will take down all existing Music on Hold service sessions.

The Lock operation is also a service affecting operation and will take down any existing service sessions. However, in this case, an emergency maintenance announcement is streamed to the active sessions (where applicable).



The Pending lock operation preserves existing Music on Hold service sessions. In the case of planned maintenance, this gives existing sessions time to disconnect naturally (without service interruption), before the MAS platform is stopped.

Use the following procedure to access the available control operations for the MAS.

Procedure 13 Controlling the MAS platform


1 Right-click the Control Panel snap-in icon in the Console tree to display the following shortcut menu:

2 Use the Operations submenu to access the appropriate operational command to perform on the MAS platform.




Refreshing a subcomponent status on the MAS Console The status of subcomponents automatically refreshes periodically. Use the following procedure to initiate an immediate refresh of the subcomponent status.


1 In the details panel, right-click one of the subcomponents to display the Component shortcut menu:

2 Select Refresh to update subcomponent’s status.




System and platform managementThe MAS Console is pre-configured with a Disk Management snap-in provided by the operating system (see Figure 19).

Figure 19 Disk Management snap-in display

Pre-configuring the Disk Management snap-in is provided as a convenience for managing the hard disks and volumes on the Media Application Server. For more information on usage of the Disk Management snap-in, refer to the operating-system resident help. To do this, click the Help drop-down menu in the MAS Console and click the HelpTopics item. The help window will appear.

Data backup and restoreThe Media Application Server provides the capability to mirror customer data (managed by the Multimedia Content Store sub-component) on different MAS nodes. It is frequently convenient to be able to do a complete node restoration from outside the system. The MAS Console provides the capability to perform backup and restore of system configuration data as well as service data.

System dataSystem data includes all configuration parameters which are visible in the MAS Console Services folder and stored in the Windows Registry.

Note: A System Data backup and restore can be performed with the system online and unlocked, however the MAS must be restarted after restoration in order for the configuration parameter changes to take effect.

Help drop-down menu



Service dataService data includes user data which resides in the Multimedia Content Store sub-component. A partial service backup archives all data except multimedia files. A full service backup includes all data included in a partial backup in addition to multimedia files.

Note: For both service data archive types, the MAS must be in a locked/shutdown state to perform a restore. During the restoration process, all user files in the Multimedia Content Store sub-component are removed prior to archive extraction.

Accessing MAS backup and restore functionalityThe backup and restore functionality provided by the MAS Console is accessible using the Control Panel icon’s short-cut menu. Right-click the Control Panel snap-in icon in the Console tree to access the Backup/Restore sub-menu:

The Backup/Restore sub-menu contains selections to create backup archive files for system data, and service data (full or partial). For each of these types of backups a sub-menu is provided to allow the administrator to perform specific Backup/Restore related functions for that backup type, as shown in the following figure:



Creating backup archivesThe Backup/Restore > Create Backup Archive menu option provides the capability of creating backup archives for system data, and service data (full or partial). The following procedures describe how to create backup archives for system data, and service data (full and partial) on the Media Application Server.

Procedure 14 Creating a System Data backup


1 Right-click the Control Panel snap-in icon in the Console tree to access the Backup/Restore sub-menu:

2 Select Backup/Restore > System Data > Create Backup Archive to display the Create System Backup Archive file browser window:



3 Use the file browser window to select the name and location of where the backup archive should be stored on the computer. A default archive filename is automatically generated which specifies the type of backup, the hostname of the MAS where the backup was created, and the date and time the backup was created.

Note: It is recommended that the automatically generated filename be used. This ensures consistent naming of all backup archives, and makes it easier to find specific archive files when a restore procedure is required.

4 Click the Save button to create the system data archive file.


Procedure 15 Creating a Full Service Data backup


1 Right-click the Control Panel snap-in icon in the Console tree to access the Backup/Restore sub-menu.

2 Select Backup/Restore > Service Data (Full) > Create Backup Archive to display the Create Service Backup Archive file browser window.

3 Use the file browser window to select the name and location of where the backup archive should be stored on the computer. A default archive filename is automatically generated which specifies the type of backup, the hostname of the MAS where



the backup was created, and the date and time the backup was created.


4 Click the Save button to create the full service data archive file.


Procedure 16 Creating a Partial Service Data backup



2 Select Backup/Restore > Service Data (Partial) > Create Backup Archive to display the Create Service Backup Archive file browser window.

3 Use the file browser window to select the name and location of where the backup archive should be stored on the computer. A default archive filename is automatically generated which specifies the type of backup, the hostname of the MAS where the backup was created, and the date and time the backup was created.


4 Click the Save button to create the partial service data archive file.


Restoring from backup archivesThe Backup/Restore > Restore menu option provides the capability of restoring from a previously created backup archive of system data, or service data (full or partial). The following procedures describe how to restore from backup archives.

Procedure 17 Restoring a system data backup archive





2 Select Backup/Restore > System Data > Restore to display the Restore System Backup Archive file browser window:

3 Use the file browser window to select the system data backup archive to be used for restoring the system data.

Note: If the default automatically generated filename was used when creating the system data backup, then the backup archive filename begins with MASSYS.

4 Click the Open button to restore the system data from the archive file.

After the restore has completed, the Media Application Server must be restarted.



5 Right-click the Control Panel snap-in icon in the Console tree to access the Operations sub-menu.

6 Select Operations > Restart to restart the Media Application Server.


Prior to restoring service data, it is necessary to take the Media Application Server out of service (locked and offline). The MAS can be immediately locked and then stopped, however, if there are active service sessions on the MAS when it is locked, the sessions are immediately taken down as well. Because of this, it is recommended that the MAS be placed in the Pending Lock state first, allowing existing service sessions to end naturally over time. Once the active sessions have ended, then the MAS can be placed in the Locked state and then stopped. Refer to Controlling MAS subcomponents from the MAS Console on page 90 for more information.

Procedure 18 Restoring a full service data backup archive



2 Select Operations > Pending Lock to prevent the Media Application Server from accepting new service requests, and to allow existing service sessions to end.

Allow all existing service sessions to end naturally, or wait until an acceptable low number of existing service sessions remain.

3 Right-click the Control Panel icon and select Operations > Lock to end any remaining service sessions.

4 Right-click the Control Panel icon and select Operations > Stop to place the Media Application Server offline.


6 Select Backup/Restore > Service Data (Full) > Restore to display the Restore Service Backup Archive file browser window:


Note: If the default automatically generated filename was used when creating the full service data backup, then the backup archive filename begins with MASSVC_FULL.



8 Click the Open button to restore the full service data from the archive file.

After the restore has completed, the Media Application Server must be returned to service.

9 Right-click the Control Panel icon and select Operations > Start to activate the Media Application Service.

Once the Media Application Service has successfully started, it returns to the previously locked state. The MAS must be unlocked before it will accept new service requests.

10 Right-click the Control Panel icon and select Operations > Unlock.

The Media Application Server is now online and will accept new service requests.


Procedure 19 Restoring a partial service data backup archive



2 Select Operations > Pending Lock to prevent the Media Application Server from accepting new service requests, and to allow existing service sessions to end.

Allow all existing service sessions to end naturally, or wait until an acceptable low number of existing service sessions remain.

3 Right-click the Control Panel icon and select Operations > Lock to end any remaining service sessions.

4 Right-click the Control Panel icon and select Operations > Stop to place the Media Application Server offline.


6 Select Backup/Restore > Service Data (Partial) > Restore to display the Restore Service Backup Archive file browser window:


Note: If the default automatically generated filename was used when creating the full service data backup, then the backup archive filename begins with MASSVC_PARTIAL.



8 Click the Open button to restore the partial service data from the archive file.

After the restore has completed, the Media Application Server must be returned to service.

9 Right-click the Control Panel icon and select Operations > Start to activate the Media Application Service.

Once the Media Application Service has successfully started, it returns to the previously locked state. The MAS must be unlocked before it will accept new service requests.

10 Right-click the Control Panel icon and select Operations > Unlock.

The Media Application Server is now online and will accept new service requests.


Using automatic backup tasksThe Backup/Restore > Automatic Backup Task menu option is used to create backup archives for system data, and service data (full or partial) at regularly scheduled intervals, for example, daily or weekly. An automatic backup task can store archives locally on the Media Application Server or can be configured to push the archive to a remote server using File Transfer Protocol (FTP).

The following procedures describe how to create, schedule, and remove automatic backup tasks on the Media Application Server.

Procedure 20 Creating an Automatic Backup Task (local backup)





2 Select Backup/Restore > System Data > Automatic Backup Task > Create to display the System Backup Task window:

3 In the Local Destination Folder field, entry the folder where the automatic backup archive will be stored.

ExampleD:\MASBackup

4 Click Create to save the new backup task.




Procedure 21 Creating an Automatic Backup Task (remote backup)


1 Right-click the Control Panel snap-in icon and select Backup/Restore > System Data > Automatic Backup Task > Create to display the System Back Task window:

2 In the Local Destination Folder field, entry the folder where the automatic backup archive will be stored.

ExampleD:\MASBackup

3 Select the Enable FTP option.

4 In the Hostname field, enter the hostname or IP address of the remote FTP service machine where the backup task will send the generated backup archive.

Exampleftpserver1

5 In the Username field, enter the username the backup task will use to connect to the remote machine’s FTP service.

Examplemasftpuser



6 In the Password field, enter the password the backup task will use to connect to the remote machine’s FTP Service.

Examplemasftppword

7 In the Destination Path field, enter the folder where the automatic backup archive will be stored on the remote FTP service machine.

Example/export/home/masftpuser

8 By default, the backup task also keeps a copy of the backup archive on the local machine (in the folder specified in step 2 above). If desired, select the Remove local file after transfer option to have the backup task remove the local copy.



Procedure 22 Scheduling an Automatic Backup Task



2 Select Backup/Restore > System Data > Automatic Backup Task > Schedule/Run to display the Task tab of the selected automatic backup task window:



3 Do not modify the Run field. This field is automatically generated when the backup task is created and altering it could prevent the task from running correctly.

4 The Run as field shows the user account that is used when the backup task is executed. Verify that the user account is NortelMASAdmin.

5 Click the Set password... button to assign the password for the NortelMASAdmin account.

6 Select the Enabled (scheduled task runs at specified time) check box to activate the backup task.

7 Select the Schedule tab to display scheduling information for the backup task:



8 Click New to create a new schedule for the task.

9 Use the Schedule Task, Start time and Schedule Task Daily fields to define when and how often the backup task will run.

10 Select the Settings tab to display additional settings information for the backup task:



11 The Settings tab is automatically configured when the backup task is created.

Note: Changing the Settings tab properties improperly could prevent the backup task from running correctly.



Procedure 23 Deleting an Automatic Backup Task



2 Select Backup/Restore > System Data > Automatic Backup Task > Remove to remove the backup task.




Appendix A Message flows

This appendix contains the following high-level message flow diagrams for the Music On Hold Service:

• Music On Hold message flow (without the RTP Media Portal)

• Retrieving a call from Music On Hold (without RTP Media Portal)

• Music On Hold failure (without the RTP Media Portal)

• Music On Hold message flow (with the RTP Media Portal)

• Retrieving a call from Music On Hold (with the RTP Media Portal

• Music On Hold failure (using the RTP Media Portal)

• Both parties placing each other on hold (using RTP Media Portal)

• Both parties retrieve each other from hold (with RTP Media Portal)

• Both parties place each other on hold (without the RTP Media Portal)

• Both parties retrieve each other from hold (without RTP Media Portal)



Figure A-1 show a message flow for Music On Hold without the RTP Media Portal. This message flow does not involve the RTP Media Portal.

Figure A-1 Music On Hold message flow (without the RTP Media Portal)

Originating party

Terminating party

1. SIP: INVITE (HOLD)

2. SIP: 200 OK

SIP Application Module

MAS

4. SIP:INVITE (no SDP)

5. SIP:200 OK

6. SIP:INVITE (SDP)

7. SIP:200 OK

8. SIP:ACK (SDP)

9. SIP:ACK

Music is streaming

3. SIP: ACK

At this point, the originating client has a voice path to the terminating client.

From this point on, the originating party is listening to music while placed on hold by the terminating party.



Figure A-2 shows the message flow when the terminating party retrieves a call from Music On Hold. This message flow does not involve the RTP Media Portal.

Figure A-2 Retrieving a call from Music On Hold (without RTP Media Portal)

Originating party

Terminating party

1. SIP: INVITE (c=xxx)

2. SIP: BYE


MAS

4. SIP:INVITE (c=xxx)

5. SIP:200 OK

3. SIP: 200 OK

At this point, the originating party is listening to music while placed on hold by the terminating party.

From this point on, the terminating party has retrieved the call and has a voice path to the originating party.

6. SIP:ACK



Figure A-3 shows a failed attempt to use Music On Hold. In the message flow, the originating party is placed on hold by the terminating party but cannot hear any music. This message flow does not involve the RTP Media Portal.

Figure A-3 Music On Hold failure (without the RTP Media Portal)

Originating party

Terminating party

1. SIP: INVITE

2. SIP: INVITE


MAS

11. SIP:INVITE (HOLD)

7. SIP:ACK

3. SIP: 200 OK

At this point, the originating party has a voice path to the terminating party.

From this point on, the originating party is placed on hold by the terminating party but cannot hear any music.

8. SIP:INVITE

4. SIP: ACK


6. SIP:200 OK

9. SIP:404 Not Found

10. SIP:ACK

12. SIP:200 OK

13. SIP:ACK



Figure A-4 shows the Music On Hold message flow when the RTP Media Portal is used to route signaling, and media stream information.



Figure A-4 Music On Hold message flow (with the RTP Media Portal)

Originating party

Terminating party

9. SIP: 200 OK

2. SIP: MDCX - inactive


MAS

15. SIP:200 OK

4. SIP: 200 OK


From this point on, the originating party is listening to music while placed on hold by the terminating

10. SIP:MDCX

7. SIP: 200 OK


8. SIP:INVITE (SDP)

11. SIP:200 OK

12. SIP:ACK

13. SIP:ACK

16. SIP:MDCX

RTP Media Portal


3. SIP: 200 OK

5. SIP:ACK

14. SIP:CRCX

17. SIP:200 OK



Figure A-5 shows the message flow when the terminating party retrieves a call from Music On Hold. In this message flow the RTP Media Portal is used to route signaling and media stream information.



Figure A-5 Retrieving a call from Music On Hold (with the RTP Media Portal

Originating party

Terminating party

9. SIP: 200 OK

2. SIP: MDCX


MAS

4. SIP: BYE

At this point, the originating party is listening to music while placed on hold by the terminating party.

10. SIP:MDCX

7. SIP: 200 OK

6. SIP:200 OK


11. SIP:200 OK

12. SIP:ACK

RTP Media Portal


3. SIP: 200 OK

5. SIP: DLCX

From this point on, the terminating party has retrieved the call, and there is a voice path to the originating party.



Figure A-6 shows a failed attempt to use Music On Hold. In this scenario, the originating party is placed on hold by the terminating party but cannot hear any music. This message flow does not involve the RTP Media Portal.



Figure A-6 Music On Hold failure (using the RTP Media Portal)

Originating party

Terminating party



MAS

4. SIP: 200 OK


From this point on, the originating client is placed on hold by the terminating client but cannot hear music.

10. SIP:MDCX

7. SIP: 200 OK

6. SIP: CRCX

8. SIP:INVITE

11. SIP:200 OK

12. SIP:ACK

RTP Media Portal


3. SIP: 200 OK

5. SIP: ACK


14. SIP:200 OK

15. SIP:MDCK

16. SIP:200 OK

17. SIP:ACK

9. SIP: 404 File Not Found



Figure A-7 shows a Music On Hold message flow where both parties place each other on hold. In this message flow the RTP Media Portal is used to route signaling and media stream information.



Figure A-7 Both parties placing each other on hold (using RTP Media Portal)

Originating party

Terminating party

18. SIP: (INVITE HOLD)



MAS

4. SIP: 200 OK

19. SIP:MDCX - inactive

7. SIP: 200 OK

6. SIP: INVITE (no SDP)

8. SIP:INVITE (SDP)

20. SIP:200 OK

22. SIP:ACK

RTP Media Portal


3. SIP: 200 OK

5. SIP: ACK

27. SIP:MDCX

33. SIP:MDCK

32. SIP:200 OK

9. SIP:200 OK 10. SIP:MDCX

11. SIP: 200 OK

12. SIP: ACK13. SIP: ACK14. SIP:CRCX

15. SIP:200 OK16. SIP:MDCX

17. SIP: 200 OKMusic is streaming

21. SIP:200 OK


24. SIP:200 OK25. SIP:INVITE (SDP)

26. SIP:200 OK

28. SIP:200 OK

29. SIP:ACK

30. SIP:ACK31. SIP:CRCX

34. SIP:200 OK

No streaming is occurring

From this point on, both the originating and the terminating parties are placed on hold.

At this point, there is a voice path between the originating and terminating parties. Both clients have Music On Hold enabled in their service packages.



Figure A-8 shows a Music On Hold message flow where both parties retrieve each other from a hold state. In this message flow the RTP Media Portal is used to route signaling and media stream information. -

Figure A-8 Both parties retrieve each other from hold (with RTP Media Portal)

Originating party

Terminating party

18. SIP: 200 OK

2. SIP: MDCX


MAS

4. SIP: BYE

19. SIP: 200 OK

7. SIP: 200 OK6. SIP: 200 OK


22. SIP:MDCX

RTP Media Portal


3. SIP: 200 OK

5. SIP: DLCX

9. SIP:200 OK10. SIP:MDCX

11. SIP: 200 OK

12. SIP: ACK

13. SIP: INVITE (c=xxx)14. SIP:MDCX

15. SIP:200 OK

16. SIP: BYE

17. SIP: DLCX

Music is streaming

21. SIP:200 OK

23. SIP:200 OK24. SIP:ACK

A voice path is established

From this point onward, there is a voice path between the originating and the terminating parties. path.

At this point, both the originating and terminating parties are on hold. Both parties have Music On Hold enabled in their service package.




Figure A-9 shows a Music On Hold message flow where both parties place each other on hold. In this scenario the RTP Media Portal is not used to route signaling and media stream information.

Figure A-9 Both parties place each other on hold (without the RTP Media Portal)

Originating party

Terminating party


2. SIP: 200 OK


MAS

11. SIP:200 OK

9. SIP:ACK

3. SIP: ACK

From this point onward, both the originating and terminating parties are on hold.

4. SIP: INVITE (no SDP)

5. SIP:200 OK

8. SIP: ACK (SDP)


12. SIP:ACK13. SIP:INVITE (no SDP)

At this point, there is a voice path between the originating and terminating parties. Both parties have Music On Hold enabled in their service package.

Voice path

6. SIP: INVITE (SDP)

7. SIP: 200 OK

Music is streaming

14. SIP:200 OK

15. SIP:INVITE (SDP)

16. SIP:200 OK (IP 0.0.0.0.)

17. SIP:ACK (SDP)

18. SIP:ACK

No streaming due to IP 0.0.0.0

The IP address is 0.0.0.0 indicating that the user is on hold.



Figure A-10 shows a scenario involving Music On Hold where both parties retrieve each other from a hold state. In this message flow the RTP Media Portal is not used to route signaling and media stream information.

Figure A-10 Both parties retrieve each other from hold (without RTP Media Portal)

Originating party

Terminating party


6. SIP: ACK


MAS

7. SIP: INVITE (RETRIEVE)

8. SIP:BYE

9. SIP:200 OK10. SIP: INVITE (c=xxx)

At this point, the originating and terminating parties are on hold Both parties have Music On Hold enabled in their service package.

No streaming

1. SIP: INVITE (RETRIEVE)

2. SIP: BYE

3. SIP:200 OK

5. SIP: 200 OK

Music is streaming

11. SIP: 200 OK

12. SIP: ACK

Voice path

From this point onward, there is a voice path between the originating and terminating parties.



Appendix B Music on Hold service Installation Guide

This appendix provides a detailed description of how to install the Media Application Server platform software and the Music on Hold service software.

Music on Hold installation typesThe following subsections outline the differences in the installation procedures used to install and configure the and Music on Hold service for: • Single service instance scaling (one Pooled Entity)

— Simplex deployments

— Simplex deployments (Multi-application MAS)

— Duplex deployments

• Multiple service instance scaling (multiple Pooled Entities)

Note: Normally, for the simplex, and duplex deployments of Music on Hold, you can only install two MAS services on MAS server (Music on Hold and optionally Announcements). There is one exception to this rule: the simplex deployment of the Multi-application MAS. The Multi-application MAS deployment allows you to install up to five MAS services on the same MAS server.

Changing the MAS platform from the x335 or x336 hardware to the BladeCenter is discussed in <ref>.

ATTENTIONUse the Terminal Services Advanced Client (TSAC) for remote access to the Media Application Server (MAS).

To create a Terminal Services install disk, refer to Procedure B-28, Creating the Terminal Service install disk, on page 232.



Simplex deployment installationThe following flowchart (Figure B-1, and Figure B-2) outlines the installation procedure you must use to install the Music on Hold service in a simplex deployment configuration.



Figure B-1 Music on Hold simplex installation flow (start)

Configure MAS OS:


Install MAS platform software: Procedure B-5 on page 180

Install MAS Music on Hold ser-

vice software:


Start MAS Console:


Deactivate MAS platform and Music on Hold ser-

viceProcedure B-8 on page 192

Configure MAS platform


Configure Music on Hold ser-

vice: Procedure B-11

on page 203

Activate MAS platform and Music on Hold ser-

viceProcedure B-12

on page 204

Log in to the MOH MAS:


Transfer music files to the MOH MAS:Procedure B-15

on page 208

Continued on Figure B-2

Place MOH music files on a server

accessible from the MOH MAS:


Register your site and generate key-

codes: Procedure B-1, Procedure B-2, Procedure B-3.



Figure B-2 Music on Hold simplex installation flow (finish)

Configure Music on Hold service

Pooled Entity:


Configure Routable Services

information for Pooled Entity:


Enable Music on Hold

service in end-user service packages: Procedure B-19

on page 219

Configure the MOH music files on the

MAS: Procedure B-16

on page 209

Continued fromFigure B-1

End



Simplex deployment installation for Multi-application MASThe Multi-application MAS deployment enables you to install the following MAS services on the same MAS platform:

• Ad Hoc Audio Conferencing service

• Meet Me Audio Conferencing service

• Music on Hold service

• Announcements service

• IM Chat service

The flowchart in Figure B-3 provides a high-level view of the steps you must follow to perform a Multi-application MAS installation.

Note: During the Multi-application MAS installation, you need only perform the configuration steps that are common to all five MAS services once.

ATTENTIONFor the Multi-application MAS deployment you can install from two to five MAS services on the same MAS platform; however, for the sake of simplicity, this document assumes that you are installing all five MAS services. You may install the five MAS services in any order.

The actual procedures for installing, and configuring each MAS service is found in the respective MAS service guide. For example, the Announcements procedures are found in the MAS Announcements Service Guide (NN10379-113), IM Chat procedures are found in the MAS IM Chat Service Guide (NN10380-113), and so on. (Check the Installation Appendix in each service guide for the appropriate installation and configuration procedures.)



Figure B-3 Simplex Music on Hold installation flow for Multi-application MAS

Install MAS Ad hoc, Meet Me, Music on Hold, Announcements, and IM Chat service software, one after another; however do not perform a restart of the Windows operating system (OS) until you have installed the last

MAS service.Use the installation procedures found in the

Installation Appendices of the respective MAS service guides.

For example, to install Music on Hold service software perform Procedure B-6 (see the

flowchart in Figure B-1).

Install the MAS platform software.

The procedures for doing this are found in the Instal-lation Appendix of each MAS service guide, and

these procedures are identical in every guide.

For example, in this guide the procedures to install the MAS platform are listed in the flowchart found in Figure B-1 and consists of: Procedure B-1 to

Procedure B-5.

Configure and enable each MAS service (one after another) using the procedures found in the

respective MAS service guides.

For example, to configure and enable Music on Hold, perform procedures Procedure B-7 to

Procedure B-19. (see the flowchart in Figure B-1 and Figure B-2.

End



Duplex deployment installationIn general each node in the duplex deployment is installed and configured using the same steps as are outlined in the simplex deployment installation flowchart (Figure B-1, and Figure B-2). However, duplex deployments require two minor adjustments to those installation and configuration procedures, allowing mirroring between the two Media Application Server machines to occur.

The differences in installation and configuration for duplex deployments are:

• System configuration parameter mirroring – During configuration of the Media Application Server platform software, additional parameters must be configured so that the two Media Application Servers can communicate with each other for mirroring purposes:

After configuring the simplex system configuration parameters of the Media Application Server platform software (Procedure B-9 on page 194) use Procedure B-10 on page 201 to configure the additional platform system configuration parameters that allow mirroring to occur between the two Media Application Server nodes.

• Pooled entity reuse – When configuring the pooled entity datafill for the secondary Media Application Server node, a new pool is not created:

For Procedure B-17 on page 212 (Create pooled entity for Music on Hold service) do not create a new Music on Hold pooled entity. Instead, edit the existing Music on Hold pooled entity that was created during installation and configuration of the first Music on Hold server node (for example, moh_pool). Add a route to the secondary node in the this existing pooled entity definition.

Multiple service instance installationIn addition to scaling a simplex Music on Hold service instance into a duplex installation, scaling can also be achieved by creating additional Music on Hold pooled entities. Each additional Music on Hold pooled entity can also be scaled as either a simplex or duplex installation.

Installation procedures for additional pooled entities are identical to single pooled entity installations as outlined in the simplex deployment installation flowchart (Figure B-1, and Figure B-2). However, to differentiate between pooled entities, each additional Music on Hold pooled entity must have a unique name.



Background to registering your MCS system, and generating keycodes

During the installation of Media Application Server (MAS) software, you are required to supply a keycode (license key) for the features installed on the MAS. Before you can install the MAS software, you need to register your site and generate the keycode for the MAS features (or services) that you have purchased. You are required to input the keycode during software installation.

Note: For the Multi-application MAS deployment you need only one keycode.

The following procedures are included in this chapter to instruct you on how to register your system (site) and generate the necessary keycode:

• Registering your MCS system, and generating keycodes

• Generating keycodes for a Media Application Server

• Expanding a system by adding a Media Application Server (optional)

Note: You may have already completed one or more of the procedures in the preceding list. If you have already generated your keycode (license key) for the software installation of the Media Application Server hosting the Music on Hold service, then go directly to the procedure Procedure B-4, Configuring MAS OS for your network, on page 173.

Registering your MCS system, and generating keycodesBefore you can begin generating keycodes, you must first “Register” (or create) your site on the KRS (Keycode Retrieval System) webpage. The site normally consists of one or more Management and Accounting servers (known as the Core) and one or more Media Application Servers (known as the Media Server).

Each server will have two (2) MAC addresses. You must determine those MAC addresses because you need to identify them to the KRS during the site registration process. The following screen shots will show a simple configuration and generation of one keycode for the management and accounting servers (Core), and one keycode for the Media Application Server.

Procedure B-1 Registering you MCS system, and generating



keycodes

At the management PC

1 Open your Web browser and go to the following URL: http://www.nortel.com/index.html

2 From the main Nortel Web page, expand the Support and Training menu, then select the Keycode Retrieval command.

3 In the Step 1 field, use the drop-down menu to select the location of the KRS server to which you wish to log in.

ExampleNorth American Login

http://www.avaya.com



4 In the Step 2 field, use the drop-down menu to select Multimedia Communication Portfolio as the product family whose keycodes you wish to register.

5 Press the Go button to jump to the secure Log In page.

Go button



6 Enter your User ID and password, then press the Log In button.

The Keycode Retrieval System page appears.

Login button



7 Click on the Create button to register a new system.

A screen appears where you identify your company site.

Create button



8 Fill in the company name for your site, and the city, then use the drop-down menus to select the country, and state (or province), then press the Continue button.

Note: In this procedure it is assumed that the location is North America.

A screen appears where you indicate the type of server you are registering.



9 Select which server server that you want to enter MAC addresses for, then click on Create.

Note: This procedure assumes that you are adding the Management and Accounting Server (Core) first, followed by a Media Application Server.

A page appears where you add the first MAC address.



10 Enter the first MAC address of the server, then click on the Add button.

11 Repeat step 10 for the second MAC address of the server.

Note: If you make an error, you can remove one or both and begin again. If you have a second Core server, that is going to be installed as a redundant server, enter all four MAC addresses at this time.

12 Repeat steps 9, 10, and 11 this time for the Media Application Server .

Note: In step 9 you must select MEDIA SERVER. In steps 10, and 11, you must add the two MAC addresses for the Media Application Server.



13 If you have a second Media Application Server for your system, you must repeat steps 9, 10, and 11 for the second MAS, since only two MAC addresses can be associated with any one Media Application Server.

Note: If you do not have a second Media Application Server, proceed now to step 14.

14 After you have added both MAC addresses of the last Media Application Server, click on the Continue button.

The system displays a summary page of your entries.

Continue button



15 Click on Save to complete registering your system (or click on Cancel and begin again).

The system displays the following Web page

Save button



16 Click on the Gen KC with Auth Code link (in the side bar) to proceed to Generate Keycodes for this site.

A page is displayed where you identify your system.



17 To generate your keycodes, first, enter one of the MAC addresses of the server to which you want to apply your Auth code.

Note: The example Web page in the figure shows the MAC addresses of the CORE.

18 Click on the Add button.

Note: The KRS automatically searches for and pulls up both MAC addresses associated with the CORE.

The now system displays both MAC addresses

Add button



19 Click on the Continue button.

The system displays a page where you identify the software version of your system



20 Select the proper Software Version for your system, then click the Continue button.

The system displays a page where you enter your Auth Code.

Continue button



21 Enter the authcode number for the feature you wish to enable.

Note: Use your system Authorization codes to build your license key file.

22 Select Add to have the KRS accept the authcode.

Note: The KRS will validate the authcode and ensure the features represented are valid for your server type (CORE or MAS). If validated successfully you will be allowed to enter more authcodes until you've entered all the codes for your server.

23 When this process is complete, click on the Continue button.

Add buttonContinue button



The system displays a summary of the features

Note: The following example shows a summary of the features represented by all the sample authcodes entered. This screen shows the current features enabled and the new features to be added to your server. In a new installation there are no features displayed.

24 If the list is correct, click on the Continue button.

Note 1: The KRS will indicate it is generating your keycodes and saving the results in its database. After generating the keycodes, the system shows the Retrieve Keycode page where you can view the features enabled for the server. From this page you will be able to download the keycode (see the figures below). The screens show the features of your

Continuebutton



keycode and the option to download the keycode to your local PC.

Note 2: The two figures (that follow) are actually two sections of a single Web page. Because of the large size of the Web page, it is shown as two figures.



25 To download the keycode click on the Download Keycode button.

Note: You are then asked to save the keycode file to your PC. The file is provided with a product-specified naming convention.

26 Download the new license key file to the MgmtSvr hard drive. You will need the license key during the installation of Media Application Server software.

Generating keycodes for a Media Application ServerThis procedure instructs you on how to generate keycodes for the Media Application Server. This procedure assumes that you have

Download button



already registered your site on the KRS (Keycode Retrieval System) Web page.

Procedure B-2 Generating Media Application Server keycodes

At the management PC

1 If you are already logged in to the Keycode Retrieval System (and you have registered your site), then go to step 8, otherwise go to step 2.


3 From the main Nortel Web page, expand the Support and Training menu, then select the Keycode Retrieval command.








Go button





Login button



8 Click on the Gen KC with Auth Code link (in the side bar) to proceed to Generate Keycodes for the Media Application Server,

A page is displayed where you identify your system.



9 To generate your keycodes, first, enter one of the MAC addresses of the Media Application Server to which you want to apply your Auth code.

Note: The example Web page in the figure shows the MAC addresses of the MEDIA SERVER.

10 Click on the Add button.

Note: The KRS automatically searches for and pulls up both MAC addresses associated with the Media Application Server.

The system now system displays both MAC addresses

Add button




The system displays a page where you identify the software version of your system

Continue button



12 Select the proper Software Version for your system, then click the Continue button.

The system displays a page where you enter your Auth Code.

Continue button



13 Enter the authcode number for the feature you wish to enable.

Note: Use your system Authorization codes to build your license key file.

14 Select Add to have the KRS accept the authcode.

Note: The KRS will validate the authcode and ensure the features represented are valid for your server type (CORE or Media Server). If validated successfully, you will be allowed to enter more authcodes until you've entered all the codes for your server.

15 When this process is complete, click on the Continue button.

The system displays a summary of the features

Note: The following example shows a summary of the features represented by all the sample authcodes entered. This screen shows the current features enabled and the new

Add buttonContinue button



features to be added to your server. In a new installation there are no features displayed.

16 If the list is correct, click on the Continue button.

Note 1: The KRS will indicate it is generating your keycodes and saving the results in its database. After generating the keycodes, the system shows the Retrieve Keycode page where you can view the features enabled for the server. From this page you will be able to download the keycode (see the figures below). The screens show the features of your keycode and the option to download the keycode to your local PC.

Continuebutton



Note 2: The two figures (that follow) are actually two sections of a single Web page. Becasue of the large size of the Web page it is shown as two figures.



17 To download the keycode click on the Download Keycode button.

Note: You are then asked to save the keycode file to your PC. The file is provided with a product-specified naming convention.

18 Download the new license key file to the MgmtSvr hard drive.

Download button



Expanding a system by adding a Media Application ServerThis procedures provides the steps for adding another Media Application Server to your system.

Note: This procedure assumes that you have already registered your system.

Procedure B-3 Adding an additional Media Application Server to your system

At the management PC,

1 Determine the MAC address of the new Media Application Server that you are adding to the system.

2 If you are already logged in to the Keycode Retrieval System (and you have registered your site), then go to step 8, otherwise go to step 2.


4 From the main Nortel Web page, expand the Support and Training menu then select the on Keycode Retrievalcommand.

MAC addresses of new Media Application Server






Go button





Login button



9 Click on the Product Registration link (in the side bar).

A page is displayed where you identify your site name.



10 Enter the site name you wish to edit, or any of the MAC addresses previously assoicated with the site, then click on the Search button.

Note: When the site is found by the KRS system, the system displays the site name.

A page appears showing the site name in a drop-down menu.

Search button




Note: The information that you entered when you first registered the site appears. You can edit this information if you wish.

Continue button



12 Once you are satiisfied that the information is correct, then click on the Continue button.

The system displays a page where you can add the new Media Application Server.



13 Add the new Media Application Server to your system by selecting MEDIA SERVER from the drop-down menu, then press the Create button.

The system displays an empty MEDIA SERVER field for entering MAC data.

MEDIA SERVER



14 Enter a MAC address for the new Media Application Server in the MEDIA SERVER field, then press the Add button.

15 Repeat step 14 for the second MAC address, then go to step 16.

The system displays both of the MAC addresses that you have entered.



16 Verify that the MAC addresses you entered are correct, then click on the Continue button.

The system displays a summary page.

Continuebutton



17 Verify that the data is correct and click on the Save button, or else click on Cancel.

Note: You have completed the procedure to add the Media Application Server to your system; however, you still need to generate keycodes for this Media Application Server.

Configuring MAS OSThe MAS hardware comes with the Operating System pre-installed and pre-configured for optimal performance. The following procedure



covers the remaining configuration steps needed to get the MAS hardware working with your network topology.

The following steps must be performed:

• Change computer name

• Change TCP/IP Hostname

• Assign static IP address

Procedure B-4 Configuring MAS OS for your network

at MAS server

1 Power up the MAS server for the first time, and mount MAS CD in CD-ROM drive.

at the administrator’s PC


The Terminal Services Client window displays.

ATTENTIONThe MAS x335 and Blade Center hardware comes pre-provisioned using an IP address of 10.1.1.1. The MAS x336 hardware comes pre-provisioned using an IP address of 10.0.0.1.

A laptop or desktop PC is used to configure the MAS OS remotely, by use of the Terminal Services Advanced Client (TSAC). The laptop or desktop PC can be connected directly to the MAS by using an ethernet crossover (twisted) cable, or both the PC and the MAS can be connected into a hub using standard ethernet cables.

ATTENTIONChange the default password as soon as possible after logging on.



3 In the Server field, enter the IP address of the Media Application Server. Enter the IP address in Example 1 for the MAS x335 and Blade Center and enter the IP address in Example 2 for the MAS x336.

Example 1

10.1.1.1

Example 2

10.0.0.1

4 Click Connect to start a connection to the Media Application Server.

at the logon window

5 Use the default username.

ExampleNortelMASAdmin

6 Use the default password.

Examplenortel



at OS desktop

7 Right-click the My Computer icon and select Properties and select the Network Identification tab.

8 Click the Properties button and assign a hostname to the system (the computer name must be 15 characters or less).



9 Click OK.

Note: Do not reboot when prompted.

at Start menu

10 Select Start > Run to bring up the Run dialog window

11 Type regedit to and click OK launch the Registry Editor window.

12 Traverse to and update the following value in the registry value pair:

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters

Value: NV HostnameType: STRING value (REG_SZ)Content: <Hostname of the server>

13 Select Registry > Exit to close the Registry Editor window.



at Start menu

14 Select Start > Settings > Network and Dial-up Connections.

The Network and Dial-up Connections window displays:

15 Right-click the MASTeam icon and select Properties.

The MASTeam Properties window displays:



16 Select Internet Protocol (TCP/IP) and press the Properties button.

The Internet Protocol (TCP/IP) Properties window displays:



17 Enter the static IP address and subnet mask for your network topology.

Note: You must change the IP address and subnet mask. However, do not configure WINS or any other Advanced settings.

18 Click OK in the Internet Protocol (TCP/IP) Properties window.

19 Click OK in the MASTeam Properties window.

20 Reboot the machine.

Installing the Media Application Server platform and service softwareIn this section, you will install all Media Application Server internal subcomponents and the purpose-built Microsoft Management Console that provides local access to the administrative and management



capabilities of the Media Application Server, and the Music On Hold service software.

Procedure B-5 Installing the Media Application Server platform

at the Media Application Server1 Locate the Media Application Server platform installation

program and double-click the executable.

The Media Application Server Install Wizard displays:

ATTENTIONYou must install each MAS-based service on a separate Media Application Server.

There is one exception to this rule: You can install the Music on Hold service, and Announcements service on the same Media Application server.

Installation of multiple services on the same MAS server nullifies the Licensing Agreement.



2 Click the Next button to continue.

The License Agreement statement displays:



3 Select the I accept the terms of the license agreement option.


The Network Information window displays:

5 Enter the Service Logical IP address (also called Network Service Descriptor, or NSD), and SIP UDP port for each SIP Application Server (also called the SIP Application Module) that must communicate with the Media Application Server.

Note: The Media Application Server only accepts incoming service requests from IP and ports specified in this list. This prevents unauthorized nodes from sending service requests directly to the Media Application Server.


The License Key window displays:



7 If the license configured for this hardware platform is available, enter it into the License Key field.

Note: If the license key is not available at this time, then it can be entered later using the Media Application Server Management Console.


The Primary Destination Folder displays:



9 If you want to install the Media Application Server into a different directory, click the Change button to select a different destination drive partition and/or directory.

Note: It is highly recommended that the default destination drive partition (D:) and folder (Program Files\Nortel Networks\MAS) be used.


The Content Storage Destination Folder displays:



11 If you want to locate the Media Application Server Content Storage into a different directory, click the Change button to select a different destination drive partition and/or directory.

Note 1: It is highly recommended that the default destination drive partition (D:) and folder (Program Files\Nortel Networks\MAS) be used.

Note 2: If the Media Application Server has the dual SCSI expansion unit connected to it, then the content store destination should be the SCSI drive partition (E:).


The Ready to Install the Program screen displays:



13 Click the Install button to perform the actual installation.

Note: The installation can be aborted at any time by pressing the Cancel button.

When complete, the InstallShield Wizard Completed screen displays:



14 Click the Finish button to end the installation program.

15 If this was a new installation, or if an alternative destination directory was specified earlier in the Primary Destination Folder or Content Store Destination Folder panes, then the following prompt will appear to notify you that a restart is required in order to complete the installation.

During first time installations, the restart operation can be delayed until after the Music on Hold service software is installed.

Note: If this installation was performed on a server that had previously been configured as a Media Application Server (for example, this is an upgrade installation) then a restart is NOT required.



16 Click the No button to delay the system restart until after installation of the Music on Hold service software is completed.

Procedure B-6 Installing the Music on Hold service software

At the Media Application Server1 Locate the Media Application Server platform installation

program and double-click the executable.

The Media Application Server Install Wizard displays:


The License Agreement statement displays:



3 Select the I accept the terms of the license agreement option.


The Ready to Install the Program screen displays:



5 Click the Install button to perform the actual installation.

Note: The installation can be aborted at any time by pressing the Cancel button.

When complete, the InstallShield Wizard Completed screen displays:

6 Click the Finish button to end the installation program.

7 For first time installations, the restart operation that was skipped after installing the Media Application Server platform software, must now be performed.

From the Windows Start menu, click Start > Shut Down... to display the Shut Down Windows dialog box.



8 Select Restart from the pull-down menu and click the OK button to restart the server.

Starting the Media Application Server Management ConsoleOnce the Media Application Server software has been successfully installed, the MAS Management Console is used to configure the Media Application Server and the Music on Hold service.

Procedure B-7 Starting the Media Application Server Management Console program

from the Media Application Server

1 Click Start > Programs> Nortel Networks Media Application Server> Media Application Server Console.

The MAS Management Console GUI displays:

Deactivating the Media Application ServerWhenever the MAS machine is rebooted, the MAS and the Music on Hold service are automatically started. Since a machine reboot is part of new MAS installations, the MAS and the Music on Hold service are automatically started when you complete installation of the MAS software.



Prior to configuring the Music on Hold service, it is necessary to deactivate the service.

Procedure B-8 Deactivating and verifying offline state of the Media Application Server and conferencing service

at the Media Application Server console tree

1 Right-click the Control Panel icon in the console tree to display the following shortcut menu:

2 Select Operations > Stop to deactivate the Music on Hold service.

The Media Application Server stops.



Note: The status should indicate offline.

3 Verify that all the individual subcomponents have all successfully stopped by right-clicking on the Control Panel icon and selecting View System Components.



Note: All subcomponents should indicate offline.

Configuring the Media Application Server platform and service software

You must configure both the Media Application Server platform, and the Music on Hold service.

Note: In duplex deployments, you must configure additional Media Application Server system configuration parameters. Procedure B-10 tells you how to configure these additional system parameters for duplex deployments. If your are installing a simplex deployment, then ignore Procedure B-10.

Procedure B-9 Configuring the Media Application Server platform

At the Media Application Server Console

1 From the console tree panel, select the Services > System > Configuration icon.

The details panel displays all configuration data for the Media Application Server platform.

ATTENTIONThis procedure assumes that the Media Application Server is offline. If the MAS has not already been deactivated, then deactivate it before refer to attempting to configure the MAS platform software. Refer to Procedure B-8 on page 192 for more information.

Attention The MAS Console displays the entire list of system parameters; however, for the Music on Hold service, you only need to configure the following required system parameters: Content Store Servers, IVR Audio Port Range Starting Port, License Alarm Threshold, License Key, Local Hostname or IP Address, and Local SIP UDP Port. All other system parameters are either optional, or not used by the Music on Hold service. In Table B-1, the parameters that are applicable (or optional) to Music on Hold are highlighted in grey.



2 Use the values from Table B-1 to configure the following required parameters for the simplex deployment of the Media Application Server: Content Store Servers, IVR Audio Port Range Starting Port, License Alarm Threshold, License Key, Local Content Store Activated, Local Hostname or IP Address, Local SIP UDP Port, and Media Processing Units.

Note: In Table B-1, the parameters that you must configure (required parameters), and those parameters that are optional for the simplex deployment of Music on Hold are highlighted in gray.



Table B-1 Overview of simplex system configuration parameters (Sheet 1 of 4)

Name of parameter Fields Description

Conference Port Range Starting Port

Optionality: Required

Valid Values: 1-65535

Default: 53500

Not used by the Music on Hold service.

The Conference Media Processor uses a range of ports to provide service. This value specifies the lower limit of the range RTP/RTCP starting port range.

Content Store Mirrored Peer Server

Optionality: Optional

Valid Values: Must contain a single valid IP address.

Default: blank

Not used for simplex deployment of Music on Hold service.

This item contains the IP address of the peer Content Store for mirrored deployments.

For a simplex deployment, this value should be blank.

For a duplex deployment, it should contain the IP address of the peer MAS server.

For a 3-way deployment, two servers should be configured as peers and this value on the third server should be blank.

Content Store Servers


Valid Values: Must contain at least one valid IP address of a MAS server hosting a Content Store.

Default: Local IP address.

This item contains a semi-colon delimited list of MAS servers hosting Content Stores. The Multimedia Controller will use the Content Stores defined in this list.

Controller Peer Backup Server


Valid Values: Must contain at least one valid IP address of a MAS server.

Default: blank.


This item contains the IP address of the backup CPLink MAS server for duplex and n-way deployments.



Controller Peer Primary Server


Valid Values: Must contain at least one valid IP address of a MAS server.

Default: blank.


This item contains the IP address of the primary CPLink MAS server for duplex and n-way deployments.

Enable RTFT (YES/NO)


Valid Values: YES, NO

Default: NO


Whether or not Real-Time File Transfer is used to transfer data between content store components. Do not modify this value.

IVR Audio Port Range Starting Port


Valid Values: 1-65535

Default: 57500

The IVR Media Processor uses a range of ports to provide service. This value specifies the lower limit of the range.

License Alarm Threshold


Valid Values: 1 to 100

Default: 90

The threshold (as a percentage of available licenses) after which subsequent calls will cause an alarm to be raised.

License Key Optionality: Required

Valid Values: 1 to 1024 characters

Default: blank

The license key for the MAS server.

Local Content Store Activated



Default: YES

Whether or not the local content store is active on the MAS server.

Local Hostname or IP Address


Valid Values: Must contain one valid IP address of the MAS server.

Default: Local IP address

The IP address of the MAS server.





Local SIP UDP Port


Valid Values:1 to 65535

Default: 5060

The local UDP port for SIP messaging (default is 5060).

Media Processing Units


Default: 350

Do not modify this value without consulting the MAS Engineering guide. This parameter us the number of Media Processing Units available for this server. This value is influenced by the number of processors, speed of processors, and other performance characteristics of the server.

SIP Application Server(s)


Valid Values: A semi-colon delimited list of IP addresses and ports of Sip Application Modules.

Default: blank

This item contains a semi-colon delimited list of IP addresses and ports of Sip Application Modules. Each listed server will be considered a trusted node and requests from those servers will not require authentication. The first entry in the list is used for outbound messages from the media server. A value must be provided to enable transfers and other outbound requests from the MAS server.

SNMP Community Strings


Valid Values: A semi-colon delimited list of SNMP Community Strings.

Default: public

This item contains a semi-colon delimited list of SNMP Community Strings.Note: For information on changing the default value of “public”, see the section on Network Considerations in MCS 5100 MAS Network Deployment and Engineering Guide.

SNMP Management Server


Valid Values: IP address

Default: blank

This item contains the IP address of a third-party SNMP server.





SNTP Source Server


Valid Values: localhost, 127.0.0.1, or a valid IP address of a designated SNTP time source server.

Default: blank


The IP address of an SNTP time source server. Specify 'localhost' or ‘127.0.0.1’ to designate the local server as a time source. If the local server is designated as a time source, the Windows® time service will automatically be restarted to accept the configuration change. For deployments, the SNTP Source Server should be the Management Server.

Stream Source Destination Server(s)


Valid Values: A semi-colon delimited list of IP addresses of MAS servers.

Default: blank


This item contains a semi-colon delimited list of IP addresses of destination server(s) that should receive media from the local stream source component.

Syslog Server Optionality: Optional

Valid Values: Must contain one valid IP address of the SysLog server.

Default: blank

IP address or hostname and port of a SysLog server. The default port is 514.

Video Switching Hysteresis (ms)

Optionality: OptionalValid Values: 10 to 10000 milliseconds

Default: 600


Is the time in milliseconds that a participant must assume the role of dominant speaker before the software begins transmitting their DivX video image to other conference participants. Note: Changing the default value may result in an unpleasant user experience.





3 Double-click on a system configuration parameter (in the MAS Console) to display the properties dialog window for that configuration parameter.

4 Enter or modify the parameter’s value. Refer to Table B-1 for descriptions of the parameters and their default values.

5 Click OK to save your changes.



Procedure B-10 Configuring the Media Application Server platform (Duplex)

at the Media Application Server Console

1 From the console tree panel, select the Services > System > Configuration icon.

The details panel displays all configuration data for the Media Application Server platform.

2 The MAS Console displays the entire list of system configuration parameters for the platform software. Some configuration parameters are applicable to allow Media Application Server deployments, and should be configured as outlined in Procedure B-9 on page 194. In duplex deployments, some additional system configuration parameters must also be

ATTENTIONThis procedure assumes that the Media Application Server is offline. If the MAS has not already been deactivated, then deactivate it before refer to attempting to configure the MAS platform software. Refer to Procedure B-8 on page 192 for more information.



configured. Table B-2 describes the parameters applicable for the duplex deployments of the Music on Hold service that you must configure.

3 Double-click on a system configuration parameter to display the properties dialog window for that configuration parameter.

4 Enter or modify the parameter’s value. Refer to Table B-2 for descriptions of the parameters and their default values.

5 Click OK to save your changes.

Table B-2 Overview of duplex system configuration parameters


Content Store Mirrored Peer Server


Valid Values: Must contain a single valid IP address.

Default: blank

This item contains the IP address of the peer Content Store for mirrored deployments.

For a duplex deployment, it should contain the IP address of the peer MAS.

Content Store Servers


Valid Values: Must contain at least one valid IP address of a MAS hosting a Content Store.

Default: Local IP address.

This item contains a semi-colon delimited list of Media Application Servers hosting Content Stores. The Multimedia Controller will use the Content Stores defined in this list.

For a duplex deployment, it should contain the IP address of the local MAS.

Controller Peer Primary Server


Valid Values: Must contain at least one valid IP address of a MAS.

Default: blank.

This item contains the IP address of the primary CPLink MAS for duplex deployments.

For a duplex deployment, it should contain the IP address of the peer MAS.

Enable RTFT (YES/NO)



Default: NO

Whether or not Real-Time File Transfer is used to transfer data between content store components. Do not modify this value.

Local Content Store Activated



Default: YES

Whether or not the local content store is active on the MAS.

For a duplex deployment, both content stores should be activated.



6 Repeat steps 3 through 5 for each system configuration parameter you wish to change.

Procedure B-11 Configuring the Music on Hold service

At the Media Application Server Console

1 There is no Music On Hold Configuration that you are required to perform at the MAS console.

The details panel indicates that there is no configuration data for the Music on Hold service.

ATTENTIONThis procedure assumes that the Media Application Server is offline. If the MAS has not already been deactivated then deactivate it before attempting to configure the Music on Hold service software. Refer to Procedure B-8 on page 192 for more information.



Activating the Media Application Server to provide serviceAfter successful configuration of the Media Application Server and the Music on Hold service, you can re-activate the Media Application Server.

Procedure B-12 Starting the Media Application Server

at the Media Application Server console tree

1 Select the Control Panel icon to view the offline status of the Media Application Server.

Note: If the details panel displays the individual Media Application Server components, right-click the Control Panel icon and select View System Components to turn off the component view of the Media Application Server.

2 Right-click the Control Panel icon in the console tree to display the following shortcut menu:



3 Select Operations > Start to bring the Media Application Server into operation.

The Media Application Server starts.

Note: The status should indicate online.



4 Verify that all the individual subcomponents have all successfully started by right-clicking on the Control Panel icon and selecting View System Components.

Note: All subcomponents should indicate online.

Placing music files on a Media Application Server that is hosting Music on Hold

You must physically transfer music files to one Media Application Server within the Music on Hold pooled entity. You only need to place music files on one Media Application Server in the service instance, because music files are replicated by the system throughout the service instance.

ATTENTIONThe Music on Hold service does not support external media source files. All media source files must be in Wave File format and be resident on the Media Application Server on which the Music on Hold service is running (simplex deployment)—or the music files must be on one of the Media Application servers (duplex deployment) in the Pooled Entity.



The music files that you place on the MAS must meet certain criteria. These music files must be

• in Wave File format

• encoded as a single channel (mono) linear 16-bit bit stream using pulse code modulation (PCM) that is sampled at 8 kHz

At run time, the MAS transcodes the music files to the client settings, encoding the digital bit stream using the G.711 or G.729 transmission algorithm. The music files are transmitted with a packet time of 10, 20, 30, or 60 milliseconds. To place music files on a MAS, you must perform the following procedures:

To place music files on a MAS, you must perform each of the following procedures:

• Place music files on a server that can be accessed by the Music on Hold Media Application Server

• Log in to the Music-on-Hold MAS

• Transfer music files to the Music-on-Hold MAS

• Configure the music files on the Media Application Server

Procedure B-13 Place music files on a server that can be accessed by the Music on Hold Media Application Server

On a server that allows passive FTP access from the MAS

1 Place the music files on a server that is set up to allow passive FTP access from the Music-on-Hold MAS.

Note: The Music on Hold MAS, that is referred to here, is the MAS to which the music files will ultimately be transferred.

Procedure B-14 Log in to the Music-on-Hold MAS

At the administrator’s PC


The Terminal Services Client window appears.



2 Enter the IP address, or if available, select the hostname from the Available Servers list, of the machine you wish to connect to.

3 Click Connect to start a connection to the specified IP address or machine name.

Procedure B-15 Transfer music files to the Music-on-Hold MAS

At the MAS on which the music files are to be transferred

1 Launch the passive FTP client, located in the tools folder of the MAS platform files on the D: drive of the Music on Hold MAS.

Note: The server that is referred to here is the one on which the music files were placed in Procedure B-13. Alternatively, you can launch the Microsoft Internet Explorer application (from the Start > Programs > Internet Explorer menu), and use the passive FTP functionality of the browser to transfer the announcement files.



2 Within the FTP client window, input the command (for example, ftp 47.29.45.81) to establish a passive FTP connection to the remote server on which you placed the announcement files (supply your ID, and password when prompted).

3 Use the passive FTP client to get the music files from the remote server to the D: drive of the Music on Hold Media Application Server.

Note: The server that is referred to here is the one on which the announcement files were placed in Procedure B-13.

Procedure B-16 Configure the music files on the Media Application Server

At the MAS on which the music files reside

1 Launch the DOS Command Prompt screen, by selecting Start > Programs > Accessories > Command Prompt.

ATTENTIONYou must place the music files on the D: drive of the Media Application Server. There is no room on the C: drive.

Passive FTP clientin the tools folder of the MAS platform software



The Command Prompt screen appears

2 Create a music folder on the MOH MAS in which to group the music files, by typing:

> provtool moh_create_folder <domain> <folder>

where

<domain>is the provisioned domain or sub-domain in which the Music on Hold service will be available

<folder>is the named set of music files (similar to a standard file system directory or folder)

Exampleprovtool moh_create_folder nortel.com MOH_music

3 Upload music files into the music folder, by typing:

> provtool moh_upload_media <domain> <folder> <media file>



where

<domain>is the provisioned domain or sub-domain in which the Music on Hold service will be available

<folder>is the named set of music files (similar to a standard file system directory or folder)

<media file>is the name of he music file (in Wave File format) that you wish to place in the music folder (you must include the path to the file).

Exampleprovtool moh_upload_media nortel.com MOH_music D:\music1.wav

Note: For a complete list of commands available using the Provisioning Tool, input the following command: provtool help.

ATTENTIONTo delete audio files from a Media Application Server (either single audio files, or an entire folder) you must first lock the Media Application Server. For information on locking the Media Application Server, see Locking the Media Application Server. After you having finished deleting the files you must unlock the Media Application Server (see Unlocking the MAS).



Enabling service access to the Music on Hold serviceEnabling service access allows the network to route Music on Hold service requests to the Music on Hold service. Configuring service access to the Music on Hold service consists of the following steps:

• Create pooled entity for Music on Hold service

• Configure Routable Services information for the Music On Hold Pooled Entity

• Enable the Music on Hold service in the end user service packages

The configuration tasks described here use provisioning tasks that have been described in detail in the Provisioning Client User Guide document.

Procedure B-17 Create pooled entity for Music on Hold service

From the Provisioning Client

1 In the domain where access to the Music on Hold service is needed, select Pooled Entities > Add Pooled Entity. An Add Pooled Entity page appears.



2 In the Entity Name field, enter the name of the pool entity.

Examplemoh-pool

Note: You are not allowed to use under scores or spaces in the name; however, you are allowed to use hyphens.

3 In the Routable Services drop-down menu, select Music On Hold.

4 In the Selection Algorithm drop-down menu, select Weighted Average.

5 In the Location drop-down menu, select the location for the pooled entity

Note: The location field enables the domain administrator to associate the pooled entity resource to a system domain



location. The system domain location hierarchy is provisioned by the system administrator with the purpose of mapping components such as the Media Application Server, and gateways to a location. Associating a location to a pooled resource helps determine when a media portal is required for a voice path.

ExampleOther

6 In the Route field:

a Enter the route used to connect to a Media Application Server on which the Music on Hold service resides in the pooled entity. This is the IP address of the MAS, preceded by the prefix “sip:” and ending with the suffix “;trusted”.

Examplesip:47.47.47.49;trusted

b Enter the selection Weight (from 0 to 10) to use when routing Music on Hold service requests. Keep the following guidelines in mind when assigning weights to routes:

• Routes with a zero weight are disabled.

• A higher weight means that the MAS (defined by this route) receives more incoming Music on Hold requests.

• At least one route must be defined before the pooled resource can be added.

• The total weight of all routes may be zero.

• The percentage of the total weight for each route is calculated automatically.

Example1

c Click the Add button to add the new route to the Routes Selected list

Note: Existing route weights may be modified by highlighting the desired route, changing the weight value in the Weight (0-10) text box, and click the Add button.

7 Repeat step 6 for each MOH Media Application Server within the pooled entity (or service instance).

8 Click Save when done, or Cancel to exit the Add Pooled Entity page without saving.

Procedure B-18 Configure Routable Services information for the



Music On Hold Pooled Entity


1 In the domain where access to the Music on Hold service is needed, select Routable Services > Music on Hold > Create Music Folder.

A Create Music Folders page appears.

Note: In this step you are identifying the music folder(s) (containing music files in Wave File format) that you have already placed on one of the MAS in the Music-on-Hold pooled entity (service instance).

2 From the list of MOH pooled entities available in this domain, choose one to which you wish to assign a music folder(s). Then, click on the Edit Folders link to the right.

Note: You created the pooled entities for Music on Hold in Procedure B-17 on page 212.

A new page appears where you can define a music folder(s) for the pooled entity.

List of Music-on-Hold pooledentities

Link to the Edit Folderspage



3 In the New Folder field, type in the name of a music folder, and click on the add button.

Note: You must already have physically uploaded this music folder (containing music files in Wave File format) onto one of the MAS in this pooled entity. (See Configure the music files on the Media Application Server.)

4 Repeat step 3 for each additional music folder that you wish to add.

A list of music folders now appears in the Current Folders field.

5 Click Save, when done.

The system responds: “Music Folders were modified successfully.”

6 In the domain where access to the Music on Hold service is needed, select Routable Services > Music on Hold > Assign Music Folders.

This is the name of a music folderthat is installed on one of the MAS (in this pooled entity)

Adds a new folder

Folders appearhere after pressing Add

to the CurrentFolders list



The Modify Music on Hold Pool page appears.

7 From the drop-down menu, select the pooled entity you have created for the Music on Hold service.

Note: You created the pooled entities for Music on Hold in Procedure B-17 on page 212.

8 Press the Next button, when you have selected the MOH pooled entity.

The Assign Folder page appears.

Drop down menu of MOH pooled entities



9 Display the drop-down menu for the Select Folder field, then, select from the list the Music on Hold folder that you defined in step 3.

10 Press the Save button.

A confirmation screen appears.

Drop-down menu ofmusic folders



Procedure B-19 Enable the Music on Hold service in the end user service packages


1 In the domain where access to the Music on Hold service instance is needed, select Service Package > List Packages. The List of packages for domain page appears for the this domain.

2 Click the Details-Modify link for the service package which the Music on Hold service is to be enabled. The Package details page appears for the selected service package.

Link to a page where services that are availableto this package can be added or removed



3 Select the Music on Hold check box.

4 Save the change:

• Click Save and Enforce Now to immediately enable the Music on Hold service for all users on this domain who are actively subscribed to this service package.

• Click Save and Enforce Later to enable the Music on Hold service for all users on this domain when they re-subscribe to this service package. This will occur when a user reconnects to the network or when their service package subscription is automatically refreshed.

5 Repeat Steps 1 through 4 for each service package where access to the Music on Hold service is desired.




Locking the Media Application Server

Locking the MAS Before performing maintenance, such as a software upgrade on the MAS, it is necessary to take the MAS out of service. To do this, the MAS must not accept any new incoming transactions, and it must also end all existing transactions. Existing transactions can end either naturally, over time, or existing transactions can be ended immediately, where the MAS interrupts and terminates existing transactions while users are still connected.

When locking down the MAS, it is preferable to allow calls to gradually end, rather than interrupting them. This is achieved by placing the MAS in a Pending Lock state. While in the Pending Lock state, existing calls are allowed to continue on the MAS, while all new incoming service requests are rejected. The following procedures describe how to place the MAS in both the Pending Lock and Locked states.

Procedure B-20 Delayed locking of the MAS

at the MAS Console

1 Right-click the Control Panel icon in the console tree to display the Control Panel shortcut menu:

CAUTIONTemporary loss of serviceIn the simplex deployment, there is only one Media Application Server running the Music on Hold service. Therefore, if you lock the Media Application Server in the simplex deployment, there is a service outage until you unlock the Media Application Server.



2 Select Operations > Pending Lock.

The Media Application Server is placed in the Pending Lock state.

Note: The status of the Media Application Server should still indicate online.



3 Verify that all the individual subcomponents have been successfully placed in the Pending Lock state by right-clicking on the Control Panel icon and selecting View System Components.

Note: The status of the subcomponents should still indicate online.

Procedure B-21 Immediate locking of the MAS

at the MAS Console




2 Select Operations > Lock.

The Media Application Server is placed in the Locked state.

Note: The status of the Media Application Server should still indicate online.



3 Verify that all the individual subcomponents have been successfully placed in the Locked state by right-clicking on the Control Panel icon and selecting View System Components.

Note: The status of the subcomponents should still indicate online.

Unlocking the MAS After performing maintenance, such as a software upgrade on the MAS, it is necessary to unlock the MAS before it will begin accepting new incoming service requests.

Procedure B-22 Unlocking the MAS

at the MAS Console




2 Select Operations > Unlock.

The Music on Hold service is placed in the Unlocked state.

3 Verify that all the individual subcomponents have been successfully placed in the Unlocked state by right-clicking on the Control Panel icon and selecting View System Components.



Checking for active sessions on the MAS Before deactivating the MAS, check if there are active sessions being serviced on the MAS. The number of active sessions should be allowed to drop to zero or to an acceptably low number prior to locking or deactivating the MAS completely. The following procedure describes how many calls the MAS is actively supporting.

Procedure B-23 Checking the MAS for active sessions

at the MAS Console

1 Click the Active Sessions icon in the console tree to display a list of any active sessions on the MAS in the Details panel.



Note: The Active Sessions detail panel contents can be refreshed by right-clicking on the Active Sessions icon and selecting Refresh from the shortcut menu.

Ending an active session on the MAS Sometimes it may become necessary for the administrator to manually end a specific active session on the Media Application Server, without ending other active sessions. The following procedure describes how the administrator can end an active session on the Media Application Server.

Procedure B-24 Ending an active session

at the MAS Console

1 Click the Active Sessions icon in the console tree to display a list of active sessions on the MAS in the Details panel.

2 Right-click on an active session to display the shortcut menu for the active session.



3 Select Delete from the shortcut menu to end the active session.

Uninstalling the MAS softwareBefore uninstalling the Music on Hold software and the MAS platform software, the Media Application Server must be offline (deactivated). If the MAS is not deactivated, refer to Procedure B-8, Deactivating and verifying offline state of the Media Application Server and conferencing service, on page 192 before attempting to uninstall the Music on Hold service software and the MAS platform software.

Upgrading the MAS software can result in your custom announcements being lost. Before uninstalling the MAS software, preserve your custom announcements using the following procedure.

ATTENTIONAlways uninstall the service software before uninstalling the MAS platform software.



Procedure B-25 Preserving the custom messages

at the Media Application Server

1 Open the folder D:\Program Files\Nortel Networks\MAS.

2 Rename the folder Announcements to AnnouncementsCustom.

3 Open the AnnouncementsCustom folder.

4 For each service subfolder:

a Open the service folder and navigate to the subfolder default\us\en\l16.

b Replace your customized announcements.

Procedure B-26 Uninstalling the Music on Hold service software


1 Select Start > Settings > Control Panel to bring up the system Control Panel.

2 Double-click on the Add/Remove Programs icon to bring up the Add/Remove Programs control panel applet.

3 Select Nortel Networks Music on Hold and click the Remove button to bring up the uninstall confirmation dialog window.

4 Click Yes to begin the uninstall, or click No to close the window without removing the Music on Hold service software.



Procedure B-27 Uninstalling the MAS platform software


1 Select Start > Settings > Control Panel to bring up the system Control Panel.

2 Double-click on the Add/Remove Programs icon to bring up the Add/Remove Programs control panel applet

3 Select Nortel Networks Media Application Server and click the Remove button to bring up the uninstall confirmation dialog window.

4 Click Yes to begin the uninstall, or click No to close the window without removing the Media Application Server platform software.



Changing the MAS platformWhen upgrading the hardware from the x335 or x336 to the BladeCenter, perform the following steps:

• Back up the MAS user data on the old server, using the MAS backup procedure in the Backup and Restore Guide (NN42020-502).

• Back up the custom announcements on the old server.

• Install the MAS base and application software on the new server.

• Restore the user data backup to the new server, following the MAS restore procedure in the Backup and Recovery Guide (NN42020-502).

• Restore the custom announcements backup to the new server.

Creating a Terminal Services install disk

Procedure B-28 Creating the Terminal Service install disk

at the OS Start menu

1 Select Start > Settings > Control Panel.

ATTENTIONTerminal Service install disk creation is only required if the Management Server does not have access to the Terminal Services Installer through alternate means such as Internet download.

If creating install disks, you will need two disks for the terminal service installation program.



The system Control Panel window is displayed.

2 Double-click the Administrative Tools folder.

3 Double-click on the Terminal Services Client Creator icon.



4 Select Terminal Services for 32-bit x86 windows.

5 Click OK to begin creation of the installation disks.

The Insert Floppy window displays:

6 Insert a disk into the floppy disk drive.

7 Click the OK button to continue.

8 Follow the instructions that display on the screen.



When completed, these disks may be used to install Terminal Services on other computers.

Multimedia Communication Portfolio

Media Application ServerMusic on Hold Service Guide

Copyright © 2006 Nortel Networks. All rights reserved.

The information in this document is subject to change without notice. The statements, configurations, technical data, and recommendations in this document are believed to be accurate and reliable, but are presented with-out express or implied warranty. Users must take full responsibility for their applications of any products specified in this document. The information in this document is proprietary to Nortel Networks.

*Nortel, Nortel (logo), and the Globemark are trademarks of Nortel Net-works.

Publication number: NN10378-113Product release: MCS 5100 3.5Document version: Standard 6.0Date: December 2006

music on hold service guide

Documents