RSM 4.3 Og

NexTone RSM (Real-time Session Manager)
Operations Guide
Release 4.3 Document Number: OG-07-RSM-0001-4.3-01 May 18, 2007
100 Orchard Ridge Drive, Suite 300 Gaithersburg, MD 20878 U.S.A. www.nextone.com 2007 by NexTone Communications, Inc. All rights reserved.
Table Of Contents
1. Getting started ____________________________________________________________ 1
Who should use this guide ............................................................................................................1 What Documentation Is Required .................................................................................................1 Contacting Customer Support.......................................................................................................2 Licensing .......................................................................................................................................2 Software license file ...................................................................................................................2 Component licensing..................................................................................................................2 Platform Software..........................................................................................................................2 Agent-side components ................................................................................................................2 System-side components ..............................................................................................................3 RAM: Route Analysis Module (standard)...................................................................................3 ESM: Events and Statistics Module (optional) ...........................................................................3 ARM: Adaptive Routing Module (optional).................................................................................4 BAM: Business Analysis Module (optional) ...............................................................................4 WIM: Web Interface Module (optional) ......................................................................................4 OSP: Over Subscription Module ................................................................................................4 QoS: Quality of Service Module.................................................................................................5 Selecting time zones .....................................................................................................................5
2. Understanding the RSM user interface ________________________________________ 7

Logging into RSM..........................................................................................................................7 Working with RSM.........................................................................................................................8 Verifying the version number ........................................................................................................8 Working with the main RSM window.............................................................................................8 Window structure .......................................................................................................................9 Top-Level Menu area .................................................................................................................9 Selecting Dates ...........................................................................................................................10 Date and time formats.................................................................................................................11 Currency formats.........................................................................................................................13
3. RSM Reporting ___________________________________________________________ 15

About reports...............................................................................................................................15 Report dates.............................................................................................................................15 Searching using wildcards .......................................................................................................16 Reports available in RSM.........................................................................................................16 Customizable Chromocode......................................................................................................17 Displaying the Engineering report ...............................................................................................17 Filters........................................................................................................................................18 Clearing the Engineering report ...............................................................................................18 Emailing and saving Engineering reports ...................................................................................19 Emailing a report ......................................................................................................................19 Saving a report.........................................................................................................................19 Filters...........................................................................................................................................19 Setting a Filter ..........................................................................................................................20
iii
4.3 RSM Operations Guide
Saving a new Filter...................................................................................................................20 Deleting a Filter ........................................................................................................................20 ASR reports.................................................................................................................................20 Types of ASR reports...............................................................................................................20 ASR Detail...................................................................................................................................22 Accessing ASR Detail ..............................................................................................................22 Viewing the next level ..............................................................................................................23 Accessing the ASR graph ...........................................................................................................23 Prerequisites for viewing the ASR graph .................................................................................23 ASR report: CDR List view..........................................................................................................24 Accessing the CDR List ...........................................................................................................24 Viewing the next level ..............................................................................................................25 CDR Detail ..................................................................................................................................25 Accessing CDR detail ..............................................................................................................25 NER reports.................................................................................................................................25 NER Detail...................................................................................................................................27 Accessing NER Detail ..............................................................................................................27 Viewing the next level ..............................................................................................................28 NER graph...................................................................................................................................28 Prerequisites for viewing the NER graph .................................................................................28 NER report: CDR List View .........................................................................................................29 Accessing the CDR List ...........................................................................................................29 Viewing the next level ..............................................................................................................30 QoS report...................................................................................................................................30 QoS detail....................................................................................................................................32 Accessing QoS Detail ..............................................................................................................32 Viewing the next level ..............................................................................................................34 QoS graph ...................................................................................................................................34 Prerequisites for viewing the QoS graph .................................................................................34 QoS report: CDR List view ..........................................................................................................35 Accessing the CDR List ...........................................................................................................35 Viewing the next level ..............................................................................................................35 Types of Business reports...........................................................................................................35 Business reports..........................................................................................................................38 Displaying the Business report ................................................................................................38 Clearing the Business report....................................................................................................39 Filters........................................................................................................................................39 Emailing a report ......................................................................................................................39 Saving a report.........................................................................................................................39 Customizable Chromocode......................................................................................................40 Route Profit reports .....................................................................................................................40 Accessing the Route Profit report ............................................................................................40 Additional options on the Route Profit report page ..................................................................41 Filters........................................................................................................................................41 Clearing the Route Profit Report..............................................................................................41 Emailing a report ......................................................................................................................41 Saving a report.........................................................................................................................42 Custom report..............................................................................................................................43
iv
Table Of Contents
Accessing the Custom report...................................................................................................43 Clearing the Custom Report ....................................................................................................46 Emailing a report ......................................................................................................................46 Saving a report.........................................................................................................................47 Obtaining Custom Report details .............................................................................................47 SVGViewer...............................................................................................................................47 The Unrated CDRs report ........................................................................................................47 Custom Detail..............................................................................................................................48 Accessing Custom Detail Dialog..............................................................................................48
4. RSM Alarming____________________________________________________________ 51
Creating and managing alarms ...................................................................................................51 Alarming tab: types of actions .....................................................................................................51 Adding a CDR alarm ...................................................................................................................53 CDR alarm types .........................................................................................................................57 Updating a CDR alarm ................................................................................................................59 Deleting a CDR alarm .................................................................................................................60 Adding a Log alarm .....................................................................................................................60 Actions.........................................................................................................................................61 Accessing Actions ....................................................................................................................61 Adding a new action.................................................................................................................62 Updating an Action...................................................................................................................62 Deleting an Action ....................................................................................................................62 Updating a Log alarm ..................................................................................................................63 Deleting a Log alarm ...................................................................................................................63 Alarm events ...............................................................................................................................63 Viewing alarm events ...............................................................................................................64 Clearing alarm events ..............................................................................................................65
5. RSM Provisioning ________________________________________________________ 67

Overview of RSM provisioning ....................................................................................................67 Call Detail Records (CDRs) ........................................................................................................67 Rates and routes .........................................................................................................................67 Provisioning main menu..............................................................................................................68 Importing rating and routing data ................................................................................................69 Regions table ..............................................................................................................................70 Rates Table (Customer/Supplier)................................................................................................71 Fields in the Customer Carriers-Rate table.................................................................................71 Fields in the Supplier Carriers-Rates table .................................................................................72 Routes table ................................................................................................................................73 Fields in the Customer Carriers-Routes table.............................................................................74 Fields in the Supplier Carriers-Routes table ...............................................................................75 Importing data into the Rating table for priority-base routing......................................................76 Periods table ...............................................................................................................................78 ANI table......................................................................................................................................79 Setting up data for LCR with profitability.....................................................................................80 Definition: Profit Threshold..........................................................................................................80
Running reports on rating data....................................................................................................81 Rates Summary report ................................................................................................................81 Regions Summary Report...........................................................................................................83 Rates and Routes report .............................................................................................................84 Manually adding, modifying, and deleting rating and routing data..............................................88 Routes .........................................................................................................................................89 Rates ...........................................................................................................................................91 Carriers........................................................................................................................................92 Displaying LCR with profitability information............................................................................92 Regions .......................................................................................................................................93 Periods ........................................................................................................................................94 Deleting rating information for multiple carriers ..........................................................................97 Maintaining rating and routing data.............................................................................................97 Rerating CDRs ............................................................................................................................97 Running the Trace Rate utility.....................................................................................................99 Validating imported data ...........................................................................................................101 Generating and uploading routes..............................................................................................103 Working with Least Cost Routing ..............................................................................................103 Displaying and generating Least Cost Routes.......................................................................103 Manually updating the LCR priority........................................................................................104 Updating MSX with Least Cost Routes..................................................................................105 Implementing LCR with profit thresholds ...............................................................................105 LCR with profit thresholds .........................................................................................................105 Implementing LCR with profit threshold .................................................................................106 Displaying the Most Profitable Route report .............................................................................106
6. Launching RSM Console__________________________________________________ 109

Launch RSM Console ...............................................................................................................109
7. RSM System ____________________________________________________________ 111

Working with the RSM system ..................................................................................................111 Configuration .............................................................................................................................111 Accessing Configuration ........................................................................................................111 Logging......................................................................................................................................114 Accessing the Logging page..................................................................................................114 Status ........................................................................................................................................115 Accessing the Status page ....................................................................................................116 License ......................................................................................................................................117 Accessing the License page ..................................................................................................117 Updating a license..................................................................................................................118 Branding ....................................................................................................................................118 Accessing Branding ...............................................................................................................118 Adding a Banner ....................................................................................................................118 Updating the Logo..................................................................................................................119 Removing a Banner ...............................................................................................................119 Devices......................................................................................................................................119 Accessing the Devices page..................................................................................................119
vi
Table Of Contents
Adding a device......................................................................................................................120 Updating a Device..................................................................................................................122 Deleting a Cluster...................................................................................................................122 Overview of Partitioning ............................................................................................................122 Accessing Partitioning............................................................................................................123 Partitioning page .......................................................................................................................123 Accessing Partitioning............................................................................................................123 Additional tasks ......................................................................................................................124 Updating the partition stylesheet (system administrator only) ...............................................124 Adding partitions........................................................................................................................125 Adding a Partition...................................................................................................................125 Managing users in a partition ....................................................................................................128 Capabilities.............................................................................................................................128 Adding users .............................................................................................................................130 Access List ................................................................................................................................132 Viewing specific access list information .................................................................................132 Filters......................................................................................................................................133 Adding an access list .............................................................................................................133 Deleting an access list ...........................................................................................................134 Audit Trail ..................................................................................................................................135 Accessing the Audit Trail page ..............................................................................................135 Clearing audit trail entries ......................................................................................................135 Managing RSM Archiver services .............................................................................................135 Adding an archive job.............................................................................................................136 Deleting an archive job...........................................................................................................137 Importing and exporting Call Data Records ..............................................................................138 Required directories ...............................................................................................................138 Adding a CDR map ................................................................................................................138 Creating an import stream......................................................................................................139 Creating a CDR Stream .........................................................................................................141 New Export Stream ................................................................................................................143 Advanced Configuration.........................................................................................................144 Setting Collector Agent Parameters.......................................................................................144 Mapping Between Transform in Fields and Collector Agent Parameters..............................145 CDR Errors................................................................................................................................145 CDR Receptor Module (CRM) ...............................................................................................146 CDR Validation.......................................................................................................................146 CDR Logging..........................................................................................................................146 Re-Import of CDRs.................................................................................................................146 User Input and Output............................................................................................................146 Accessing CDR Errors ...........................................................................................................147 About Synchronization ..............................................................................................................147 Manual database synchronization between MSX and RSM..................................................147 Database audit/auto synchronization.....................................................................................148 Synchronization Menu...............................................................................................................149 Accessing synchronization.....................................................................................................149 Working with system alarms .....................................................................................................149 System tab: alarm actions .........................................................................................................150
vii
Adding a new action...............................................................................................................150 Updating an Action.................................................................................................................151 Deleting an Action ..................................................................................................................151 System tab: types of alarm actions ...........................................................................................151 Adding system alarms...............................................................................................................152 System tab: alarm events..........................................................................................................155 Viewing alarm events .............................................................................................................155 Alarm event data ....................................................................................................................156 Clearing alarm events ............................................................................................................156
8. RSM Streaming__________________________________________________________ 159

RSM Streaming .........................................................................................................................159
9. RSM Administration ______________________________________________________ 169

RSM Administration...................................................................................................................169 System startup .......................................................................................................................169 System shutdown...................................................................................................................169 System backup.......................................................................................................................169 Displaying software versions .................................................................................................169 Abnormal OA&M procedures .................................................................................................169 Other administrative tools ......................................................................................................170 Some common RSM database fields.....................................................................................172 Performing database administration tasks................................................................................172 Full database backup .............................................................................................................173 Backing up individual tables...................................................................................................174 Restoring individual tables .....................................................................................................174 Database or table dump.........................................................................................................174
viii
Getting started
This guide describes how to work with NexTone Real-time Session Manager (RSM). It contains the following sections:
Getting started: Covers what you need to know to get started with RSM. Topics include how to contact Customer Support, how to verify version information, how to manage RSM licensing, and how to log into RSM. Understanding the RSM user interface: Explains the basics of working with the RSM user interface, including how windows are organized, how to select dates, and how to select multiple items in a list. RSM Reporting: Describes the reports available in RSM. These include Engineering reports, Business Reports, Route Profit reports, and custom reports. RSM Alarming: Explains how to set up alarms, including how to define the conditions that trigger the alarm and how to specify what actions you want the system to perform when the alarm is triggered. RSM Provisioning: Explains how to define and manage rating and routing data. RSM Console: Explains how to access RSM Console, which allows you to provision an MSX server. RSM System: Describes the tasks involved in performing system administration for RSM. RSM Streaming: Explains the process involved in inserting unrated CDRs into databases outside of RSM. RSM Administration: Covers addition system administration tasks such as starting up and shutting down the system and backing up databases.
Who should use this guide

This document is written for Network Engineers, System Administrators, NexTone-Certified Engineers, NexTone Field Engineers, and NexTone Technical Consultants who are installing or upgrading RSM.
What Documentation Is Required

NexTone Documentation

Real-time Session Manager (RSM) Operations Guide, release 4.3 Multiprotocol Session Exchange (MSX) Installation Guide, release 4.3 Real-time Session Manager (RSM) Release Notes, release 4.3
Related Documentation
MySQL 5.0 Reference Manual
Contacting Customer Support

If you need to contact NexTones Customer Support, do the following: 1. Go to NexTones web site at: http://www.nextone.com/. 2. Select Support from the main menu on the NexTone page. A description of available support options is displayed after login. For urgent issues, you are encouraged to call our Support Hotline at +1 (240)686-3983 for immediate assistance.
Licensing
Software license file
For RSM releases prior to 4.2, a connection to the RSM server was required, even to just stream CDRs to a third-party (i.e., non-RSM) server. For 4.2 and later, the agent software runs without a connection to a RSM server, based on a copy of the license file stored on the session controller on which the agent components are running. That copy is stored on the session controller in /usr/local/ivms agent/RSM.lc. If the file does not exist on the session controller, the agent automatically copies it from the RSM server the first time a connection is established with it, and, thereafter, doesnt require a connection to the server.
Component licensing
The basic RSM components (RAM, cdrserver and logpp) are included in the first-level RSM license. All additional components (rateunrated, ESM, ARM, etc.) are separately licensed and enabled through a license file residing on the RSM server or on the session controller hosting the RSM agent. The license file controls the permissions for each RSM module, along with a list of host ids of the machines for which that module is authorized, and an expiration date for the whole license. For further information on RSM component licensing, contact your NexTone representative.
Platform Software
There are two platforms on which the RSM system runs, since the server and agent components run on separate machines under different operating systems. The RSM systems agent components run on the same physical machine as the session controller (iServer).The RSM agent has no additional resource requirements (memory, disk, etc.) The RSM system server runs on a separate platform from the session controller.
Agent-side components
The RSM agent software runs on the iServer platform. It consists of the components detailed in this section. The agent component called cdrserver reads the CDR files created by the MSX. Then, depending on its configuration, cdrserver inserts the raw CDRs into the RSM server database; it also can send selected fields to a third-party database via the streaming process. To implement streaming, an XML configuration file must be created specifying the CDR fields to send. During streaming, the fields can also be reformatted in various ways, including date and
Getting started
time, expression and conditional transformations. Details on streaming capability and setup are given in RSM Streaming section. The RSM agent on the MSX delivers CDRs to the RSM server using the HTTP protocol. The HTTP operations are throttled down to keep them at one per second to avoid excessive network traffic. Each operation can deliver multiple CDRs, delimited by the new line character. Each CDR entry is of the same comma separated format as the MSX CDRs.
System-side components
The RSM server software, running on a NexTone session controller, harvests call detail records (CDRs) from flat files on the session controller. It then rates them based on rating information in the RSM servers database and stores the rated and/or raw CDRs (depending on configuration parameters) in a database hosted on the RSM server platform. The RSM server hosts a reporting engine that processes CDR information stored in its local database and creates standard and custom reports based on user queries. Account and rating information is entered into the RSM server database through a web-based interface controlled by the Web Interface Module (WIM). The RSM components listed in this section are those running on the RSM server. Reports are produced by each as noted. Reports based in optional modules are only available on systems with those modules installed.
RAM: Route Analysis Module (standard)

The Route Analysis Module (RAM), running on the RSM server platform, processes CDRs in realtime, from one or more session controllers, to determine quality of service and other measures of system performance. RAM is a RSM basic, required module; a RSM agent cannot communicate with a RSM server without a RAM. RAM provides a basic set of engineering reports, including:
The ASR, or Answer Seizure Ratio report, which can be sorted by one of several of its main fields A listing of the 200 most-recent calls processed
Each of the above reports allows specifying certain search/filter criteria, such as a registration ID or date range.
ESM: Events and Statistics Module (optional)

The ESM module facilitates alarming. Alarm categories are:
Log-based alarms, where the alarm is triggered based on some string that appears in a log file CDR-based alarms, where the alarm is triggered based on CDR contents that may be:

A specific error description A too-low Answer Seizure Ratio (ASR) A customer/route exceeding its total allocated minutes
Actions that may be taken include:

Logging the error to a log file E-mailing a notification to a particular user account Blocking a particular endpoint/gateway via the Adaptive Routing Module (ARM), if ARM is licensed and enabled.
Finally, an event is defined as a real instance of an alarm. That is, an event is a real-world occurrence of the set of conditions defined by the user as constituting an alarm.
ARM: Adaptive Routing Module (optional)

This module provides a set of actions to change session controllers routing configuration. ARM requires the ESM module to be enabled, since ESM is the source of data from which ARM makes route-affecting decisions. In RSM version 2.0, ARM provides a way to disable calls, at endpoint ingress or egress, based on a detected alarm condition.
BAM: Business Analysis Module (optional)

This module processes CDRs from the RSM server database to produce on-demand business reports including:

Revenue and profit analysis, and profitability by route A count of unrated CDRs on the session controller, with certain details
BAM is dependent on a running RAM module and RSM agent. Billing reports can be obtained through this module, but actual bills must be generated externally from RSM.
WIM: Web Interface Module (optional)

This module provides user access via web browser to those features for which the user is authorized based on username/password authentication. User access controls the following:
The endpoints (including gateways) the user can view and for which he can produce reports The RSM system features the user can access
Also, with this release to determine if the module is enabled or disabled the value should have a value in the range of 0 to 64. A value of 0 means partitioning is disabled. Any values greater than 0 specifies the number of partitions licensed on the RSM system. In addition, through a feature known as Customizable Chromocode. the user can dictate thresholds for the color coding available to the engineering and business reports they are authorized to produce. Certain browsers are certified to work with the RSM system. Others may work, but yield unexpected results, and are not supported. For more information on certified browsers, see Client Requirements.
OSP: Over Subscription Module

This license module defines the Over Subscription factor allowed when partitioning an MSx system using RSM. An OSP value of 100 means that the RSM system will allow partitions whose Max VPORT limits will add up to the licensed VPORT limit on the MSx system. An OSP value of 200 would mean that the RSM partitions could have twice as many VPORTs as what is allowed on the MSx, thus providing an Over Subscription of MSx services. The default value of this is 100. 4
Getting started
A value of 0 means that Over Subscription is turned off, i.e., no Over Subscription factor will be enforced when adding partitions.
QoS: Quality of Service Module

This module adds support for the QOS parameters in the CDRs. When this module is enabled, QOS parameters are displayed in the reports and the QOS related alarms are available to the user. NOTE:To use the QOS functions in RSM effectively, the MSX system sending CDRs to the RSM system should also be QOS enabled.
Selecting time zones

Some dialog windows allow you to specify time zones to apply to the times you specify, such as when applying a particular rate plan to Call Detail Records (CDRs). The Time Zone field is most commonly specified using an offset from GMT (Greenwich Mean Time, also known as UTC, or Universal Coordinated Time), such as GMT-5 for the eastern time zone in the United States. NOTE: You must choose the iServer time zone from the pull down menu when running reports. Also, both the iServer and RSMs time must be accurate, or the reports will be inaccurate. In fact, you can use any time zone available to you from the operating system on which the RSM server is running. For a list of available time zones on your server, enter the following command:
ls /usr/share/zoneinfo
This command provides a list of times zones recognized by the operating system, many of which are expressed as city names (for example, HongKong) or special local designations, like EST5EDT, for the eastern time zone in the US, when on daylight savings time. Many of the entries in the zoneinfo directory are sub-directories that have more city and place names in them, which you can also use to specify a time zone. See your operating systems documentation for more information on its time zone support particulars.
Understanding the RSM user interface

Logging into RSM
Before you can use the RSM system, an account must be established for you. This account controls the endpoints and specific RSM system features you can access. Once your account is established, follow these steps to log into RSM: 1. Once your account is established, log into the system by pointing your web browser to the URL provided for your RSM installation. 2. NOTE: Your supervisor or system administrator should be able to provide you with the URL address. 3. The Welcome to RSM log-in window displays. 4. Enter your User ID and Password. 5. Hit the <Enter> key or click the Login button. 6. The system displays a dialog box that allows you to pick the partition you want to work in. If you are an admin user, select the admin partition; otherwise, select the partition of which you are a member. 7. The system displays the main RSM system page. The Engineering Reports page displays first by default. 8. Once logged into the RSM system, you can access those functions to which your user profile entitles you. IMPORTANT: If you have successfully logged in, DO NOT select a new browser window and log in again. Login privileges In RSM, there are two levels of login privileges:

User Administrator
All users have access to most of the functions of RSM. However, there are some functions that are restricted to users with administrator-level login privileges, including the ability to create, modify, and delete user accounts, and their user partition associations. Using RSMs Admin function, an administrator can establish and modify user accounts, partitions, and partition memberships. Logging out of RSM To log out of RSM, do the following: Click the Logout link. You are returned to the Login window.
Working with RSM

Working with RSM involves the following tasks:

Logging into RSM Working with the main RSM window (see Working with the main RSM window) Viewing reports (see About reports) Creating and managing alarms (see Creating and managing alarms) Defining and managing rating and routing data (see Overview of RSM provisioning) Accessing RSM Console (see Launching RSM Console) Working with the RSM system (see Working with the RSM system) Streaming CDRs (see RSM Streaming) Performing RSM system administration (RSM Administration)
Verifying the version number

To verify the version of RSM that you are working on, do the following: Move your cursor to the RSM icon, located on the upper left side of a page. Left-click your mouse. The RSM Versions dialog displays. Click Close to exit the dialog.
Working with the main RSM window

Upon successfully logging into RSM, the main system page of the RSM system displays. NOTE: Upon logging onto RSM, the Reporting tab is displayed, by default.
The RSM main window remains open as long as you are logged into RSM, providing access to all
the RSM dialogs/windows.
Window structure
Information areas on the Main window can be divided into the following areas:

Top-level Menu area Menu area Action area Content area
These four areas are present in the majority of RSM system windows. The Top-Level Menu area runs across the top of the page. Located in the top far-left corner of this area is the RSM logo. This logo also serves as a way to verify the software version. To the right of the logo are 3 hyperlinks: RSM Console, Help, and Logout.

RSM Console Used to launch the RSM console window. Help Used to access the RSM online help system. Logout Used to log out of the RSM application.
Top-Level Menu area

The Top Level Menu area of the RSM window displays the following four high-level menu tabs: Reporting, Alarming, Provisioning, and System.
Reporting Used to create technical (engineering), business, route profitability, and customized reports. (Upon logging into RSM, this page is selected by default.) Alarming Used to set, modify, and monitor system alarms. Provisioning Used to define and manage endpoints, routes, and calling plans, and rates. System Used to configure the system, archive call data, view RSM status and licensing. information, create and edit partitions and devices, and audit changes made to the system.
Menu area Located just below the Top-Level Menu area, on the left side of the page, is the Menu area. This area allows you to select the various menus and sub-menus available on each tab.
Action area Located just to the right of the Menu area, on the right side of the page, is the Action area. This area allows you to enter information and/or take action. The action buttons are located across the bottom of the Action area.
Content area Located below the Menu and Action areas is the Content area. This area displays content related to the Action area. In many cases, this is the output of search criteria entered in the Action area.
Selecting Dates
Some dialog boxes allow you to enter date ranges for functions such as reporting and rating. When this is an option, the date can be selected using the Date pop-up window. This pop-up window is accessed by clicking on the calendar icon located to the right of the date field. The following pop-up window displays:
10
When this window appears, it shows the current month, with todays date highlighted in light red (in the above illustration, its May 09, 2006). You can click on any date shown, or switch to another month, past or future. Clicking the blue arrow buttons moves you one month or one year in the indicated direction.
To move one month forward or backward in time (think of play on a tape recorder), click one of the arrow buttons that does not have a vertical line through it. To move one year forward or backward in time (think of fast forward or rewind on a tape recorder), click one of the arrow buttons that has a vertical line through it.
Finally, you can designate an hour, minute and/or second on that date, by using the Time lists. NOTE: Time is expressed in the following format: hh:mm:ss, where h represents hour, m represents minute, and s represents seconds.
Date and time formats

RSM supports alternative date and time formats. You can specify the date and time format for the partition and for individual users within the partition. (See Adding partitions and Adding users for information.) The date and time format specified for the partition or partition user affects specifying and viewing dates in screens displayed throughout RSM, including the following: Tab Reports Provisioning Option All reports Rates, Rates Summary, Rates and Routes, Periods, Rerating utility Status, Devices, Partitioning (Partitions, Users, Access list), Audit Trail, Archiver, System Alarms
System
The following date formats are supported: Date format dd/MM/yyyy dd.MM.yyyy Example 04/06/2000 04.06.2000
11
dd-MM-yyyy yyyy-MM-dd MM/dd/yyyy MM-dd-yyyy yy-MM-dd dd/MM/yy dd.MM.yy dd-MM-yy MM/dd/yy MM-dd-yy dd MMMMM yyyy dd MMMMM,yyyy dd-MMMMM-yyyy dd-MMMMM-yy dd-MMM-yy MMMMM dd yyyy MMMMM dd,yyyy The following time formats are supported: Time format HH:mm:ss hh:mm:ss HH:mm hh:mm
04-06-2000 2000-06-04 06/04/2000 06-04-2000 00-06-04 04/06/00 04.06.00 04-06-00 06/04/00 06-04-00 04 July 2000 04 July,2000 04-July-2000 04-July-00 04-Jul-00 July 04 2000 July 04,2000
Example 13:59:59 01:59:59 PM 13:59 01:59 PM
12
Currency formats
RSM allows you to use a currency symbol other than the $ (US dollar) to specify rating information. The default currency is US dollars. You specify currency formats when you add a partition. (See Adding partitions for information on creating partitions.) The default currency is dollars. Each partition can have a different currency specified, but you can specify only one currency per partition. In an un-partitioned RSM system, the currency specified for the admin partition will be the currency for the whole system. Note: RSM does not support rate conversion between currencies. The currency format specified for the partition affects specifying and viewing currency in the following areas: Tab Reports System Option Business and Route Profit reports CDR Alarms
The following are the currencies supported:

US Dollar Euro Pound Yen Yuan Renminbi Won Ruble Kroner Rupee Rand Real Guilder Baht Shekel Coln Kips Lira Dong
13

Tugrik Naira Nuevos Sole
14
RSM Reporting
About reports
Reports allow the user to see and monitor system activity for technical or business purposes. Business-class reports show analytic data such as route profitability, revenue, and data on unrated CDRs. NOTE: While billing activity is shown in the Route Profitability report, the RSM system is not a billing system, as such. It cannot be used to generate customer bills; a separate system is needed to turn rated CDRs into paper bills. When you first log in to the RSM system, the Reporting tab is active (as shown below) in the RSM system page. To get to the Engineering tab from another page in the RSM application, click the Reporting tab and the Reporting page (example shown below) is displayed. The Reporting tab is used to create technical (engineering), business, route profitability, and customized reports.
When you first log into the RSM system, the Engineering report window is automatically displayed. (To get to the Engineering report window from another page of RSM, click on the Reporting tab.) The Engineering report window by default. The Engineering page can produce 11 types of reports: 10 Answer Seizure Ratio (ASR) reports and a Call List report. For a description of each type of report, see Types of Engineering Reports.
Report dates
RSM reports generally allow you to specify a range of reporting dates. Note the following: If no dates are specified, the default is only data for the preceding 60 minutes. Entering only a Begin Date yields a report containing all data from that date, forward to the present. Entering only an End Date yields a report containing all data from the earliest date in the database up to and including that date.
15
Searching using wildcards

NOTE: The Dial String, Region, IP Address, Regid, ISDN Code and Error Description fields accept the wildcard character, %, to match zero, one or many characters. On report request pages, when specifying text parameters such as Region, IP Address, or Regid, wildcard matches are generally supported. The wildcard character is the percent sign, %. The wildcard will match zero, one or many characters. It can be embedded in a string, such as 011%55%, to match as number starting with 011, and containing or ending with 55.
Reports available in RSM

The reports available to the RSM system user include the following: Engineering These reports can be filtered by origin or destination registration or port, or by searching for a particular embedded string. You can also specify date ranges. See Displaying the Engineering report. The engineering report set includes the following:
Answer Seizure Ratio (ASR) reports, sorted by source or destination IP address, source or destination Reg ID, Region, Supplier, Customer, Day, Hour, or Minute. The List Calls option under ASR reports lists system ASR calls for a given day. See ASR reports. Network Efficiency Ratio (NER) reports, sorted by source or destination IP address, source or destination Reg ID, region, supplier, customer, day, hour, or minute. See NER reports. Quality of Service (QoS) reports, sorted by source or destination IP address, source or destination Reg ID, region, supplier, customer, day, hour, minute, source or destination codec. See QoS report.
Business These reports can be filtered by origin or destination registration or port, or by searching for a particular embedded string. You can also specify date and time ranges and a refresh interval. The business report set includes the following:
Region, customer, supplier, Cust Plan, Orig REDID, etc.; sorted by number of calls or minutes, or by revenue or profit. Call volumes, profit, minutes, and revenue. A count of unrated CDRs, along with certain details.
See Business reports. Route Profit The reports include the following: Customer or supplier Based on one or more plan IDs
16
RSM Reporting
Filterable by date
See Route Profit reports. Custom RSM provides a custom reports tool that allows you to display CDR data derived from the Engineering report. See Custom report.
Customizable Chromocode
Customizable chromocode allows each user to choose thresholds for data for ASR and Business reports that will assign a display color for results that fall within certain ranges. There are three ranges, each with its own color. The ranges are called good, marginal and not acceptable, and they display and print in green, amber and red, respectively. For example, an ASR of 60% or more may be considered good, and would therefore show in green on the report. Less than 60%, but more than perhaps 45%, or more could be considered marginal, showing in amber in the report. Finally, anything less than the marginal threshold would show in red, as being a not acceptable average success rate. NOTE: You will need to log out and log in again for your settings to take effect.
Displaying the Engineering report

To display an Engineering report, do the following: On the Reporting tab, the Engineering report option is displayed by default. 3. Select the Engineering report you want from the Report list, i.e., ASR by Source IP. 4. Select the host by scrolling through the Host list. 5. Enter the Begin Date and End Date for the report. (Note that you can enter dates using the calendar icon located to the right of the date fields.) NOTE: You should disable any pop-up blocker(s) for RSM or pop-up windows, such as the Calendar window, will not display. Please note, most browser add-ons and toolbars have pop-up blockers. NOTE: When selecting Begin and End dates the following rules apply for specifying: If no dates are specified, the default is to show data only for the preceding 60 minutes. Entering only a Begin Date yields a report containing all data from that date, forward to the present. Entering only an End Date yields a report containing all data from the earliest date in the database up to and including the date you specify. 6. Select the Time Zone from the list. 7. Enter any additional search criteria in the appropriate fields. 8. Select a Partition from the list. 9. Select your desired Refresh Interval from the list, or accept the default. 10. Click Show. After some processing time, the selected report displays
17
11. NOTE: To clear the page of entered search criteria, click Clear. See "Clearing the Engineering report, " below, for additional information. 12. Use the Previous and Next buttons to move from page-to-page if the report data doesn't all fit on one page. 13. Click the Detail link in the right-hand column of each row to display detailed information on the data in that row. See ASR Detail, NER Detail, or QoS detail. 14. Click the ASR Graph icon in the right-most column of each row to display a graph of the data in that row. See Accessing the ASR graph, NER graph, or QoS graph.
Field Descriptions
Note: Date and time are displayed in the formats specified for the partition and partition user. Refer to Date and time formats for information. Field Report Host Description This field identifies the type of Engineering report. A host can be an MSX, or any device (such as a third-party gateway) that sends CDRs to the RSM. The RSM agent, or the programs that are sending the CDRs to the RSM, is responsible for populating this field in the CDRs. For MSX, the hostname of the machine is filled in as the default. Specifies the beginning date range of CDRs to be included in the report. Enter a date or click the calendar icon to select the date from a calendar. Specifies the ending date range of CDRs to be included in the report. Enter a date or click the calendar icon to select the date from a calendar. The registration ID of the originating endpoint. (Wildcards can be used.) The port number of the originating endpoint. The registration ID of the destination endpoint. (Wildcards can be used.) The port number of the destination endpoint. Identifies the page number of the displayed report. The number of entries to be displayed per page. The default is 100 lines of displayed information per page.
Begin Date
End Date
Orig Reg ID Orig Port Dest Reg ID Dest Port Page Number Page Length
Refresh Interval How often, in minutes, the RSM automatically refreshed the report.
Filters
See Filters.
Clearing the Engineering report

To clear the page of entered search criteria, click Clear.
18
RSM Reporting
WARNING: Clicking Clear removes all output information from the page. The cleared information cannot be retrieved.
Emailing and saving Engineering reports

RSM provides the option of emailing an Engineering report to a specific email address and saving the report as a file.
Emailing a report
Use the Email button to email the report. 1. Position your mouse over the Email button. A dialog box opens to allow you to specify email options. 2. In the To: field, enter the email address to which you want to send the report. Use a comma (,) to separate multiple email addresses. 3. In the Subject: field, enter a subject for the email. 4. Click Send to send the report. The report will be sent as a CSV file attachment. Note: To email a report, you must set the email configuration options on the System tab. See Configuration for details.
Saving a report
Use the Save button to save the report to a file on the client machine. 1. Position your mouse over the Save button. A drop-down list of the available file formats displays. 2. Select a format from the list. You have the following options:

HTML XML CSV Text
RSM will save the entire report to the file; you cannot save a specific page in the report.
Filters
The Filters tool allows you to save specific page input under a filter name. At a later time, you can retrieve this saved input and re-use the data instead of typing it over again. This tool is available on a number of the menu options under the Reporting, Provisioning, and System tabs. To access Filters, do the following: 1. Within certain windows, e.g., Reporting, Provisioning, or System, select the criteria and then click Filter. 2. The Saved Filters page opens.
19
Setting a Filter
To select a specific filter for use, do the following: 1. From the Filters field, select the filter you wish to use. 2. Click Set.
Saving a new Filter

To create a new filter, do the following: 1. From the Saved Filters page, click New Filter. 2. In the Save As field, give the new filter a name. 3. Click Save.
Deleting a Filter
To delete a filter, do the following: 1. From the Saved Filters dialog, select the filter to be deleted from the Filters drop-down list. 2. Click on the filter you wish to delete. 3. Click Delete. The delete dialog displays. 4. To delete the filter click OK. 5. Click >Close Window to exit the dialog.
ASR reports
The Answer Seizure Ratio (ASR) reports contain information on the ratio of successful calls to the total number of outgoing calls. For information on how to display ASR reports, refer to Displaying the Engineering report. For information on emailing and saving an ASR report, refer to Emailing and saving Engineering reports.
Types of ASR reports

You can display the following types of Answer Seizure Ratio (ASR) reports. Reports ASR by Source IP Description The ASR by Source IP output is sorted by source IP address and port number. The ASR by Source Reg ID output is sorted by the source registration ID and port number. The ASR by Destination IP output is sorted by the destination IP
ASR by Source Reg ID
ASR by Destination IP
20
RSM Reporting
and port number.
ASR by Destination Reg The ASR by Destination Reg IP output is sorted by destination ID registration ID and port number. ASR by Region ASR by Supplier The ASR by Region output is sorted alphabetically by region. The ASR by Supplier page output is sorted alphabetically by supplier. The ASR by Customer output is sorted alphabetically by customer. The ASR by Day output groups ASRs by day. Information is displayed chronologically, with the most recent date first. Day is displayed in the format specified for the partition or partition user. The ASR by Hour output groups ASRs by hour and displays information by date and hour for one day. It will list 24 entries, with one entry for each hour of the day. The ASR by Minute output groups ASRs by minute and displays information by date and minute for the duration you specify. The List Calls report page lists system ASR calls for a given day.
ASR by Customer ASR by Day
ASR by Hour
ASR by Min
List Calls
Field Descriptions for ASR by Source IP report

Note: Field descriptions in this table are for the ASR by Source IP report. If you select a different ASR report, the first field indicates the type of report you selected and how the information is sorted. For example, if you select the ASR by Destination IP report, the first field is the Destination IP Address/Port, which is the IP address/port to which calls are sent or that terminates the call. Field Description
Src IP Address/Port The source IP address/port that initiates the calls. Calls The number of calls received from or initiated by the listed IP/port. If you selected the ASR by Destination IP report, this field displays the number of calls sent to or terminated by the Destination IP. The total call minutes for the listed IP/port. The average post-dial delay for calls received from the source IP address. The average duration, in seconds, for calls received from the source IP address.
Minutes Avg PDD (msec) Avg DUR
Avg Src PDV (msec) The average source Packet Delay Variance (PDV) is reported (in ms) when media routing is in effect. This is commonly referred to as Jitter.
21
Avg Src R Factor
The average source R factor describes the quality for the segment of the call that is carried over this specific stream. This is reported for two-party audio streams when the QoS module is enabled on the MSX. If you select any of the ASR reports by destination (ASR by Destination IP, for example), this fields displays average destination R factor.
Avg Src Packet Loss Represents the number of packets lost. This is reported when media (%) routing is in effect. First Call The timestamp of the first call from the IP address listed, based on the Begin Date you specified for the report. The timestamp of the last call from the IP address listed, based on the End Date you specified for the report. Clicking this link displays detailed information for the calls received from the source IP address specified in this row. See ASR Detail. Clicking this icon displays a graph of the data in that row. See Accessing the ASR graph.
Last Call
Detail
ASR Graph icon
ASR Detail
When you click Detail from the report displayed on the Engineering report page, the next level of detail displays. The detail level for the ASR report displays the four different call types that are in each selected row of the ASR report. Use the information at this level to review the ratio of successful or unsuccessful calls to total calls. The call types are:

A=Abandoned, B=Busy, E=Error N=Normal
Accessing ASR Detail

To access the ASR Detail page, do the following: 1. From the Engineering page, click Detail. 2. The ASR Detail page displays. 3. To close the ASR Detail window, click > Close Window.
Field Descriptions for ASR Detail report

Note: Field descriptions in this table are for the ASR by Source IP report. If you select a different ASR report, the first field indicates the type of report you selected and how the information is sorted. For example, if you select the ASR by Destination IP report, the first field is the Destination IP Address/Port, which is the IP address/port to which calls are sent or that terminates the call.
22
RSM Reporting
Field Src IP Address/Port Code
Description The source IP address/port that initiates the calls. The principal causes for a terminated call and if the call will be billed. N > Normal > Will be billed. A > Abandoned > Will not be billed B > Busy > Will not be billed E > Error > Will not be billed The number of calls for the listed IP/port. The total minutes for the listed IP/port. The average post-dial delay for calls to that source IP address. The average duration, in seconds, for calls to that source IP address. The average source Packet Delay Variance (PDV) is reported (in ms) when media routing is in effect. This is commonly referred to as Jitter. The average source R factor describes the quality for the segment of the call that is carried over this specific stream. This is reported for two-party audio streams when the QoS module is enabled on the MSX. If you select any of the ASR reports by destination (ASR by Destination IP, for example), this field displays average destination R factor. Represents the number of packets lost. This is reported when media routing is in effect. The timestamp of the first call from the IP address listed, based on the Begin Date you specified for the report. The timestamp of the last call from the IP address listed, based on the End Date you specified for the report. Clicking this link displays detailed information for the calls to the source IP address specified in this row.
Calls Minutes Avg PDD (msec) Avg DUR Avg Src PDV (msec) Avg Src R Factor
Avg Src Packet Loss (%) First Call Last Call Detail
Viewing the next level

To view the next level of the ASR Detail page, do the following: 1. Click Detail. 2. The CDR List view displays.
Accessing the ASR graph

Clicking on the ASR Graph icon on the right end of each data row (record), or the heading row, results in a pop-up window presenting a graph of the data for that row, with the x-axis representing the data parameter chosen on the main page. Clicking in the heading row provides a graph for the summary line.
Prerequisites for viewing the ASR graph

To view the ASR graph, you must have the SVGViewer browser plug-in installed. To install the SVGViewer browser plug-in, follow these steps: 1. Click the here link on the ASR Graph.
23
2. The SVG Installation page displays. 3. Follow the instructions provided for your browser type. 4. If you continue to have problems, contact Contacting Customer Support.
ASR report: CDR List view

The CDR List is the next level of detail in the ASR report. This level displays a brief summary of each call that makes up a selected line from the ASR Detail report. It can also be used to see further call details on each call type. For example, if you see a lot of error calls on the ASR Detail level, you can go to this level to see what ISDN cause codes are being generated in those calls.
Accessing the CDR List

To access the CDR List page, do the following: 1. From the ASR Detail page, click the Detail link. 2. The CDR List page displays. 3. To move to the next page of information, click Next>>. 4. To move to the previous page of information, click <<Back.
24
RSM Reporting
5. To close the CDR List page, scroll to the bottom of the page and click >Close Window.
Field Descriptions for the CDR List report

Field Date Orig RegID/Port Term RegID/Port Phone Number Dialed Duration PDD (msec) ISDN Code Error Desc Description The start date and time of the call. Identifies the endpoint's originating registration identification and port. Identifies the endpoint's terminating registration identification and port. The originating phone number. The number MSX sends out to the termination endpoint. Specifies the duration of the call in minutes. The post-dial delay for calls listed. (Note that in this report, the PDD is not the average). The ISDN Cause Code for the call. An error description for the call.

To view the details of one of the CDRs on the CDR List page, do the following: 1. Click Detail. 2. The CDR Detail page displays.
CDR Detail
This level displays additional detail on the CDR that was selected from the CDR List report. This level provides the user with all the details from the CDR for a call.
Accessing CDR detail

1. From the CDR List page, click Detail for one of the CDRs. 2. The CDR Detail page displays. 3. To return to the previous page, click << Back. 4. To close this page, click > Close Window.
NER reports
NER reports are engineering reports based on the Network Efficiency Ratio (NER). The NER better represents pure network performance by eliminating user behavior as a factor. For information on how to display ASR reports, refer to Displaying the Engineering report. For information on emailing and saving an NER report, refer to Emailing and saving Engineering reports.
25
RSM allows you to display the following types of Network Efficiency Ratio (NER) reports. Reports NER by Source IP NER by Source Reg ID NER by Destination IP NER by Destination Reg ID NER by Region NER by Supplier NER by Customer NER by Day Description Report output is sorted by source IP address and port number. Report output is sorted by the source registration ID and port number. Report output is sorted by the destination IP address and port number. Report output is sorted by the destination registration ID and port number. Report output is sorted alphabetically by region. Report output is sorted alphabetically by supplier. Report output is sorted alphabetically by customer. Report output groups NER by day. Information is displayed chronologically, with the most recent date first. Day is displayed in the format specified for the partition or partition user. Report output groups NERs by hour and displays information by date and hour for one daythat is, it will list 24 entries, with one entry for each hour of the day. Report output groups NERs by minute and displays information by date and minute for the duration you specify.
NER by Hour
NER by Minutes
Field Descriptions for NER by Source IP report

Note: Field descriptions in this table are for the NER by Source IP report. If you select a different NER report, the first field indicates the type of report you selected and how the information is sorted. For example, if you select the NER by Destination IP report, the first field is the Destination IP Address/Port, which is the IP address/port to which calls are sent or that terminates the call. Field Description
Src IP Address/Port The source IP address/port that initiates the calls. Calls The number of calls received from or initiated by the listed IP/port. If you selected the NER by Destination IP report, this field displays the number of calls sent to or terminated by the Destination IP. The number of call errors in the calls received from the IP/port. The total call minutes for the listed IP/port. Network Efficiency Ratio (NER). The NER better represents pure network performance by eliminating user behavior as a factor. It is calculated as: (Answers + User Busy + Ring No Answer + Terminal Rejects) / Total call attempts (seizures). The average duration, in seconds, for calls received from the source IP address.
Errors Minutes NER
Avg DUR
26
RSM Reporting
Avg PDD (msec)
The average source Post Dial Delay (PDD), reported in msec. Post dial delay is the amount of time that a caller or calling endpoint has to wait before getting any indication that the call is going to be completed. The timestamp of the first call from the IP address listed, based on the Begin Date you specified for the report. The timestamp of the last call from the IP address listed, based on the End Date you specified for the report. Clicking this link displays detailed information for the calls received from the source IP address specified in this row. See NER Detail. Clicking this icon displays a graph of the data in that row. See NER graph.
First Call Last Call Detail NER Graph icon
NER Detail
When you click Detail from the report displayed on the Engineering report page, the next level of detail displays. The detail level for the NER report displays the four different call types that are in each selected row of the NER report. Use the information at this level to review the ratio of successful and unsuccessful calls to total calls. The call types are:

A=Abandoned, B=Busy, E=Error and N=Normal
Accessing NER Detail

To access the NER Detail page, do the following: 1. From the Engineering page, click Detail. 2. The NER Detail page displays. 3. To close this window, click > Close Window.
Field Descriptions for NER by Source IP report

Note: Field descriptions in this table are for the NER by Source IP report. If you select a different NER report, the first field indicates the type of report you selected and how the information is sorted. For example, if you select the NER by Destination IP report, the first field is the Destination IP Address/Port, which is the IP address/port to which calls are sent or that terminates the call. Field Description
Src IP Address/Port The source IP address/port that initiates the calls. Code Describes the principal causes for a terminated call and if the call will be billed. N > Normal > Will be billed.
27
A > Abandoned > Will not be billed B > Busy > Will not be billed E > Error > Will not be billed Calls The number of calls received from or initiated by the listed IP/port. If you selected the NER by Destination IP report, this field displays the number of calls sent to or terminated by the Destination IP. The number of call errors in the calls received from the IP/port. The total call minutes for the listed IP/port. Network Efficiency Ratio (NER). The NER better represents pure network performance by eliminating user behavior as a factor. It is calculated as: (Answers + User Busy + Ring No Answer + Terminal Rejects) / Total call attempts (seizures). The average duration, in seconds, for calls received from the source IP address. The average source Post Dial Delay (PDD), reported in msec. Post dial delay is the amount of time that a caller or calling endpoint has to wait before getting any indication that the call is going to be completed. The timestamp of the first call from the IP address listed, based on the Begin Date you specified for the report. The timestamp of the last call from the IP address listed, based on the End Date you specified for the report. Clicking this link displays detailed information for the calls received from the source IP address specified in this row. See NER Detail.
Errors Minutes NER
Avg DUR Avg PDD (msec)
First Call Last Call Detail

To view the next level of the NER Detail page, do the following: 4. Click Detail. 5. The CDR List view displays.
NER graph
Clicking on the NER Graph icon on the right end of each data row (record) or the heading row of the NER report results in a pop-up window presenting a graph of the data for that row, with the xaxis representing the data parameter chosen on the main page. Clicking in the heading row provides a graph for the summary line.
Prerequisites for viewing the NER graph

To view the NER graph, you must have the SVGViewer browser plug-in installed. To install the SVGViewer browser plug-in, follow these steps: 1. Click the here link on the NER Graph. 2. The SVG Installation page displays. 3. Follow the instructions provided for your browser type. 4. If you continue to have problems, contact NexTone support.
28
RSM Reporting
NER report: CDR List View

The CDR List is the next level of detail in the NER report. This level displays a brief summary of each call that makes up a selected line from the NER Detail report. It can also be used to see further call details on each call type. For example, if you see a lot of error calls on the NER Detail level, you can go to this level to see what ISDN cause codes are being generated in those calls.

To access the CDR List page, do the following: 1. From the NER Detail page, click the Detail link. 2. The CDR List page displays. 3. To move to the next page of information, click Next>>. 4. To move to the previous page of information, click <<Back. 5. To close the CDR List page, scroll to the bottom of the page and click >Close Window.
29

Field Date Orig RegID/Port Term RegID/Port Phone Number Dialed Duration PDD (msec) Description The start date and time of the call. Identifies the endpoint's originating registration identification and port. Identifies the endpoint's terminating registration identification and port. The originating phone number. The number the iServer sends out to the termination. Specifies the duration of the call in minutes. The post-dial delay for calls listed. (Note that in this report, the PDD is not the average). The ISDN Cause Code for the call. Provides an error description for the call.
ISDN Code Error Desc

QoS report
Quality of Service (QoS) reports are engineering reports that contain data on the call quality measurements that are captured in the CDR. For information on how to display QoS reports, refer to Displaying the Engineering report. For information on emailing and saving a QoS report, refer to Emailing and saving Engineering reports. RSM allows you to display the following types of QoS reports. Reports QoS by Source IP QoS by Source Reg ID QoS by Destination IP QoS by Destination Reg ID Description Report output is sorted by source IP address and port number. Report output is sorted by the source registration ID and port number. Report output is sorted by the destination IP address and port number. Report output is sorted by the destination registration ID and port number.
30
RSM Reporting
QoS by Region QoS by Supplier QoS by Customer QoS by Day
Report output is sorted alphabetically by region. Report output is sorted alphabetically by supplier. Report output is sorted alphabetically by customer. Report output groups QoS by day. Information is displayed chronologically, with the most recent date first. Day is displayed in date format specified for the partition or partition user. Report output groups QoS by hour and displays information by date and hour for one daythat is, it will list 24 entries, with one entry for each hour of the day. Report output groups QoS by minute and displays information by date and minute for one day for the duration you specify. Report output groups QoS by the codec supplied by the source endpoint. Report output groups QoS by the codec supplied by the destination endpoint.
QoS by Hour
QoS by Minutes QoS by Source Codec QoS by Destination Codec
Field descriptions for QoS by Source IP report

Note: Field descriptions in this table are for the QoS by Source IP report. If you select a different QoS report, the first field indicates the type of report you selected and how the information is sorted. For example, if you select the QoS by Destination IP report, the first field is the Destination IP Address/Port, which is the IP address/port to which calls are sent or that terminates the call. Field Description
Src IP Address/Port The source IP address/port that initiates the calls. Calls The number of calls received from or initiated by the listed IP/port. If you selected the QoS by Destination IP report, this field displays the number of calls sent to or terminated by the Destination IP. The number of call errors in the calls received from the IP/port. The total call minutes for the listed IP/port. The average duration, in seconds, for calls received from the source IP address. The average source Post Dial Delay (PDD), reported in msec. Post dial delay is the amount of time that a caller or calling endpoint has to wait before getting any indication that the call is going to be completed.
Errors Minutes Avg DUR Avg PDD (msec)
Avg Src PDV (msec) The average source Packet Delay Variance (PDV), reported (in ms) when media routing is in effect. This is commonly referred to as Jitter. PDV or Jitter measures the variation in packet arrival times. If you select any of the QoS reports by destination (QoS by Destination IP, for example), this field displays average destination PDV. If you select the QoS by Source Codec or QoS by Destination Codec reports, the report displays both Avg Src PDV and Avg Dst PDV.
31
Avg Src R Factor
The average source R factor describes the quality for the segment of the call that is carried over this specific stream. This is reported for two-party audio streams when the QoS module is enabled on the MSX. If you selected any of the QoS reports by destination (QoS by Destination IP, for example), this field displays average destination R factor.
Avg Src Packet Loss Represents the number of packets lost. This is reported when media routing is in effect. If you selected any of the QoS reports by destination (%) (QoS by Destination IP, for example), this field displays average destination packet loss. If you select the QoS by Source Codec or QoS by Destination Codec reports, the report displays both Avg Src Packet Loss and Avg Dst Packet Loss. Avg Src Latency The average Latency, or delay, for calls initiated by the source IP/port. This field displays only if you select either the QoS by Source Codec report or the QoS by Destination Codec report. The average Latency, or delay, for calls terminated by the destination IP/port. This field displays only if you select either the QoS by Source Codec report or the QoS by Destination Codec report. The timestamp of the first call from the IP address listed, based on the Begin Date you specified for the report. The timestamp of the last call from the IP address listed, based on the End Date you specified for the report. Clicking this link displays detailed information for the calls received from the source IP address specified in this row. See QoS detail. Clicking this icon displays a graph of the data in that row. See QoS graph.
Avg Dst Latency
First Call Last Call Detail QoS Graph icon
QoS detail
When you click Detail from the report displayed on the Engineering report page, the next level of detail displays. The detail level for the QoS report displays the four different call types that are in each selected row of the QoS report. Use the information at this level to review the ratio of successful or unsuccessful calls to total calls. The call types are:

A=Abandoned, B=Busy, E=Error N=Normal
Accessing QoS Detail

To access the QoS Detail page, do the following: 1. From the Engineering page, click Detail. 2. The QoS Detail page displays. 3. To close the QoS Detail window, click > Close Window.
32
RSM Reporting
Field Descriptions for QoS Detail report

Note: Field descriptions in this table are for the QoS by Source IP report. If you select a different QoSreport, the first field indicates the type of report you selected and how the information is sorted. For example, if you select the QoS by Destination IP report, the first field is the Destination IP Address/Port, which is the IP address/port to which calls are sent or that terminates the call. Field Description
Src IP Address/Port The source IP address/port that initiates the calls. Code The principal causes for a terminated call and if the call will be billed. N > Normal > Will be billed. A > Abandoned > Will not be billed B > Busy > Will not be billed E > Error > Will not be billed The number of calls received from or initiated by the listed IP/port. If you selected the QoS by Destination IP report, this field displays the number of calls sent to or terminated by the Destination IP. The total minutes for the listed IP/port. The average duration, in seconds, for the calls received from the source IP address. The average source Post Dial Delay (PDD), reported in msec. Post dial delay is the amount of time that a caller or calling endpoint has to wait before getting any indication that the call is going to be completed.
Calls
Minutes Avg DUR Avg PDD (msec)
Avg Src PDV (msec) The average source Packet Delay Variance (PDV), reported (in ms) when media routing is in effect. This is commonly referred to as Jitter. PDV or Jitter measures the variation in packet arrival times. If you select any of the QoS reports by destination (QoS by Destination IP, for example), this field displays average destination PDV. Avg Src R Factor The average source R factor describes the quality for the segment of the call that is carried over this specific stream. This is reported for two-party audio streams when the QoS module is enabled on the MSX. If you selected any of the QoS reports by destination (QoS by Destination IP, for example), this field displays average destination R factor.
Avg Src Packet Loss Represents the number of packets lost. This is reported when media routing is in effect. If you selected any of the QoS reports by (%) destination (QoS by Destination IP, for example), this field displays average destination packet loss. If you select the QoS by Source Codec or QoS by Destination Codec reports, the report displays both Avg Src Packet Loss and Avg Dst Packet Loss. First Call Last Call Detail The timestamp of the first call from the IP address listed, based on the Begin Date you specified for the report. The timestamp of the last call from the IP address listed, based on the End Date you specified for the report. Clicking this link displays detailed information for the calls to the source IP address specified in this row.
33

To view the next level of the QoS Detail page, do the following: 4. Click Detail. 5. The CDR List view displays.
QoS graph
Clicking on the QoS Graph icon on the right end of each data row (record) or the heading row of the QoS report results in a pop-up window presenting a graph of the data for that row, with the xaxis representing the data parameter chosen on the main page. Clicking in the heading row provides a graph for the summary line.
Prerequisites for viewing the QoS graph

To view the QoS graph, you must have the SVGViewer browser plug-in installed. To install the SVGViewer browser plug-in, follow these steps: 1. Click the here link on the QoS Graph. 2. The SVG Installation page displays. 3. Follow the instructions provided for your browser type. 4. If you continue to have problems, contact NexTone support.
34
RSM Reporting
QoS report: CDR List view

The CDR List is the next level of detail in the QoS report. This level displays a brief summary of each call that makes up a selected line from the QoS Detail report. It can also be used to see further call details on each call type. For example, if you see a lot of error calls on the QoS Detail level, you can go to this level to see what ISDN cause codes are being generated in those calls.

To access the CDR List page, do the following: 1. From the QoS Detail page, click the Detail link. 2. The CDR List page displays. 3. To move to the next page of information, click Next>>. 4. To move to the previous page of information, click <<Back. 5. To close the CDR List page, scroll to the bottom of the page and click >Close Window.

Field Date Orig RegID/Port Term RegID/Port Phone Number Dialed Duration PDD (msec) Description The start date and time of the call. Identifies the endpoint's originating registration identification and port. Identifies the endpoint's terminating registration identification and port. The originating phone number. The number the iServer sends out to the termination. Specifies the duration of the call in minutes. The post-dial delay for calls listed. (Note that in this report, the PDD is not the average). The ISDN Cause Code for the call. This field provides a error description for the call.
ISDN Code Error Desc

Types of Business reports

The following is a description of the business reports available in RSM.
35
Field Region by Calls
Description This report is sorted by region, with the highest number of calls displaying first. This report is sorted by region, with the highest billable minutes displaying first. This report is sorted by region with the highest revenue displaying first. This report is sorted by region with the region with the highest profit displaying first. This report is sorted by supplier ,with the highest number of calls displaying first. This report is sorted by supplier , with the highest billable minutes displaying first. This report is sorted by supplier , with the highest revenue displaying first. This report is sorted by supplier , with the highest profit margin displaying first. This report is sorted by customer ,with the highest number of calls displaying first. This report is sorted by customer, with the highest billable minutes displaying first. This report is sorted by customer, with the highest revenue displaying first. This report is sorted by customer, with the highest profit margin displaying first. This report is sorted by customer service type, with the highest number of calls displaying first.
Region by Minutes
Region by Revenue
Region by Profit
Supplier by Calls
Supplier by Minutes
Supplier by Revenue
Supplier by Profit
Customer by Calls
Customer by Minutes
Customer by Revenue
Customer by Profit
Customer Service Type by Calls
Customer Service Type by Minutes This report is sorted by customer service type, with the highest billable minutes displaying first. Customer Service Type by Revenue Customer Service Type by Profit This report is sorted by customer service type ,with the highest revenue displaying first. This report is sorted by customer service type, with the highest profit margin displaying first. This report is sorted by supplier service type, with the highest number of calls displaying first.
Supplier Service Type by Calls
36
RSM Reporting
Supplier Service Type by Minutes
This report is sorted by supplier service type, with the highest billable minutes displaying first.
Supplier Service Type by Revenue This report is sorted by supplier service type, with the highest revenue displaying first. Supplier Service Type by Profit This report is sorted by supplier service type, with the highest profit margin displaying first. This report is sorted by Orig REGID, with the highest number of calls displaying first. This report is sorted by Orig REGID, with the highest billable minutes displaying first. This report is sorted by Orig REGID, with the highest revenue displaying first. This report is sorted by Orig REGID, with the highest profit margin displaying first. This report is sorted by Orig IP, with the highest number of calls displaying first. This report is sorted by Orig IP, with the highest billable minutes displaying first. This report is sorted by Orig IP, with the highest revenue displaying first. Orig IP by Profit This report is sorted by Orig IP, with the highest profit margin displaying first. This report is sorted by Term REGID, with the highest number of calls displaying first. This report is sorted by Term REGID, with the highest billable minutes displaying first. This report is sorted by Term REGID with the highest revenue displaying first. This report is sorted by the Term REGID, with the highest profit margin displaying first. This report is sorted by Term IP, with the highest number of calls displaying first. This report is sorted by Term IP, with the highest billable minutes displaying first.
Orig REGID by Calls
Orig REGID by Minutes
Orig REGID by Revenue
Orig REGID by Profit
Orig IP by Calls
Orig IP by Minutes
Orig IP by Revenue
Term REGID by Calls
Term REGID by Minutes
Term REGID by Revenue
Term REGID by Profit
Term IP by Calls
Term IP by Minutes
37
Term IP by Revenue
This report is sorted by Term IP, with the highest revenue displaying first. This report is sorted by Term IP, with the highest profit margin displaying first.
Term IP by Profit
Business reports
Business reports can be filtered by origin or destination registration or port, or by searching for a particular embedded string. You can also specify date and time ranges and a refresh interval. Note: Date and time formats are displayed in the formats specified for the partition and partition user. The currency symbol displayed on a report is determined by the currency format specified for the partition. Refer to Date and time formats and Currency formats for information. The business reports are grouped as follows:

Region Supplier Customer Customer Service Type Supplier Service Type Orig REGID Orig IP Term REGID Term IP
Each report also has four sort criteria; Calls, Minutes, Revenue, and Profit. The sort order is the difference in these reports. Therefore, the report criteria by minutes puts the row with the most number of minutes on top. The report criteria by revenue puts the row with most revenue on top, and so on. However, it is possible for the four sort criteria to result in the same order depending on the profit margin of the calls involved.
Displaying the Business report

To access the Business report page, do the following: 1. Log onto the system as described in Logging into RSM. 2. Click Reporting>Business. 3. The Business report page displays. 4. Choose the specific reportRegion by Calls, for example. 5. Select the Host by scrolling through the Host ID list.
38
RSM Reporting
6. Enter the Begin and End Date for the report. NOTE: You can enter dates using the calendar icon located to the right of the date fields. 7. Select the Time Zone from the drop-down list. 8. Enter search criteria, if you wish, in the appropriate fields. NOTE: RSM allows the use of wildcards supported by MySQL in the Orig Reg ID and Dest Reg ID fields. 9. Select a Partition from the list. 10. Select your desired Refresh Interval from the drop-down list, or accept the default. 11. Click Show. 12. After some processing time, the Region by Calls report displays. 13. Use the Prev and Next buttons to move from page-to-page if the report data doesn't all fit on one page.
Clearing the Business report

To clear the page of entered search criteria, click Clear. WARNING: Clicking Clear removes all output information from the page. The cleared information cannot be retrieved.
Filters
See Filters.
Emailing a report
Use the Email button to email the report. 1. Position your mouse over the Email button. A dialog box opens to allow you to specify email options. 2. In the To: field, enter the email address to which you want to send the report. Use a comma (,) to separate multiple email addresses. 3. In the Subject: field, enter a subject for the email. 4. Click Send to send the report. The report will be sent as a CSV file attachment. Note: To email a report, you must set the email configuration options on the System tab. See Configuration for details.
Saving a report
Use the Save button to save the report to a file on the client machine. 1. Position your mouse over the Save button. A drop-down list of the available file formats displays.
39
2. Select a format from the list. You have the following options:

HTML XML CSV Text
Customizable Chromocode
A color coding system is used in the report display to indicate threshold levels. There are three threshold ranges, each with its own color: high (good), medium (marginal), and low (unacceptable). By default, these threshold display and print in green, amber, and red, respectively. To adjust the default color associated with a threshold, see Customizing the Chromocode.
Route Profit reports

The Route Profit report shows billing activity. This report cannot be used to generate customer bills; a separate system is needed to turn rated CDRs into paper bills. Note: Date and time are displayed in the formats specified for the partition or partition user. The currency symbol displayed on a report is determined by the currency format specified for the partition. Refer to Date and time formats and Currency formats for information. The Route Profit option can generate two types of reports: Customer and Supplier .
Accessing the Route Profit report

To access the Route Profit report: 1. Click Route Profit on the Reporting tab. 2. The Route Profit report page displays. 3. In the Report field, select the Route Profit report you want from the Report list: Customer (the default) or Supplier. 4. Select one or more Carrier(s) for your report. You can select more than one, using either one or both of the following methods:

Holding down <Ctrl> while clicking on each individual carrier. Selecting a range by clicking on the uppermost one, then holding down <Shift> while clicking the bottom one.
5. Select the Host from the list. 6. Select a Partition from the list. 7. Enter any date range criteria you wish in the Begin Date and End Date area. You enter dates by clicking the calendar icon to the right of the date fields and clicking on the date you want in the calendar pop-up. NOTE: When selecting Begin and End dates the following rules apply:
40
RSM Reporting

If no dates are specified, the default is to show only data for the preceding 60 minutes. Entering only a Begin Date yields a report containing all data from that date, forward to the present. Entering only an End Date yields a report containing all data from the earliest date in the database up to and including that date.
8. Select the Time Zone from the list. 9. Enter any additional search criteria in the appropriate fields. 10. Select your desired Refresh Interval from the drop-down list, or accept the default. 11. Click Show. After some processing time, your report displays. 12. Use the Prev or Next to move from page-to-page if the report data doesn't all fit on one page.
Additional options on the Route Profit report page

Showing a Printable View To show a printable view of the Route Profit report, do the following 1. Click the Show Printable View link on the lower left corner of the Route Profit page. 2. Click > Close Window to exit this page. Downloading the Route Profit Report 1. Click either [All], [Completed] or [Error]. using the Download option in the right column of the report to download raw data for All, Completed, or Error activity. A File Download dialog displays. 2. You can either Open, Save, or Cancel the file.
Filters
See Filters.
Clearing the Route Profit Report

1. To clear the page of entered search criteria, click Clear. WARNING: Clicking Clear removes all output information from the page. The cleared information cannot be retrieved.
Emailing a report
Use the Email button to email the report. 1. Position your mouse over the Email button. A dialog box opens to allow you to specify email options. 2. In the To: field, enter the email address to which you want to send the report. Use a comma (,) to separate multiple email addresses.
41
3. In the Subject: field, enter a subject for the email. 4. Click Send to send the report. The report will be sent as a CSV file attachment. Note: To email a report, you must set the email configuration options on the System tab. See Configuration for details.
Saving a report
Use the Save button to save the report to a file on the client machine. 1. Position your mouse over the Save button. A drop-down list of the available file formats displays. 2. Select a format from the list. You have the following options:

HTML XML CSV Text
Fields on the Route Profit report

Field Partition Description The name of the partition of which the user is a member. Every user must be a member of some partition. Partition membership controls the endpoints and ports accessible to that user when requesting reports. The partition selected determines what carrier list and host name information is displayed on this page. Report Carrier Identifies the type of Route Profit report, i.e., Customer, Supplier. An external call transporting entity that connects to the VoIP network. Carriers are most often peering partners of the owner of the VoIP network, controlled by the session controller with which RSM is associated. A host can be an iServer, or any device (such as a third-party gateway) that sends CDRs to the RSM. The RSM agent, or the programs that are sending the CDRs to the RSM, is responsible for populating this field in the CDRs. For iServer, the hostname of the machine is filled in as default. Specifies the beginning date range of CDRs to be included in the report. Specifies the ending date range of CDRs to be included in the report. The time zone for time specified in the End Date field. This field indicates the page number of the displayed information. This field indicates the number of entries to be displayed. The default is 100
Host
Begin Date End Date Time Zone Page Number Page Length
42
RSM Reporting
lines of displayed information. Refresh Interval This field automatically refreshes the report results without your having to resubmit the request.
Custom report
The RSM system provides a tool for getting reports that are not otherwise provided in the standard complement of reports. This tool is entered from the Engineering reports page. The dialog panel used to specify the parameters for this type of report is shown below. The purpose of the Custom reports is to provide maximum flexibility in displaying CDR data. Most of the elements in the Custom report are derived from the Engineering report. These reports allow you to arbitrarily group any elements of data. For example, you can group by IP address, ASR, and Total Calls. The general process for this tool is to first specify the basic filtering parameters on the Engineering Report page, then the custom parameters on the panel shown above.
Accessing the Custom report

To access the Custom report page, do the following: 1. Log onto the system as described in Logging into RSM. 2. Click Reporting>Custom. 3. The Custom report page displays. 4. Enter search criteria in the Search For fields. 5. Use the Group By, Display, and Group By check boxes to indicate which data fields to display and the order in which data should be displayed in the report. 6. Select the host by scrolling through the Host list.
7. Enter the Begin and End dates for the report. You can enter dates using the calendar icon located to the right of the date fields. 8. NOTE: You should disable any pop-up blocker(s) for RSM or pop-up windows, such as the Calendar window, will not display. Please note, most browser add-ons and toolbars have pop-up blockers. 9. Select the Time Zone from the list. 10. Enter any additional search criteria in the appropriate fields. 11. Select your desired Refresh Interval from the list, or accept the default. 12. NOTE: When entering a grouping value, remember to click the check box that enables that field. 13. Click the Show button. 14. The content area of the custom report displays.
43
NOTE: The information displayed in the content area of the Custom reports depends on the selection criteria. For example, if the selection criteria is based on Customer and Supplier the content area would display only these two columns. The actual CDRs from which the report is taken can be saved into a file on your workstation.
Clicking [All], [Completed], or [Error] in the Download column heading saves all CDRs for all plans shown in the table. Clicking [All], [Completed], or [Error] in the Download for an individual plan name will save only the CDRs for that row of the table. The CDRs are saved via your workstations Save As... dialog, by default into a file named customercdrs.
15. Use the Prev and Next buttons if the report does not fit on one screen.
Field Descriptions
Field Dial String Description Use this parameter to specify one or more digits on which to match. Used in conjunction with the Group and Strip parameters, you can examine any subset of digits in the dialed number. This field allows wildcards to widen the selection.
Strip - The quantity of leading digits to be removed (stripped) from the dialed number before matching digits and aggregating results. Group - The quantity of digits to aggregate together when sorting the report results.
Example: Suppose a carrier wanted to see all traffic from the US to India. These three parameters would be set to:

Dial String: 91 Strip: 3 Group: 2
Lets say the dialed number is 011 91 12 34567. This setup strips off the first three digits and searches for a dial string that has a length of two. In this example, the dial string is 91. Region Duration Specify one region code here. (Wildcards can be used.) Specify a call duration (in seconds) here, based on the relational operator (>, =, or <) in the drop-down list next to the text box. Note that the equals operator has limited use, since an exact match in duration would be rare. Also note that to obtain a duration such as one minute or more, you would simply use > 59 secs. This is the ISDN Disconnect Cause Code. Enter one numeric code. Clicking the field label brings up a list of valid codes. Specify an endpoint IP address in this field. Wildcards are accepted for specifying a range of addresses. Use the ingress and egress radio buttons to
ISDN Code
IP Address
44
RSM Reporting
select which endpoint you want to report on; either works for hairpin calls. Regid Specify an endpoint registration ID here and the IP address can also be used. Wildcards work here. Use the ingress and egress radio buttons to select which endpoint you want to report on; either works for hairpin calls. This field is case sensitive. Note: RSM supports the use of wildcards supported by MySQL. Error Description Click the field label to get a pop-up window listing valid descriptions. Clicking on a code closes the pop-up, and populates this field. Note: Wildcards can broaden the selection. Customer Supplier ASR This field identifies the customer who is the traffic originator. This field identifies the supplier who is the traffic terminator. This field shows Answer Seizure Ratio in the report. The Answer Seizure Ratio is the ratio of the number of successful calls over the total number of outgoing calls from a carriers network. Clicking the Display box for this field shows Average Request Rate for ISDN calls. ISDN codes for ARR calculation are configured on a per partition, and/or per user basis. ARR is calculated as: ARR = (goodCalls/calls with ISDN code in configured list)*100. Note: SIP calls dont have ISDN CC. Average PDD Clicking the Display box for this field shows the average post-dial delay for calls selected. Clicking the Display box for this field shows the aggregate total for all calls matching the selection criteria. Used to store the operational state (summarized, marked to be re-rated, etc) of the rating process. The length of the search string for the Dial String field. A list of available partitions on which to search. For Admin Users only. The quantity of leading digits to be removed (stripped) from the dialed number before matching digits and aggregating results. From the perspective of the iServer, this is an incoming call. At the calls point of entry into the network, also called source. The call leaving the iServer, going to a termination endpoint. At the calls point of exit from the network, also called destination
ARR
Total Calls
Rating Status
Partition (Group) Partition Strip
Ingress
Egress
45
Display
Allows you to select the group and display the order by which the fields will display. Lists the fields by group order. You can move the order of the fields by highlighting the field and either clicking the Up and Down buttons. Lists the fields by display order. Once a field is specified, its name shows in either the Group Order or the Display Order box. To change the left-to-right order in which fields appear in the report, click on a field, then click Up or Down to alter the fields position. A host can be an iServer, or any device (such as a third-party gateway) that sends CDRs to the RSM. The RSM agent, or the programs that are sending the CDRs to the RSM, is responsible for populating this field in the CDRs. For iServer, the hostname of the machine is filled in as default. Specifies the beginning date range of CDRs to be included in the report. Specifies the ending date range of CDRs to be included in the report. Element used with the time transform, any valid value for a Unix time zone, literally expressed, in quotation marks. Identifies the page number of the displayed report. This field indicates the number of entries to be displayed per page. The default is 100 lines of displayed information per page. This field specifies how often, in minutes, the RSM automatically refresh the report.
Group Order
Display Order
Host
Begin Date End Date Time Zone
Page Number Page Length
Refresh Interval
Clearing the Custom Report

WARNING: Clicking Clear removes all output information from the page. The cleared information cannot be retrieved. 1. To clear the page of entered search criteria, click the Clear button.
Emailing a report
Use the Email button to email the report. 1. Position your mouse over the Email button. A dialog box opens to allow you to specify email options. 2. In the To: field, enter the email address to which you want to send the report. Use a comma (,) to separate multiple email addresses. 3. In the Subject: field, enter a subject for the email. 4. Click Send to send the report. The report will be sent as a CSV file attachment.
46
RSM Reporting
Note: To email a report, you must set the email configuration options on the System tab. See Configuration for details.
Saving a report
Use the Save button to save the report as a file on the client machine. 1. Position your mouse over the Save button. A drop-down list of the available file formats displays. 2. Select a format from the list. You have the following options:

HTML XML CSV Text
Obtaining Custom Report details

Once the basic parameters have been entered in the main Custom Report page, clicking the Show button sends the report request to the server and, in a moment, the report content page displays. From the content page, there are a few options for examining the returned data more closely.
SVGViewer
If you are unable to view any of the detail reports or graphs, you must install the SVGViewer. 1. Scroll down an select either the Internet Explorer for WIN or the Mozilla for Win. 2. Follow all instructions. 3. Close your browser window and log in again.
The Unrated CDRs report

As the session controller processes calls, CDRs accumulate in its data files. The CDRs get rated based on the data entered in the Rating function, at intervals based on how the RSM agent software is configured. In order for a CDR to get rated, certain key fields (IP address and dialed number) must match those defined in the rating records created and maintained using the Rating function. If there is no precise match, the CDR cannot be rated, but remains in the CDR data files as an unrated record. Reasons for a no match condition may be many. It could be that a rating record was never set up for that key combination, or there may be a more significant reason, such as fraud. Therefore, the Unrated CDRs report is an important tool for analyzing network and business systems health. Requesting the Unrated CDRs Report To request the Unrated CDRs report, follow these steps:
47
1. Enter appropriate grouping criteria. For this example the selected grouping criteria is Dial String, ASR and ARR. 2. At the bottom of the Custom report page, choose Rating Status and select Unrated. 3. Optionally, you may specify a particular combination of endpoint registration ID (and optionally, port), for the origination or destination endpoint. 4. Enter optional beginning and ending dates by clicking on the calendar icon to the right of each field and clicking on the date you want. Note that if no date is specified, the report is only for the last hour of CDR data available.

If you specify no date, RSM reports on all CDRs matching the grouping criteria. If you specify only a Begin Date, RSM reports on all CDRs matching the grouping criteria, having a date stamp from that date forward. If you specify only an End Date, RSM reports on all CDRs matching the grouping criteria, having a date stamp up to and including that date. Specifying a Begin Date and an End Date tells RSM to include in the report all those records matching the grouping criteria from the beginning date to the ending date, inclusive. Optionally, specify a time zone in the Time Zones list.
5. Select a different Refresh Interval from that list if you wish. This automatically refreshes the report results without your having to resubmit the request. 6. Clicking the Show button requests the report. 7. NOTE: Depending on your grouping criteria and other factors, the report can take several minutes to be displayed. 8. The report displays one entry for each combination of Dial String, ASR and ARR. The other columns are as follows: First Call. The timestamp of the first unrated call between the two endpoints, meeting all the filter criteria. Last Call. The timestamp of the last unrated call between the two endpoints, meeting all the filter criteria. 9. Clicking on the Detail link at the end of any record in the report takes the report down one level of detail. 10. You can also specify Download criteria by which to view All, Completed, and Error raw data.
Custom Detail
This level displays the four different call types that are in each selected line of calls from the previous report. This level can be used to see, in general, what the ratio is between good and bad calls.
Accessing Custom Detail Dialog

To access the Custom Detail dialog, do the following: 1. From the Custom Report output page.
48
RSM Reporting
2. Click Detail. 3. The Custom Detail dialog page displays. 4. Click > Close Window to close the dialog box.
Field Descriptions
Field Dial String Description Used in conjunction with the Group and Strip parameters, you can examine any subset of digits in the dialed number. This field shows the average post-dial delay for calls.
Avg Duration (sec) Total Duration (sec) ASR
This field shows the average duration in seconds for calls.
This field shows Answer Seizure Ratio in the report. The Answer Seizure Ratio is the ratio of the number of successful calls over the total number of outgoing calls from a carriers network.
ARR
This field shows Average Request Rate for ISDN calls.
Avg PDD (msec) This field shows the average post-dial delay for calls selected. Code This field describes the principal causes for a terminated call and if the call will be billed. N > Normal > Will be billed. A > Abandoned > Will not be billed B > Busy > Will not be billed E > Error > Will not be billed
49
RSM Alarming
Creating and managing alarms
Use the Alarming tab to create and manage alarms. An alarm is a set of conditions defining an operational exception, intended to trigger one or more actions. Events are occurrences of alarm conditions. Note: You can configure alarms using both the Alarming tab and the Systems tab. Use the Alarming tab to configure alarms that monitor activities on the MSX server. Use the Systems tab to configure alarms that monitor the RSM server. For information on creating system alarms, refer to There are two categories of alarms: CDR alarms or Log alarms. CDR alarms are triggered based on the traffic patterns detected from the CDRs generated on the MSX. Log alarms are triggered based on the events that appear in the MSX log file. When an event occurs that meets the conditions defined, the alarm is triggered. An entry is placed in the Event list, and the action or actions defined for that alarm are performed. Creating and managing alarms includes the following tasks:
Defining the actions that will occur when an alarm is triggered. See Actions for information on defining actions. You create a set of actions, then create the alarms, indicating for each alarm what action you want the system to perform when the alarm is triggered. Creating CDR alarms. See Adding a CDR alarm for information. Creating Log alarms. See Adding a Log alarm for information. Modifying and deleting events. See Alarm events. Note: Alarming is a licensed feature in RSM. Contact Customer Support for information. (See Contacting Customer Support.) NOTE: The root user can see and edit all users alarms and actions. Non-root users can see their own alarms and actions, as well as the alarms and actions of other users in the same partition. As a result, the root user may see what appears to be duplicate alarms that are not actually duplicates, because they were created by different users. NOTE: RSM does not distinguish between users, it only distinguishes partitions. Thus, if two users belong to the same partition, they can see each other's data; however, they cannot see the data that belongs to a different partition. Only users in an Admin partition can see data from all other partitions.
Alarming tab: types of actions

The following is the list of available alarm actions. Field Block Endpoints Description An additional parameter called trickle is added to the block actions. When the block action is triggered, instead of completely blocking the endpoint from calls (setting max calls to 1), it sets the max calls to the trickle value. This
51
results in a trickle of calls going through the endpoint after the block action is done. This action is only available if the ARM license is enabled. Endpoint Priority This action changes the endpoint priority to the configured value. An example of how you might use this alarm is to change priorities of endpoints based on their current ASRs, thus providing an overall higher ASR to the source. This action is only available if ARM license is enabled. Execute Script This action executes a script on the RSM server. Enter the name of the script you want to execute in the Script Name field. The script must be available in the nextonehome/actionscripts on the RSM server and must have the Execute privilege enabled. This action appends an entry either to the RSM system log file (syslog) or to another log file. To configure for syslog, configure the syslog server Host Name, an optional Log Name (a string that appears in all syslog messages; default is 'RSMLog'), Facility and Severity. The syslog messages are sent to UDP port 514 on the server. To configure for a plain file log, enter the complete log file path name under Log Name and ignore the rest of the fields. Move to Last Priority Mail This action lowers the route priority of all routes belonging to the region and carrier specified in the alarm. This action sends an email to a recipient. To specify multiple recipients, list them with a comma separator. This action depends on the email configuration settings you specify using the Configuration option under the System tab. See Configuration for information on these settings. Restore Route Priority This action modifies the original priority value that was configured on the routes and was modified by a previous lower route priority action.
Log
Set Route Priority This action modifies the route priority by the specified value (the existing priority will be changed by this amount). SNMP Trap Allows device monitoring of the MSX server using SNMP. This action sends a SNMP v2c trap to the configured trap receiver. The trap is an enterprisespecific trap that specifies specific alarm details. When you create an alarm, you can associate it with the SNMP Trap action, causing RSM to send a SNMP trap whenever it detects the condition configured in the alarm. The alarm description for the alarm supplements the information in the SNMP trap, making it easier to associate the information in the trap with the alarm that triggered it. The following information is required when you create an SNMP Trap action:
Receiver IP: The IP address of an external entity that receives the SNMP traps from the RSM server.
52
RSM Alarming
Community: The password that is used to send traps to the Receiver.
Unblock Endpoints
The unblock action restores the max calls configuration on an endpoint to the value that was present prior to a block action. An unblock action triggered without a prior block action does nothing. This action is only available if the ARM license is enabled.
Adding a CDR alarm

To add a new CDR alarm, click Add from the CDR Alarms page. The Add CDR Alarm page displays.
Field Descriptions
Note: Date and time are displayed in the formats specified for the partition or partition user. Refer to Date and time formats for information. Field Alarm Type Description Identifies the alarm type. Select an alarm type from the Alarm Types list. Some of the other fields on the Add CDR Alarm page will be enabled/disabled depending on your choice of alarm type. Assigns the alarm to a partition. You must be a member of the Admin partition to assign an alarm to a partition. Otherwise, the alarm is automatically assigned to the partition of which you are a member. Allows you to enter a name for this set of conditions. A host can be an MSX, or any device (such as a third-party gateway) that sends CDRs to the RSM. The RSM agent, or the programs that are sending the CDRs to the RSM, is responsible for populating this field in the CDRs. For MSX, the "hostname of the machine is filled in as default. The action that is to be performed when the conditions in the alarm are met. For example, if the alarm condition is set to an Average Success Rate (ASR) less than 50 percent, the On Trigger action is performed when the ASR falls to less than 50 percent. When the trigger condition is reset, i.e., ASR goes back above 50%, then the OFF-trigger actions are performed. When used in conjunction with block and unblock actions, can be used to take an endpoint in and out of service based on some alarm trigger condition. Off Trigger Action The action that is to be performed when the conditions in the alarm are no longer being met. For example, if the alarm condition is set to an ASR less than 50 percent, and the ASR is above 50 percent, the Off Trigger actions are performed. Defines the severity level of the alarm. The drop-down list includes the severity levels that you can define: None, Warning, Minor, Major, and Critical. None is the default. When RSM creates alarm events, each event entry in the Alarm Events screen is color-coded to indicate the severity level. The following severity levels can be associated with an alarm:
Partition
Name Host
On Trigger Action
Alarm Severity
53

Critical: associated events are violet Major: associated events are red Minor: associated events are orange Warning: associated events are yellow None: associated events are not color-coded
Description
Enter the text that you want to appear on the Event listing page when this alarm occurs. Shows the applied condition of the alarm type selected in the Alarm Type field. For example, if you selected Average Packet Delay Variance (APDV) in the Alarm Type field, the key field displays apdv. The comparison operator you want to use in conjunction with the Value field to specify the conditions that must be met for the alarm to be triggered. Possible values are:

Key
Condition
less than less than or equal to greater than greater than or equal to
Value (sec)
The value associated with the comparison operator to build the condition. The value in this field varies based on the Alarm Type you select. For example, if you selected Average Call Duration (ACD) this field would be Value (sec). If you chose an Alarm Type of Average Packet Delay Variance (APDV) the field would be PDV (msec). Identifies the minimum number of CDRs that the alarm should consider before an alarm is triggered. The system looks at both the successful and nonsuccessful alarms. If the Alarm Type:
Min CDR Count
Duration (min)
Is not in Gateway Minutes, the span of time in which it accumulates errors is based on the Key and Condition. There is no duration for the Gateway Minutes and Dollar Amount, instead they have a time interval. Is in Gateway Minutes, the gateway minutes limit which if exceeded, causes an event. There is no duration for the Gateway Minutes and Dollar Amount, instead they have a time interval.
NexTone recommends not setting a Duration longer than necessary, because system resource requirements increase with both Duration and call processing rates. That is, the longer the Duration, the more CDRs have to be evaluated, which has a net adverse effect on system performance.
54
RSM Alarming
Available Endpoints
The RegID, Realm, and Name of the MSX of the endpoint device whose CDRs can be evaluated by this alarm. Applies to traffic with this endpoint as either the source or destination as selected. Displays the endpoints you have selected from the Available Endpoints list. Allows the user to separately query any endpoint on the database.
Selected Endpoints Evaluate All Available Endpoints Individually Endpoints
Allows the user to select endpoints by origination/source or termination/destination. This field describes a region, used to group one or mode dial codes. Example: BHUTAN-SATTELITE Alarms can have a region parameter configured. Only calls that belong to this region are subjected to the alarm criteria. A usage for this is to specify an alarm only for traffic to and from a certain region.
Regions
Supplier Customer Start Date
The supplier is the traffic terminator. The customer is the traffic originators. The date and time at which the alarm goes into effect. (You must enter the date and time in the format specified for the partition and partition user.) This is a time filter that identifies the date and time at which the alarm ceases to be in effect. (You must enter the date and time in the format specified for the partition and partition user.)
End Date
Start Week Days The day of the week on which the alarm goes into effect. End Week Days The day of the week on which the alarm is no longer in effect. Start Time This is a time filter that identifies the time to start counting/looking for alarm conditions. For a description of how start time applies to Gateway Minutes alarms, see Gateway Minutes Alarms. Alarms can have a certain time-of-day configured at which they are considered active. No actions are performed during times that fall out of the active time periods. The time-of-day configuration is flexible enough to be able to provide any combination of weekdays, and a start and end time for those selected days. This time-of-day is different from the Start Time configuration in the alarms. The Start Time is a specific calendar day/time at which the alarm starts becoming active. The time-of-day configuration provides an active day/time relative to the current absolute time. End Time The point in time at which this rate ceases to be in effect. Selected from a pulldown list, the first digit of the entry is the index (Record Number) into the table
55
on the Times page. The rest of the entry comes directly from the Times table. System Load Currently, this field is used to specify the port usage (in percentage value) on the MSX. Alarms can have a System load parameter configured. Only if the system load is at or above the configured limit, would the alarm be considered active. The system load in this case is the number of concurrent calls on the system. A usage for this is to not trigger an alarm if the system is running at off-peak or maintenance conditions. Condition Some key names have values associated with them. This pull-down allows you to specify the comparison operator to use in conjunction with the Value field to select only those records that enable you to detect this alarm condition. Possible values are:

less than less than or equal to greater than greater than or equal to
Value %
In this field you specify the numeric value relating to the comparison operator specified using the Condition pull-down. For gateway minutes reports or Error Description CDR Alarms this must be a whole number (no decimals). For ASR reports, enter only the number, without a percent sign, %.
To add a new alarm, follow these steps: NOTE: RSM supports a maximum of 200 active alarms at any one time. Having more then this number could affect system performance and eventually cause the database server to run out of connections. 1. From the CDR Alarms page, click Add. 2. The Add CDR Alarm dialog displays. 3. Select an alarm type from the Alarm Types list. Some of the other fields will be enabled/disabled depending on your choice of alarm type. 4. If you are a member of the Admin partition, select the Partition to which this CDR will below. The drop-down list displays the available partitions. If you are not a member of the Admin partition, the partition field will display the name of the partition of which you are a member. 5. Press <Tab> or click in the Name box, and enter a name for this set of conditions. 6. From the Host list, choose a session controller host machine name, or choose All. If there is only one host machine associated with this RSM system, All is the only choice presented. 7. From the On Trigger Action, choose a block action to turn on the trigger. 8. From the Off Trigger Action, choose a block action to turn off the trigger.
56
RSM Alarming
9. Click the Test Action buttons if you wish to test available action(s). NOTE: It is advised that you configure the alarm before you test it to determine whether the action is working. 10. In the Description field, enter the text that you want to appear on the Event listing page when this alarm occurs. 11. The parameters in the Conditions area allow you to specify individual data found within CDRs for RSM to use as alarm triggers. 12. The parameters in the Endpoint area allows you to specify endpoint data found within the CDRs.
The two radio buttons allow you to specify whether you want to further restrict the endpoint to Origination/Source or Termination/Destination. The Evaluate All Available Endpoints Individually option tells the system to query each endpoint separately to determine if it satisfies the alarm condition.
13. The Region/Supplier/Customer area allows you to specify region, supplier, and customer details. 14. Click the Additional Filters link to display additional alarm filters. 15. The parameters in the Time of Day Filter area provide ways to specify time data within CDRs for RSM. The Time of Day Filter restricts the alarm conditions to within the specified time. 16. The parameters in the System Load Filter area provide ways to specify filter data within CDRs for RSM. 17. When finished entering data, click the Submit buttton. 18. A message similar to the one below displays. Successfully added alarm 'xxxx'. 19. Your new alarm is saved and you are returned to the Alarm page. 20. The new alarm is listed on the CDR Alarms page as disabled. NOTE: To activate the new alarm, click the "disabled" alarm to make it enabled.
CDR alarm types

The available alarm types for CDR alarms are as follows: Alarm Type Average Call Duration (ACD) Description This alarm triggers when the average call duration meets the configured threshold value. For example, this alarm could be configured to trigger when the average call duration falls under, say, 5 seconds, indicating some problem in the operation. This alarm is based on the Packets Lost and Packets Received values in the CDRs. This alarm triggers if the average Packet Loss of all calls in a configured window of
Average High Packet Loss
57
time exceeds a configured threshold. The average is calculated using values from both sides of a call. Average Low Voice Quality This alarm is based on the R Factor value measured on the call. This alarm triggers if, the average R Factor of all calls in a configured window of time exceeds a configured threshold. The average is calculated using both the R Factor values in a CDR. For example, trigger an alarm if the average R Factor of the calls over a 30 minute period is less than 75. Average Packet Delay Variance (APDV) This alarm is based on the PDV (jitter) value measured on the call. This alarm will trigger if, the average PDV of all calls in a configured window of time exceeds a configured threshold. The average is calculated using both the PDV values in a CDR, e.g., trigger an alarm if the average PDV (jitter) of the calls over a 30 minute period is greater than 25ms. This alarm is based on the PDD value measured on the call. This alarm will trigger if, the average PDD of all calls in a configured window of time exceeds a configured threshold, e.g., trigger an alarm if the average PDD of the calls over a 30 minute period is greater than 400ms. Average Request Rate is essentially ASR calculated within a subset of the total calls. ASR is the ratio of the normal calls to the total calls and ARR is the ratio of the normal calls to the total calls with a certain ISDN code values (ISDN code = configured values). The ISDN codes to be used in the ARR calculation is user specific and is configured in the user preferences. This alarm triggers when the ARR meets the configured threshold value within a certain duration. This alarm triggers when the percentage of successful calls meets the configured threshold value. For example, this alarm could be configured to trigger when the average success rate falls under, say 50%, indicating some problem in the operation This alarm triggers when an internal error causes a call to disconnect. Multiple CDR errors could be configured for a single alarm. This alarm is based on the Packets Lost and Packets Received values in the CDRs. This alarm triggers if, in a configured window of time, the number of CDRs containing a packet loss (%) exceeds a configured threshold. Packet Loss from both sides of the call are considered in the alarm. This alarm is based on the R Factor value measured on the call. This alarm triggers if, in a configured window of time, the percentage of CDRs containing the given R Factor
Average Post Dial Delay (APDD)
Average Request Rate (ARR)
Average Success Rate (ASR)
Cdr Error Description
High Packet Loss
Low Voice Quality
58
RSM Alarming
condition exceeds a configured threshold. Both the R Factor values from a CDR are considered in the alarm. For example, trigger an alarm if 5% of the calls over a 30 minute period have a R Factor value less than 65. Packet Delay Variance (PDV This alarm is based on the PDV (jitter) value measured on the call. This alarm will trigger if, in a configured window of time, the percentage of CDRs containing the given PDV exceeds a configured threshold. Both the PDV values from a CDR are considered in the alarm, e.g., trigger an alarm if 5% of the calls over a 30 minute period has a PDV (jitter) value greater than 30ms. This alarm is based on the PDD value measured on the call. This alarm will trigger id, in a configured window of time, the number of CDRs containing the given PDD exceeds a configured threshold, e.g., trigger an alarm if 5 CDRs in a 30 minute period contain PDD exceeding 300ms. This alarm triggers when the cumulative dollar value of the traffic, carried by a certain endpoint, exceeds the configured threshold. This is similar to the Gateway Minutes Alarm, but counts the dollar value of each call instead of the duration of the call. This trigger does not have the "trigger off" capability. This alarm is most commonly used to detect when the accumulated number of minutes carried by a gateway exceeds Duration minutes. It can also be used to detect under use, by choosing a Condition of > (less than). Using a Condition of = (equal to) will rarely make sense, since hitting the exact value is extremely unlikely. It is triggered when the conditions defining it are met. Once it is triggered, the alarm is automatically disabled. When desired, re-enable it manually from the CDR Alarm page. This trigger does not have the "trigger off" capability. This alarm calculates the profit/loss for each CDR and is triggered when the configured threshold is met. This trigger does not have the "trigger off" capability.
Post Dial Delay (PDD)
Dollar Amount
Gateway Minutes
Profit/Loss
NOTE: Alarm types are sorted by group, then in alphabetical order.
Updating a CDR alarm

To update an alarm, follow these steps: 1. Click the alarm (under the Name column). 2. The Update CDR Alarm page displays. See Adding a CDR alarm for field descriptions of the fields on this page. 3. Update all applicable fields. 4. Click Submit to save changes.
59
5. Click Back to return to the previous page.
Deleting a CDR alarm

NOTE: Rather than deleting an alarm, you can disable it by clicking the Disabled ( ) icon. To re-enable the alarm, click the Enabled () icon .
To delete a CDR Alarm, follow these steps: 1. Locate the CDR Alarm you wish to delete. 2. Click , to the left of the Status column. A confirmation dialog box displays.
3. Click OK to delete the selected alarm. 4. A message similar to the following displays: "Successfully deleted alarm xxxxx." 5. Click Cancel to cancel the deletion process and return to the CDR Alarm page.
Adding a Log alarm

To add a Log alarm, do the following: 1. On the Log Alarms main page, click Add. 2. The Add Log Alarm page displays.
Field Descriptions
Field Event Type Description A description of the event that occurred on the iServer that triggered the Log alarm. The actual text logged into the iserver.log file on the iServer that triggered the Log alarm. The partition to which this alarm will be assigned. Only users who are members of the Admin partition can assign alarms to partitions. For other users, the alarm is automatically assigned to the partition of which the user is a member. A name that identifies the set of conditions defined in this alarm. The name should be related to the alarm event. Identifies one or more actions to be performed when the conditions for the Log alarm are met. The MSX on which the events will occur. Defines the severity level of the alarm. The drop-down list includes the severity levels that you can define: None, Warning, Minor, Major, and Critical. None is the default. When RSM creates alarm events, each event entry in the Alarm Events screen is color-coded to indicate the severity level. The
Event
Partition
Name
Action
Host Alarm Severity
60
RSM Alarming
following severity levels can be associated with an alarm:

Critical: associated events are violet Major: associated events are red Minor: associated events are orange Warning: associated events are yellow None: associated events are not color-coded
Description
Descriptive text associated with this alarm that will appear on the Alarm Events page.
To add a Log alarm: 1. Select the type of event from the Event Type list. 2. Press <Tab> or click in the Name box, and enter a name for this set of conditions. 3. In the Action field, highlight one or more actions to be performed when the conditions for this log alarm are met. 4. Click the Test Action buttons if you wish to test available action(s). 5. From the Host list, choose MSX, or choose All. If there is only one host machine associated with this RSM system, All is the only choice presented. 6. Enter a longer text description of the alarm. This descriptive text appears on the Alarm Events page, in the Description column. 7. When finished entering data, click Submit. Your new alarm is saved, the dialog box closes, and you are returned to the Alarm page. 8. A message similar to the following displays: "Successfully added alarm xxxx." 9. The new alarm is listed on the Alarm page.
Actions
Actions are performed when the conditions for an alarm are met. You first define the types of actions that are available, then create an alarm and specify which actions you want to associate with an alarm. You can specify multiple actions for the same alarm, provided that the actions are not multiples of the same type. For example, you could specify email and SNMP trap actions for the same alarm, but not Restore Route Priority and Set Route Priority. See Alarming tab: types of actions for actions that can be performed.
Accessing Actions
To access the Actions page, do the following: 1. Log onto the system as described in Logging into RSM. 2. Click on Alarming>Actions. 3. The Actions home page displays.
61
Adding a new action

To add an Action, do the following: 1. Click Add . 2. The Add Action page displays. 3. Select the Partition to which the action will be assigned. Only users who are members of the Admin partition can assign an action to a partition. For other users, the action is automatically assigned to the partition of which the user is a member. 4. Select an action Type from the list. 5. Give the action a Name. 6. Enter other field data based on the action type you select. 7. Click Submit. A message similar to the one below displays: 8. Successfully added action 'xxxx'. 9. If you do not wish to submit the entry, click Back. You are returned to the Actions main page which now displays your entry.
Field Descriptions
Field Type Description Identifies the type of action to be added, e.g., Block, Endpoint Priority, etc. For information on the additional fields displayed when you select an action type, refer to Alarming tab: types of actions. Name A name to be used to identify the action.
Updating an Action
To update an action, do the following: 1. On the Actions main page, locate the action you want to update by scrolling down the Name column. 2. Click the action you want to update. 3. The Update Action page displays. 4. Make all necessary changes and click Submit. 5. A message similar to the following displays: Successfully updated the action 'xxxx'.
Deleting an Action
To delete an Action, do the following:
62
RSM Alarming
1. Click the
next to the Action you want to delete. A confirmation dialog displays.
2. Click OK to delete the selected action 3. A message similar to the following displays: 4. Successfully deleted the action 'xxxx'. 5. Click Cancel to cancel the deletion process and return to the Actions page.
Updating a Log alarm

To modify an alarm, do the following: 1. Under the Name column, double-click the alarm you want to modify. 2. The RSM Update Log Alarm page displays. Refer to Field Descriptions for Adding a Log alarm. 3. For changes to fields other than to the Event type, tab to the field and enter the new value. NOTE: After modifying an existing alarm, you must disable and enable the alarm, i.e., turn the light bulb on and off, to make the new change effective immediately. 4. Once your changes are all entered, click Submit, and the dialog box closes. 5. Click the Back button to discard any changes you made.
Deleting a Log alarm

To delete an Alarm, do the following: 1. Click the trash can ( icon, i.e., the trash can to the left of the Status column. 2. Click OK to delete the selected alarm. 3. Click Cancel to cancel the deletion process and return to the Log Alarms main page. NOTE: Rather than deleting an alarm, you can disable it by clicking the Enabled ( ) icon. Then, when you want to re-enable the alarm, click the Disabled ( ) icon.
Alarm events
An event is defined as an actual occurrence of the alarm conditions you defined using the Log and CDR alarm pages. The RSM systems Alarms Events page provides a list of events having occurred since the last time the list was manually cleared. The Alarm Events page is divided into two sections. The top section of the screen allows you to select the event data that displays on the page when you click Show. The bottom portion of the screen displays a list of the alarm events you selected. Each defined alarm appears on one line. NOTE: Events are collected in the file: /var/log/iserver.log, in plain text format, which can be viewed with a text tool.
63
Viewing alarm events

To view Events, follow these steps: 1. Log onto the system as described in Logging into RSM. 2. Click Alarming>Alarm Events. 3. The Alarm Events page displays. 4. Click the Prev and Next buttons if the report doesn't all fit on one screen. Note: The Alarm Events page is automatically refreshed every 60 seconds.
Fields to select alarm event data
Note: Date and time are displayed in the formats specified for the partition and partition user. Refer to Date and time formats for information. Fields Alarm Type Description Select the alarm type whose events you want to view. You can select either CDR events or Log events. If you select CDR, RSM displays only CDR events. If you select Log, RSM displays only Log events. The severity level of the alarm. You can select None, Warning, Minor, Major, or Critical. RSM displays events only for those alarms having the severity level you specify. Specify the start date for the event. Type in a date or click the Calendar icon to select the date from a calendar. RSM selects only those events whose start date matches the date you specify. Specify an end date for the event. Type in a date or click the Calendar icon to select the date from a calendar. RSM selects only those events whose end date matches the date you specify.
Alarm Severity
Start Date
End Date
Alarm event data
Note: Date and time are displayed in the formats specified for the partition and partition user. Refer to Date and time formats for information. Field Trash can icon Status Description Allows you to delete the alarm event in this row. Select multiple check boxes to clear a group of alarm events. Enables or disables that alarm, and indicates its state. The bulb icon has two states: enabled (yellow), and disabled (dark gray). By disabling the alarm (rather than deleting it) you can turn it of and then turn it back on later, just by clicking the light-bulb icon again. The system date and time stamped onto the record when it was entered into the event log file. Specifies the line number in the iServer.log file on the MSX. This field is applicable only to Log alarms, not CDR alarms. The text from the Description field in the alarms definition.
Date Time Location Description
64
RSM Alarming
Details
Additional descriptive information. For log events, this is taken from the actual record in the log file; for CDR events, it is system-generated information. Defines the severity level of the alarm. The drop-down list includes the severity levels that you can define: None, Warning, Minor, Major, and Critical. When RSM creates alarm events, each event entry in the Alarm Events screen is color-coded to indicate the severity level. The following severity levels can be associated with an alarm: 8. Critical: associated events are violet 9. Major: associated events are red 10. Minor: associated events are orange 11. Warning: associated events are yellow 12. None: associated events are not color-coded
Severity
Clearing alarm events

You can clear individual alarm events or groups of alarm events using the check boxes associated with each alarm event. To clear alarm events: 1. Click the check box to the left of the alarm event for each alarm event you want to clear. Select multiple check boxes to clear groups of alarm events. 2. Click Clear. WARNING: Clicking Clear removes all output information from the page. The cleared information cannot be retrieved.
65
RSM Provisioning
Overview of RSM provisioning
Provisioning allows you to define and manage rating and routing data, which RSM uses to rate calls and generate routing information for MSX. Before you begin using RSM provisioning, you should become familiar with the following concepts:

Generating and uploading routes Call Detail Records (CDRs) Rates and routes
Once you are familiar with these concepts, refer to the following topics for a description of the tasks involved in provisioning.

Importing rating and routing data Running reports on rating data Manually adding, modifying, and deleting rating and routing data Maintaining rating and routing data Generating and uploading routes
Call Detail Records (CDRs)

As a VoIP session controller processes calls, it records details about each call. At a minimum, the data it collects includes the point at which a call entered the network, where it left, and the calls starting and ending times. Other data collected includes destination response codes, the callers user ID, the actual dialed number, and so on. MSX stores call data in Call Detail Records, or CDRs. For detailed information on CDRs, see the NexTone iServer (MSX) Operations Guide. CDRs are used for call rating, which determines the amount the customer is to be charged for the call transport services provided. The amount charged to the customer is used to determine the profitability of a given route. MSX does not rate CDRs; rather, the RSM Agent sends CDRs to RSM for rating, based on the rating information you import into the RSM rating tables. RSM generates routes based on the imported rating data. Routes are uploaded to the MSX system so that it can route calls.
Rates and routes

The concepts of rates and routes are central to RSM provisioning. Routes are engineering information, configured by the routing engineering group. Routes determine how calls are routed in MSXwhich endpoint to use and how to set routing parameters for carriers, regions, and service type. Rates are business information, configured by the business group. Rates determine how to price a call for carriers, regions, and service type, based on connection charges and billing increments. Carriers, regions, and service type represent information that is shared between the engineering
67
group and the business group. Because this information is common to both groups, the engineering group can change routing information, such as endpoint configuration, or the business group can change pricing information, such as connection charges, and the changes are immediately taken into account in rating CDRs and routing calls.
Provisioning main menu

From the Provisioning tab, you can access the Provisioning main menu, which contains the submenus you use to work with rating and routing data. The Provisioning tab contains these menus:
Menus Rating
Submenu Rates Summary
Function Displays rates and routes summary information by customer or supplier. Results are sorted by carrier. See Running reports on rating data.
Regions Summary
Displays the dialcode grouping information configured in the Regions table. See Running reports on rating data.
Rating Tables -Rates and Routes -Routes -Rates -Regions -Periods Import
Used to add, modify, or delete information on regions, route groups, rates, and rating periods. See Manually adding, modifying, and deleting rating and routing data.
Used to import data into the Rating tables from a set of master data files in character delimited ASCII file2 format. See Importing rating and routing data.
68
RSM Provisioning
Utilities -Rerate
Rerate reruns the rating process, reapplying rating information to the CDRs you select based on filter information. Trace Rate simulates how a CDR will be rated by the system.
-Trace Rate -Check Data Check Data verifies a data set and alerts you if it finds invalid configuration data. You can print any invalid data found. See Maintaining rating and routing data.
Routing
LCR
Used to view Least Cost Routing (LCR) reports, to generate Least Cost Routes, and to upload updated routes to MSX. See Generating and uploading routes.
MPR
Used to view reports by Most Profitable Route (MPR). See Generating and uploading routes.
RSM Console
Used to launch the RSM Console from within the RSM application. See Launching RSM Console.
Importing rating and routing data

Typically, you import data into the rating tables using a set of master text files that contain rating information. Although RSM Provisioning provides you with a manual method for adding rating data, companies typically have too many entries to use this method. The preferred method is RSMs import process, which allows you to quickly import a large quantity of rating data into the RSM tables. The import process is the same regardless of which rating table you select for importing data. Refer to Importing rating and routing data for the steps involved in importing table data. To import rating and routing information into RSM, you need to perform the tasks listed below.
Task Provision endpoints. You must provision endpoints prior to provisioning rating, using the RSM Console. Import data into the Regions table.
For more information...
See Launching RSM Console.
See Regions table.
69
Import data into the Periods table, if you want to do time-of-day rating (optional). Import data into the Rates table. Import data into the ANI table (optional). Import data into the Routes table.
See Periods table.
See Rates Table (Customer/Supplier)
See ANI table. See Routes table.
Regions table
Each entry in the Regions table defines an area of service or breakoutfor example, ItalyCell;0113933;Italy Cell. To import data into the Regions table: 1. Under Rating, select Import. The Import page displays. 2. Select Regions in the drop-down list for the Import Table field. 3. Fill in the rest of the fields on the page. 4. Use the link Click Here for Import Format Help on Selected Table to verify the field format for the import file. 5. Click Import. The Regions table will be populated with the following fields.
Field RegionCode DialCode Profit Threshold Description
Description Name of the breakout given to a group of dialcodes. Individual codes that belong to a breakout. The minimum price per minute margin at which the service provider is willing to carry the call. See LCR with profit thresholds. A description used to further identify this regionfor example, Italy Cell. This field is optional. The date on which this region code was added to the database.
Created
Last Modified
The date on which the information for this region code was last modified.
70
RSM Provisioning
Rates Table (Customer/Supplier)

The Rates table stores data on the various calling terms that are applied to a CDR to determine the cost of a call. How much a call costs is based on minimum call duration, billing increment, and units of currency per billing time. Rates can also take into account call starting and ending times and connection charges. Typically, companies group rating data for sell/customers and buy/suppliers separately. The sell/customer entries in the Rates table create ingress routes; the buy/supplier entries create egress routes. To import data into the Rates table: Under Rating, select Import. The Please select a table to import page displays. Select Customer Carriers-Rates or Supplier Carriers-Rates in the drop-down list for the Import Table field. Fill in the rest of the fields on the page. Use the link Click Here for Import Format Help on Selected Table to verify the field format for the import file. Click Import. The Rates table will be populated with the fields described in Fields in the Customer Carriers-Routes table
Fields in the Customer Carriers-Rate table

Note: Date and time are displayed in the formats specified for the partition and partition user. Currency formats are displayed using the currency symbol specified for the partition. Refer to Date and time formats and Currency formats for information.
Field Descriptions
Fields Carrier RegionCode ServiceType Descriptions Name of the origination carrier. Name of the breakout given to a group of dialcodes. The class of service for this carrier. Typically, a companys business policies determine which service types are assigned to which carriers. Value that determines routing priority for this carrier. You can leave the default value or manually specify a value. If you do not specify a priority value, by default RSM computes priority such that the lower the price, the higher the priority. If you set the Set Dial Code Length field in the LCR Configuration section of the System tab, the longer the dial code, the higher the priority. If you do not
Priority
71
check this field, RSM does not consider dial code length when it calculates priority. If you want RSM to do priority-based routing instead of rate-based routing, specify a priority in this field. Manually specifying a priority overrides the default priority. The higher the number in this field, the higher the priority. See Importing data into the Rates table for priority-based routing for information on populating the required fields for priority-based routing. Profit Threshold The minimum price per minute margin at which the service provider is willing to carry the call. See Definition: Profit Threshold. The minimum connection time, in seconds, for which the customer will be billed. For example, if you specify a MinDuration of 30 and the call is 20, the call will still be billed at 30. The time, in seconds, that is used to round up the duration of a call for billing purposes. For example, if the call duration is 2 minutes 5 seconds and the billing increment is 30 seconds, the charge for the call will be based on a duration of 2 minutes 30 seconds; 5 seconds is rounded up to 30. The units of currency billed for the call, per minute of billable time. Used in the Rates Profit Report to break down the report by country. If you leave this field blank, it is filled with the region code. An extra charge applied to each successful call regardless of the call duration. A successful call is one with a positive value for the duration.
MinDuration
Billing Increment
Rate Country
ConnectCharge
EffectiveStartDate Determines the date and time when the rate defined in this entry becomes effective. (You must enter the date and time in the format specified for the partition and partition user.) EffectiveEndDate Determines the date and time when the rate defined in this entry is no longer effective. Together, the EffectiveStartDate and EffectiveEndDate fields determine the lifetime of the rate. (You must enter the date and time in the format specified for the partition and partition user.) The period during which the rate defined in this entry is valid. This field is used for time-of-day routing. The period defined in this field must be defined in the Periods table. See Periods table.
Period
Fields in the Supplier Carriers-Rates table

Note: Date and time are displayed in the formats specified for the partition and partition user. Currency formats are displayed using the currency symbol specified for the partition. Refer to Date and time formats and Currency formats for information.
Field Descriptions
Fields Carrier Descriptions Name of the termination carrier.
72
RSM Provisioning
RegionCode ServiceType Priority
Name of the breakout given to a group of dialcodes. The class of service for this carrier. Typically, a companys business policies determine which service types are assigned to which carriers. A value that determines routing priority for this carrier. You can leave the default value or manually specify a value. If you do not specify a priority value, by default RSM computes priority such that the lower the price, the higher the priority. If you set the Set Dial Code Length field in the LCR Configuration section of the System tab, the longer the dial code, the higher the priority. If you do not check this field, RSM does not consider dial code length when it calculates priority. If you want RSM to do priority-based routing instead of rate-based routing, specify a priority in this field. Manually specifying a priority overrides the default priority. The higher the number in this field, the higher the priority. See Importing data into the Rates table for priority-based routing for information on populating the required fields for priority-based routing. The minimum price per minute margin at which the service provider is willing to carry the call. The minimum connection time, in seconds, for which the customer will be billed. For example, if you specify a MinDuration of 30 and the call is 20, the call will still be billed at 30. The time, in seconds, that is used to round up the duration of a call for billing purposes. For example, if the call duration is 2 minutes 5 seconds and the billing increment is 30 seconds, the charge for the call will be based on a duration of 2 minutes 30 seconds; 5 seconds is rounded up to 30. The units of currency billed for the call, per minute of billable time. Used in the Rates Profit Report to break down the report by country. If you leave this field blank, it is filled with the region code. An extra charge applied to each sucessful call regardless of the call duration. A successful call is one with a positive value for the duration. Determines the date and time when the rate defined in this entry becomes effective. (You must enter the date and time in the format specified for the partition and partition user.) Determines the date and time when the rate defined in this entry is no longer effective. Together, the EffectiveStartDate and EffectiveEndDate fields determine the lifetime of the rate. (You must enter the date and time in the format specified for the partition and partition user.) The period during which the rate defined in this entry is valid. This field is used for time-of-day routing. The period defined in this field must be defined in the Periods table.
Profit Threshold MinDuration
Billing Increment
Rate Country ConnectCharge EffectiveStartDate
EffectiveEndDate
Period
Routes table
To import data into the Routes table: 6. Under Rating, select Import. The Import page displays. 7. Select Customer Carriers-Routes or Supplier Carriers-Routes in the drop-down list for the Import Table field. 8. Fill in the rest of the fields on the page.
73
9. Use the link Click Here for Import Format Help on Selected Table to verify the field format for the import file. 10. Click Import. The Routes table will be populated with the fields described in Fields in the Customer CarriersRoutes table and Fields in the Supplier Carriers-Routes table.
Fields in the Customer Carriers-Routes table

Field Carrier ANI Rule Name Description Name of the originating carrier. The name that identifies the ANI manipulation rule as specified in the ANI table. The dialing prefix sent by the customer. This prefix is prepended to phone numbers for calls to the endpoint. This number is also stripped off the phone number before it is matched to the routing tables for rating. For each endpoint/port for the same region code, you can configure multiple entries with different incoming prefixes. OutgoingPrefix The dialing prefix sent to the supplier/egress. This prefix is prepended to the remaining number (after stripping) when the call is sent to the supplier. The outgoing prefix on the customer side must match the incoming prefix on the supplier side. See the figure, below. The number of leading digits that must be removed from the phone number to match the number to the Regions table and rate the call. For example, with dial code 55#01191, if the Rating Strip is set to 6, the number becomes 91 after stripping, which maps to the Regions table entry 91 (India). The actual digits that must be added to a phone number to match the number to the Regions table and rate the call. For example, if the number is 91 and the Rating Addback is 011, the number becomes 01191. Name of the breakout given to a group of dialcodes. The class of service for this carrier. Typically, a companys business policies determine which service types are assigned to which carriers. The name and port number of the endpoint - for example, EP1/0. The information in this field is the same information that appears in the Reg ID field on many RSM screens.
IncomingPrefix
RatingStrip
RatingAddback
RegionCode ServiceType
Endpoint/port
Example of incoming and outgoing prefix
74
RSM Provisioning
Fields in the Supplier Carriers-Routes table

Field Carrier ANI Rule Name Description Name of the terminating carrier. The name that identifies the ANI manipulation rule as specified in the ANI table. The dialing prefix sent by the customer. This prefix is prepended to phone numbers for calls to the endpoint. This number is also stripped off the phone number before it is matched to the routing tables for rating. The Outgoing Prefix on the customer side must match the Incoming Prefix on the supplier side. For each endpoint/port for the same region code, you can configure multiple entries with different incoming prefixes. OutgoingPrefix The outgoing or tech prefix sent to the termination endpoint or supplier. See the figure, below. The number of leading digits that must be removed from the phone number to match the number to the Regions table and rate the call. For example, with dial code 55#01191, if the Rating Strip is set to 6, the number becomes 91 after stripping, which maps to the Regions table entry 91 (India). RatingStrip needs to be specified in the Supplier Routing table only if the ATDEST option was selected in the system configuration for the Dial Code Type. If any other option was selected (FRMSRC, AFTERSRCCP), you can specify the RatingStrip in the Customer Routing table but do not need to specify it in the Supplier Routing table. RatingAddback The actual digits that must be added to a phone number to match the number to the Regions table and rate the call. For example, if the number is 91 and the Rating Addback is 011, the number becomes 01191. Name of the breakout given to a group of dialcodes. The class of service for this carrier. Typically, a companys business
IncomingPrefix
RatingStrip
75
policies determine which service types are assigned to which carriers. Endpoint/port The name and port number of the endpoint - for example, EP1/0. The information in this field is the same information that appears in the Reg ID field on many RSM screens.
Example of incoming and outgoing prefix
Importing data into the Rating table for priority-base routing

When you import rating data, the drop-down list in the Import Table field includes two entries: Customer Carriers-Priorities and Supplier Carriers-Priorities. If you select either of these entries, your import file can include just the fields from the Rating table that are required to set up prioritybased routing for a carrier, instead of all the fields in the Rating table. Specifying a priority for a carrier indicates to RSM that it should do priority-based routing, instead of rate-based routing, for that carrier. RSM cannot do both rate-based and priority routing for a carrier. The values in the Priority field takes precedence over the rates defined in the Rates table for route generation. To import data into the fields of Customer Carriers-Priorities or Supplier Carrier-Priorities: 1. Under Rating, select Import. 2. The Please select a table to import page displays. 3. Select Customer Carriers-Priorities or Supplier Carriers-Priorities in the drop-down list for the Import Table field. 4. Fill in the rest of the fields on the page. 5. Use the link Click Here for Import Format Help on Selected Table to verify the field format for the import file. 6. Click Import. 7. The Rating table will be populated with the following fields.
Field descriptions in the Customer Carriers-Rates table for prioritybased routing

Fields Descriptions
76
RSM Provisioning
Carrier RegionCode ServiceType
Name of the origination carrier. The code that identifies this region. For example, Italy-cell. The class of service for this carrier. Typically, a companys business policies determine which service types are assigned to which carriers. A value that determines routing priority for this carrier. You can leave the default value or manually specify a value. If you do not specify a priority value, by default RSM computes priority such that the lower the price, the higher the priority. If you set the Set Dial Code Length field in the LCR Configuration section of the System tab, the longer the dial code, the higher the priority. If you do not check this field, RSM does not consider dial code length when it calculates priority. If you want RSM to do priority-based routing instead of rate-based routing, specify a priority in this field. Manually specifying a priority overrides the default priority. The higher the number in this field, the higher the priority. See Importing data into the Rating table for priority-base routing for information on populating the required fields for priority-based routing.
Priority
EffectiveStartDate The date and time when the priority defined for this carrier becomes effective. EffectiveEndDate The date and time when the priority defined for this carrier is no longer effective. Period The period during which the priority defined in this row is valid. The period defined in this field must be defined in the Periods table. See Periods table for further details.
Field descriptions in the Supplier Carriers-Rates table for prioritybased routing

Fields Carrier Descriptions Name of the originating customer for a Customer rate or of the terminating customer for a Supplier rate. The code that identifies this region. For example, Italy-cell. The class of service for this carrier. Typically, a companys business policies determine which service types are assigned to which carriers. A value that determines routing priority for this carrier. You can leave the default value or manually specify a value. If you do not specify a priority value, by default RSM computes priority such that the lower the price, the higher the priority.
Priority
77
If you set the Set Dial Code Length field in the LCR Configuration section of the System tab, the longer the dial code, the higher the priority. If you do not check this field, RSM does not consider dial code length when it calculates priority. If you want RSM to do priority-based routing instead of rate-based routing, specify a priority in this field. Manually specifying a priority overrides the default priority. The higher the number in this field, the higher the priority. See Importing data into the Rating table for priority-base routing for information on populating the required fields for priority-based routing. EffectiveStartDate The date and time when the priority defined for this carrier becomes effective. EffectiveEndDate The date and time when the priority defined for this carrier is no longer effective. Period The period during which the priority defined in this row is valid. The period defined in this field must be defined in the Periods table. See Periods table for further details.
Periods table
The Periods table is used for time-of-day rating and routing generation. This table is optional. Use time-of-day routing to define different rates for different times of the day. For example, you might define one rate that is applied from 9:00 a.m. until 5:00 p.m. and another that is applied from 5:00 p.m. to 9:00 a.m. In the Periods table, create and name a period representing a specific span of time. Then, in the Rates table, define the rating information that will be applied to that period of time. To import data into the Periods table: 11. Under Rating, select Import. The Import page displays. 12. Select Periods in the drop-down list for the Import Table field. 13. Fill in the rest of the fields on the page. 14. Use the link Click Here for Import Format Help on Selected Table to verify the field format for the import file. 15. Click Import. The Periods table will be populated with the following fields. Note: Date and time are displayed in the formats specified for the partition and partition user. Currency formats are displayed using the currency symbol specified for the partition. Refer to Date and time formats and Currency formats for information. Field Description
78
RSM Provisioning
Period
A name that identifies the period defined in this entry. There are three predefined periods:

Default period Weekday Weekend
Zone StartWeekDays EndWeekDays StartTime EndTime
The local time zone for the period. The day of the week on which this period starts. The day of the week on which this period ends. The time on which this period starts. The time on which this period ends.
For information on how to set up periods that represent a range of time or individual days, refer to the section Adding a new period.
ANI table
The ANI table is used for ANI manipulation on the MSX side. This table is optional. For more information, refer to the NexTone iServer (MSX) Operations Guide. To import data into the ANI table: 16. Under Rating, select Import. The Import page displays. 17. Select ANI in the drop-down list for the Import Table field. 18. Fill in the rest of the fields on the page. 19. Use the link Click Here for Import Format Help on Selected Table to verify the field format for the import file. 20. Click Import. The ANI table will be populated with the following fields.
Field ANI Rule Name
Description The ANI manipulation rule name. This name is referenced in the Routes table.
79
Calling Party #
The part of the ANI that is used for matching or to strip off digits. Based on the match, the dialing prefix is prepended to the number. A blank calling party number matches everything. The dialing prefix that is prepended to the calling party number after stripping is applied.
Prefix
Setting up data for LCR with profitability

When you import rating data, the drop-down list in the Import Table field includes an entry for LLCR carriers. Selecting this option allows you to quickly set up LCR with profit threshold for carriers. (See Adding partitions for information.) In addition to setting the profit threshold for carriers, you must also enable the LLCR capability for the partition. For information, see Adding partitions. To import data for LLCR Carriers: 1. Under Rating, select Import. 2. The Please select a table to import page displays. 3. Select LLCR Carriers in the drop-down list for the Import Table field. 4. Fill in the rest of the fields on the page. 5. Use the link Click Here for Import Format Help on Selected Table to verify the field format for the import file. 6. Click Import. The following fields will be imported:
Field Carrier
Description Name of the origination carrier for which you are setting a profit threshold. The minimum price per minute margin at which the service provider is willing to carry the call. A positive or zero threshold value defines the minimum margin per minute for a given call. A negative threshold value defines the maximum loss (negative margin) allowed per minute for call termination. Flag that enables LLCR capability for this carrier. See Setting up data for LCR with profitability.
Profit Threshold
LLCR Flag
Definition: Profit Threshold

The profit threshold is the minimum price per minute margin at which the service provider is willing to carry the call. A positive or zero threshold value defines the minimum margin per minute for a given call. A negative threshold value defines the maximum loss (negative margin) 80
RSM Provisioning
allowed per minute for call termination. You can set the threshold at the following levels, from general to specific:

System wide, default 0 On a per carrier basis, default 0 On a per region basis, default 0 On a per route (per region/per carrier) basis, default 0
If RSM cannot find a threshold definition at the most specific level, it uses the threshold from one level above. For example, if a threshold is not defined for the route, then it uses the threshold defined for the region. The profitability threshold specified could be a negative value. The default system-wide profitability threshold is zero, which indicates that all calls with a positive margin will be completed.
Running reports on rating data

RSM provides three reports on rating data: Rates Summary report, Regions Summary report, and the Rates and Routes report.
The Rates Summary report provides rating details by customer or supplier. See Rates Summary report. The Regions Summary report displays dial code grouping information from the Regions table by customer or supplier. See Regions Summary Report The Rates and Routes report provides a summary of information on all carrier endpoints, the routes they serve, and the rates for those routes. See Rates and Routes report.
Rates Summary report

The Rates Summary report provides rating details by customer or supplier. To generate the Rates Summary report: 1. Log onto the system as described in Logging into RSM. 2. Click the Provisioning tab. 3. Click Rates Summary. The Rates Summary page displays. 4. Select a Report, either Rates by Customer or Rates by Supplier. 5. In the Partition field, specify the partition for which you want to display rating data. If you specify just the type of report and the partition, the report will include all rating summary data for that partition. To further refine your selection, fill out either one or both of the following fields. You can enter a partial string in a field, preceded and/or followed by the % sign, to select values using a wild card. Refining your selection for the Rates Summary Report
Carrier field value
Region field value
Result
81
Carrier name
Blank
Displays rating data only for the carrier you specify, regardless of the region it is in. Display rating data for all carriers within the region you specify. Displays rating data for the region and carrier you specify. (Filling out both fields assumes an AND operator - that is, that the criteria in both fields must be satisfied for the carrier name to be included on the report.)
Blank
Region name
Carrier name
Region name
6. Click Show. 7. Use Prev and Next to navigate pages if the report does not fit on one screen.
Field description for the Rates Summary report

Note: Date and time are displayed in the formats specified for the partition and partition user. Currency formats are displayed using the currency symbol specified for the partition. Refer to Date and time formats and Currency formats for information. Field Carrier Description Specifies the carrier for which you want to display rating data.
Region Endpoint
The region to which the carrier belongs. The name of the endpoint for the carrier whose rating data is defined in this entry. The priority of the carrier whose rating data is displayed in this entry. Carriers with a higher priority are displayed first, followed by carriers with a lower priority.
Priority
Rate
The units of currency billed for the call per minute of billable time. The rate can range from 0.0001 to 999.9999. Rounds to four decimal places. The minimum connection time, in seconds, for which the customer will be billed. The time, in seconds, that is used to round up the call duration for billing purposes. For example, if the call duration is 2 minutes 5 seconds and the billing increment is 30 seconds, the charge for the call will be based on a duration of 2 minutes 30 seconds; the 5 seconds is rounded up to 30.
Minimum Duration
Billing Increment
82
RSM Provisioning
Connection Charge
An extra charge applied to each call regardless of the call duration. The date and time when the rate defined in this entry becomes effective. (Date and time are displayed in the format configured for the partition and partition user.) The date and time when the rate defined in this entry is no longer effective. (Date and time are displayed in the format configured for the partition and partition user.) The period during which the rate defined in this entry is valid.
Start Date
End Date
Period
Filters See Filters.
Regions Summary Report

The Regions Summary report displays dial code grouping information from the Regions table by customer or supplier. To generate the Regions Summary report: 1. Click the Provisioning tab. 2. Click Rating, then select Regions Summary. 3. The Regions Summary page displays. 4. Select the Report, either Regions by Customer or Regions by Supplier. 5. In the Partition field, select the partition for which you want to display regions summary data. If you specify just the type of report and the partition, the report will include all regions summary data for that partition. To further refine your selection, fill out either one or both of the following fields.
Refining your selection for the Regions Summary report

Carrier Field Value Region name Region Field Value Result Blank Displays regions summary data for all carriers within the region you specify. Display regions summary data for the carrier you specify, regardless of what region it is in. Displays regions summary data for the region and carrier you specify.
Blank
Carrier name
Region name
Carrier name
6. Use Prev and Next to navigate pages if the report does not fit on one screen.
83
Field for the Regions Summary Report

Field Region Carrier Endpoint Filters See Filters. Description The region to which the carrier belongs. Specifies the carrier for which you want to display rating data. The name of the endpoint for the carrier whose rating data is defined in this row.
Rates and Routes report

The Rates and Routes report provides a summary of information on all carrier endpoints, the routes they serve, and the rates for those routes. The Rates and Routes report also includes a Delete button that allows you to delete rating information for multiple carriers simultaneously. For information on deleting rating information using the Rates and Routes report, refer to Deleting rating information for multiple carriers. To access the Rates and Routes report: 1. Click the Provisioning tab. 2. Click Rating, then select Rating Tables. 3. Click Rates and Routes. The Rates and Routes page displays. 4. In the Partition field, select the partition whose rating and routing data you want to display. If you specify just the partition, the report will include all rates and routes data for that partition. To further refine your selection, fill out one or more of following fields. You can enter a partial string in a field, preceded and/or followed by the % sign, to select values using a wild card. If you specify a value in more than one field, it is assumed that the fields are connected by an AND operatorthat is, the criteria in both fields must be met for the data to be displayed.
Refining your selection for the Rates and Routes report

Region field value Carrier field value Blank Endpoint Result
Region name Blank
Blank
Displays rating and routing data for all carriers and endpoints within the region you specify. Displays rating and routing data for the carrier you specify, regardless of its endpoint or which region it is in. Displays rating and routing data for the endpoint you specify, for all regions and carriers.
Carrier name
Blank
Blank
Blank
Endpoint name
84
RSM Provisioning
Region name Blank
Blank
Endpoint name Endpoint name
Displays rating and routing data for all carriers, for the region and endpoint you specify. Displays rating and routing data for the carrier and endpoint you specify, regardless of which region it is in. Displays rating and routing data for the region, carrier, and endpoint you specify.
Carrier name
Region name 5. Click Show.
Carrier name
Endpoint name
6. Click Prev and Next if the report does not fit on one screen.
Fields descriptions for the Rates and Routes report (customer carriers)
Note: Date and time are displayed in the formats specified for the partition and partition user. Currency formats are displayed using the currency symbol specified for the partition. Refer to Date and time formats and Currency formats for information. Field Partition Description The name of the partition associated with the rating and routing data displayed in this entry. The name of the carrier whose rating and routing data is displayed in this entry. The name of the region to which the carrier belongs. The class of service specified for this carrier. The name of the endpoint associated with this carrier. The port number provisioned for this endpoint in the session controller. The routing priority for this carrier. This value is calculated as follows: - If you did not specify a priority in the Rates table, the routing priority for this carrier is determined based on pricethe lower the price, the higher the priority. - If you set the Set Dial Code Length field in the LCR Configuration section of the System tab, the routing priority for this carrier is determined based on dial code lengththe longer the dial code, the higher the priority. - If you manually specified priority in the Rates table, the routing priority of this carrier is determined by the value in Priority fieldthe higher the number, the higher the priority.
Carrier
Region Service Endpoint Port Priority
85
Rate ANI Incoming Prefix
The units of currency billed for the call, per minute of billable time. Name that identifies the ANI manipulation rule for this carrier. The dialing prefix sent by the customer. This prefix is prepended to phone numbers for calls to the endpoint. This number is also stripped off the phone number before it is matched to the routing tables for rating (see the RatingStrip field, below). For each endpoint/port for the same region code, you can configure multiple entries with different incoming prefixes.
Outgoing Prefix
The dialing prefix sent to the supplier/egress. This prefix is prepended to the remaining number (after stripping) when the call is sent to the supplier (egress). The outgoing prefix on the customer side must match the incoming prefix on the supplier side. The number of leading digits that must be removed from the phone number to match the number to the Regions table and rate the call. For example, with dial code 55#01191, if the Rating Strip is set to 6, the number becomes 91 after stripping, which maps to the Regions table entry 91 (India). The actual digits that must be added to a phone number to match the number to the Regions table and rate the call. For example, if the number is 91 and the Rating Addback is 011, the number becomes 01191. The minimum connection time, in seconds, for which the customer is billed. The time, in seconds, that is used to round up the call duration. For example, if the call duration is 2 minutes 5 seconds and the billing increment is 30 seconds, the charge for the call will be based on a duration of 2 minutes 30 seconds; the 5 seconds is rounded up to 30. Breaks down the rates and routes report by country. An extra charge that applies to each call regardless of the call duration.
Rating Strip
Rating Addback
Minimum Duration
Billing Increment
Country Connection Charge Effective Date
The date and time on which the rate in this entry takes effect. (Date and time are displayed in the format configured for the partition and partition user.) The period during which the rate defined in this entry is valid.
Period
Fields descriptions for the Rates and Routes report (supplier carriers)
86
RSM Provisioning
Note: Date and time are displayed in the formats specified for the partition and partition user. Currency formats are displayed using the currency symbol specified for the partition. Refer to Date and time formats and Currency formats for information. Field Partition Description The name of the partition associated with the rating and routing data displayed in this entry. The name of the carrier whose rating and routing data is displayed in this entry. The name of the region to which the carrier belongs. The class of service specified for this carrier. The name of the endpoint associated with this carrier. The port number provisioned for this endpoint in the session controller. The routing priority for this carrier. This value is calculated as follows: If you did not specify a priority in the Rates table, the routing priority for this carrier is determined based on pricethe lower the price, the higher the priority. If you set the Set Dial Code Length field in the LCR Configuration section of the System tab, the routing priority for this carrier is determined based on dial code lengththe longer the dial code, the higher the priority. If you manually specified priority in the Rates table, the routing priority of this carrier is determined by the value in Priority fieldthe higher the number, the higher the priority. Rate ANI Incoming Prefix The units of currency billed for the call, per minute of billable time. Name that identifies the ANI manipulation rule for this carrier. The dialing prefix sent by the customer. This prefix is prepended to phone numbers for calls to the endpoint. This number is also stripped off the phone number before it is matched to the routing tables for rating (see the RatingStrip field, below). The Outgoing Prefix on the customer side must match the Incoming Prefix on the supplier side. For each endpoint/port for a carrier for the same region code, you can configure multiple entries with different incoming prefixes. Outgoing Prefix Rating Strip The outgoing or tech prefix sent to the termination endpoint or supplier. The number of leading digits that must be removed from the phone number to match the number to the Regions table and rate the call. For
Carrier
Region Service Endpoint Port Priority
87
example, with dial code 55#01191, if the Rating Strip is set to 6, the number becomes 91 after stripping, which maps to the Regions table entry 91 (India). Rating Addback The actual digits that must be added to a phone number to match the number to the Regions table and rate the call. For example, if the number is 91 and the Rating Addback is 011, the number becomes 01191. The minimum connection time, in seconds, for which the customer is billed. The time, in seconds, that is used to round up the call duration. For example, if the call duration is 2 minutes 5 seconds and the billing increment is 30 seconds, the charge for the call will be based on a duration of 2 minutes 30 seconds; the 5 seconds is rounded up to 30. Breaks down the rates and routes report by country. An extra charge that applies to each successful call regardless of the call duration. A successful call is one with a positive value for duration. The date and time on which the rate in this entry takes effect. (Date and time are displayed in the format configured for the partition and partition user.) The period during which the rate defined in this entry is valid.
Minimum Duration
Billing Increment
Country Connection Charge Effective Date
Period Filters See Filters.
Manually adding, modifying, and deleting rating and routing data

Typically, companies populate rating and routing tables by importing data from a set of master files, as described in Importing rating and routing data. This is the recommended method for bringing rating and routing data into the RSM system. RSM provides you with a method for manually editing data in the rating and routing tables if you need to make quick changes to a small number of records. It is strongly recommended, however, that you keep your master files in sync with the data stored in RSM. If you make manual changes directly to the data in the RSM database without making the same changes to your master files, you run the risk of losing your rating and routing data if the server that stores the RSM database fails for any reason. This section describes how to manually add, modify, and delete rating and routing data using the Rating Tables command on the Provisioning menu. You can edit the following types of rating and routing data:

Periods Routes Automatic Number Identification (ANI) Prefix (see Periods
88
RSM Provisioning

Routes) Rates Carriers Regions Periods
Routes
Use the procedures in this section to display existing routes, and to create, modify and delete routes. This section also describes how to add an ANI prefix. For detailed information on the fields displayed on the Routes page, refer to Fields in the Customer Carriers-Routes table and Fields in the Supplier Carriers-Routes table. Displaying routes To display routes: 1. Click the Provisioning tab. 2. Click Rating Tables, then click Routes. The Routes page displays. 3. Select a Partition from the drop-down list. 4. To further refine your selection, enter a combination of carrier, region, and endpoint in the Carrier, Region, and Endpoint fields. 5. Click Show. The Routes page displays route details based on your selection criteria. 6. Use Prev and Next to navigate pages if the report does not fit on one screen. For information on filters, refer to Filters. Adding a New Route To add a new route: 1. Click the Provisioning tab. 2. Click Rating Tables, then click Routes. The Routes page displays. 3. Click Add. The Add Route page displays. 4. Select a partition from the Partition list. 5. Select a carrier from the Carrier list. 6. Specify a region code in the Region Code field. 7. Specify the service type in the Service field. The service type specifies the class of service for this carrier. See Rates Table (Customer/Supplier) for additional details. 8. Enter Endpoint details (device, endpoints and ANI). 9. Enter Routing Information. See Routes table for information on incoming prefix and outgoing
89
prefix. 10. Click the Use for Rating field if you want RSM to automatically populate the Strip Digits field with the number of digits you specify in the Outgoing Prefix field. For example, if you enter 123 in the Outgoing Prefix field, the Strip Digits field is automatically populated with a value of 3. (It is the number of digits you enter that is important, not the actual digits themselves. If you enter 456 in the Outgoing Prefix field, the Strip Digits field is still populated with a value of 3.) If you enter a value directly into the Strip Digits field, RSM ignores the Use for Rating field and uses the Strip Digits field value instead. 11. Enter Rating Information. For details on Strip Digits and Addback String, refer to the Routes table. 12. Once you have set all parameters, click Submit to save your work. 13. Click Back to return to the Routes page. Updating a Route To update a route: 1. From the Routes page, click the Route you want to update. The Update Route page displays. 2. Make all necessary updates, then click Submit. A message similar to the one below displays: Route xxxx is updated Deleting a Route To delete a route: 1. Click the trash can icon to the left of the Route name. A dialog box displays confirming that you want to delete the route. 2. Click OK to delete the route. 3. A message similar to the one below displays: 4. Route xxxx is deleted from the database 5. Click Cancel to exit the dialog box without deleting the route. Automatic Number Identification (ANI) prefix RSM does not provide a separate interface to the ANI table; instead, it is embedded in the Routes table. For detailed information on the fields in the ANI table, refer to the ANI table. To add a new ANI Prefix: 1. From the Routes content area, under ANI click the appropriate ANI link. 2. The ANI dialog displays. 3. Click Add. The Add ANI Prefix dialog displays. 4. Enter the ANI name. 5. Enter the Call Number.
90
RSM Provisioning
6. Enter the Prefix. 7. Click Submit to save your entries. A message similar to one below displays: ANI of nnnn is added to the database
Rates
Use the procedures in this section to display existing rate information and to create, modify and delete rates. For detailed information on the fields in the Rates table, refer to Rates Table (Customer/Supplier). Displaying rates To display rates: 1. Click the Provisioning tab. 2. Click Rating Tables, then click Rates. The Rates page displays. 3. Select a Partition from the drop-down list. 4. To further refine your selection, specify either carrier, region, or both in the Carrier and Region fields. 5. Click Show. The Rates page displays details based on your selection criteria. 6. Use Prev and Next to navigate pages if the report does not fit on one screen. 7. For information on filters, see Filters. Adding a new rate To add a new rate: 1. Click the Provisioning tab. 2. Click Rating Tables, then click Rates. The Rates page displays. 3. To open the Add Rate page, click Add. The Add Rate page displays. 4. Select a carrier Type: Customer or Supplier. 5. Select a Partition for this rate. The drop-down list displays the available partitions. 6. Select a Carrier for this rate. The drop-down list displays the available carriers. 7. Enter a Service. The service is the service type, or class of service for this carrier. 8. Enter Rate details. Refer to the Rates Table (Customer/Supplier) for details on these fields. A couple of tips: To enter dates, click the calendar icon to the right of the date field, then click a date. You can also specify a time for each date. 9. Once all parameters are set, save your work by clicking Submit.
91
Updating an existing rate To update an existing rate: 1. From the Rates page, click the Rate you want to update. 2. The Update Rate page displays. 3. Update the fields under Rate details. You cannot update fields in the Carrier Info. section. When you finish, click Submit to save your work, or click Back to leave the page without saving your work. A message similar to the one below displays: Rate xxxx is updated Deleting an existing rate To delete an existing rate: 1. Click the trash can icon next to the rate to be deleted. A confirmation dialog box displays. 2. Click OK to delete the rate, or Cancel to exit the dialog box without deleting the rate. A message similar to the one below displays: Rate xxxx is deleted from the database
Carriers
Use these procedures to display information on Least Cost Routing (LCR) with profit thresholds for a carrier. For detailed information on these fields, refer to Setting up data for LCR with profitability.
Displaying LCR with profitability information

1. Click the Provisioning tab. 2. Click Rating Tables, then click Carriers. The Carriers page displays. 3. Select a Partition. 4. Enter a Carrier. 5. Click Show. The system displays details on the carrier you select. For information on filters, see Filters. Adding LCR with profitability for a carrier 1. Click the Provisioning tab. 2. Click Rating Tables, then click Carriers. The Carriers page displays. 3. Click Add. The Add Carrier page displays. 4. Use the drop-down list to select a carrier. 5. Select a Partition from the drop-down list. For RSM to use the profit threshold, LLCR must
92
RSM Provisioning
be enabled for the partition and for the carrier. See Adding partitions for information on enabling LLCR for the partition. 6. In the Profit Threshold field, enter the decimal value you want to use for the profit threshold. For more information, see LCR with profit thresholds. 7. Click the Enable LLCR field to enable LLCR (lossless LCR or LCR with profitability) for this carrier. 8. When you have completed your entries, click Submit. 9. To go back to the previous page, click Back.
Regions
Use these procedures to display information on existing regions, and to create, modify, and delete regions. For detailed information on the fields in the Regions table, refer to Regions table. Displaying regions To display regions: 1. Click the Provisioning tab. 2. Click Rating Tables, then click Regions. The Regions page displays. 3. Select a Partition. 4. Enter a Region Code. 5. Enter a Dial Code. If you do not know the dial code for a region, under the Region Codes column, click the region for which you want a dial code. The dial code is displayed in the Dial Codes column. 6. Click Show. 7. The system displays details on the region. 8. For information on filters, see Filters. Adding a new region To add a new region: 1. Click the Provisioning tab. 2. Click Rating Tables, then click Regions. The Regions page displays. 3. Click Add. The Add Region page displays. 4. Enter a name for the new Region Code you are creating. The code name is limited to 32 characters. By convention, region codes are all upper-case characters, with no embedded spaces. Hyphens or underscores can be used to separate words. 5. Select a Partition from the drop-down list.
93
6. Provide a brief text Description (up to 64 characters). 7. Enter a dial code in the Enter Dial Code box. Enter one or more dial codes for the rating function to match for this carrier. RSM allows you to save the new region code without dial codes, but if you do that, the rating function will never match to a CDR, so be sure to supply at least one dial code. Separate multiple dial codes with a carriage return. 8. Click Add. The dial code appears in the Dial Codes box. 9. To update a dial code, click a dial code in the Dial Codes box. The dial code appears in the Enter Dial Codes field. Edit the code, then click Update. 10. To delete a dial code, click the dial code you want to delete in the Dial Codes box, then click Delete. 11. When you have completed your entries, click Submit, or click Close to leave the dialog box without creating a region. 12. A message similar to the one below displays: Region xxxx is added to the database 13. To go back to the previous page, click Back. Updating a region To update a region: 1. From the Regions page, click the region to be updated. 2. Click Update. The Update Region page displays. 3. Update the information on this page, then click Submit. 4. A message similar to the one below displays: Region xxxx is updated Deleting an existing region To delete a region: 1. From the Regions page, click the check box next to the region you want to remove. 2. Click Delete. A confirmation dialog displays. 3. Click OK to delete the region. 4. A message similar to the one below displays: Region xxxx is deleted from the database The region you deleted no longer shows in the list.
Periods
Use these procedures to display information on existing periods, and to create, modify and delete periods. For detailed information on the fields in the Periods table, refer to Periods Table.
94
RSM Provisioning
Displaying periods To display periods: 1. Click the Provisioning tab. 2. Click Rating Tables, then click Periods. The Periods page displays. 3. Select a Partition. 4. Enter a Period. 5. Click Show. The system displays details on the particular period. For information on filters, see Filters. Adding a new period To add a new period: 1. Click the Provisioning tab. 2. Click Rating Tables, then click Periods. The Periods page displays. 3. Click Add. The Add Period page displays. 4. Enter a name for the new period you are creating. For example, if the period of time is from 9 a.m. to 5 p.m., you might name the period Peak 9-5. 5. Select a Partition from the drop-down list. 6. In the Time Zone field, select a time zone from the drop-down list. 7. In the Start Week Days field, check the day of the week on which this period starts. 8. In the End Week Days field, check the day of the week on which this period ends. 9. In the Start Time field, specify the time on which this period starts. Click the drop-down list to the right of the hours, minutes, and seconds fields to select the time. 10. In the End Time field, specify the time on which this period ends, using the same procedure as for the Start Time. When you have completed your entries, click Submit (or click Close to leave the dialog box without creating a period). A message similar to the one below displays:
Region xxxx is added to the database
To go back to the previous page, click Back. Depending on the combination of entries in the Start Week Days and Start Time fields and the End Week Days and End Time fields, you can define a period that represents a range of time or specific days. If you select one day and a start time in the Start Week Days and Start Time fields and one day and an end time in the End Week Days and End Time fields, the period represents a range. For example, if you select:
95
Start Week Days = Monday End Week Days = Friday Start Time = 6:00 a.m. End Time = 6:00 p.m. this period starts at 6:00 a.m. Monday and ends at 6:00 p.m. Friday. You can also define a period that includes specific days. For example: Start Week Days = Monday, Tuesday, and Friday End Week Days = Monday, Tuesday, and Friday Start time = 6:00 a.m End time = 6:00 p.m The valid time interval for this period is: Start at 6:00 a.m. Monday, end at 6:00 p.m. Monday Start at 6:00 a.m. Tuesday, end at 6:00 p.m. Tuesday Start at 6:00 a.m. Friday, end at 6:00 p.m. Friday Updating a period To update a period: 1. From the Periods page, click the period to be updated. 2. Click Update. The Update Period page displays. 3. Update the information on this page. You cannot update the Created and Last Modified information. 4. Click Submit. A message similar to the one below displays:
Period xxxx is updated
Deleting a Period To delete a period: 1. From the Periods page, click the check box next to the period you want to remove. 2. Click Delete. A confirmation dialog displays. 3. Click OK to delete the period. A message similar to the one below displays: Period xxxx is deleted from the database
96
RSM Provisioning
Deleting rating information for multiple carriers

The Rates and Routes report allows you to delete rating information for multiple carriers simultaneously. To delete rating information: 1. Click the Provisioning tab. 2. Click Rating. 3. Click Rating Tables, then click Rates and Routes. The Rates and Routes page displays. 4. Follow the procedures in the section Rates and Routes Report to display report data.
5. Select the carriers whose rating data you want to delete by clicking the check box to the left of the carrier name. 6. Click Delete. A confirmation message displays. Note: When you click Delete, just the entries on the displayed page are deleted.
Maintaining rating and routing data

The Utility option on the Provisioning tab provides you with the tools you need to maintain rating and routing data in the RSM database. Maintaining data involves the following tasks:

Validating imported data Rerating CDRs Running the Trace Rate utility Validating imported data
Rerating CDRs
When a CDR is received in RSM, it is automatically rated, provided that automatic rating is enabled in the system configuration and rating data is defined. At some point, it may be necessary to rerate CDRs. This situation might occur, for example, if rating data was not well defined when it was originally imported. The Rerate utility in RSM allows you to perform this task. Typically, companies do not run the Rerate utility on all CDRs in the database, since processing time for the Rerate utility is very long. The fields on the Rerate page act as filters to select only a specific set of CDRs to be rerated. To select CDRs and run rerating: 1. From the Provisioning tab, click Utilities. 2. Click Rerate. 3. Fill out the fields on the Rerate utility page to determine which CDRs RSM selects for rerating. 4. When you are finished, click Submit to begin the rerating process.
97
Field Begin Date
Description Determines the begin date for the CDRs to be rerated. Enter a date or select it by clicking the Calendar icon. This field is required. (You must enter the date and time in the format specified for the partition user. See Date and time formats.) Determines the end date for the CDRs to be rerated. Enter the date or select it by clicking the Calendar icon. This field is required. (You must enter the date and time in the format specified for the partition user.) RSM selects only those CDRs for re-rating whose begin and end dates fall within the dates you specify.
End Date
Time Zone
Determines the specific time zone that applies to the begin and end dates. Determines the partition to which the CDRs to be rerated must belong. Use the drop-down list to select a partition. RSM will re-rate only those CDRs that belong to the partition you specify. The name or identifier of an endpoint. Use this field to limit the rerating to only the CDRs for the endpoint you specify. If you do not specify an endpoint, RSM rerates CDRs that fall within the other criteria you specify, regardless of endpoint. The port for the endpoint. Use this field to further limit the rerating to a specific endpoint and port; RSM rerates only those CDRs for the endpoint and port you specify. Limits the CDRs to be rerated to only those CDRs that belong to the origination endpoint you specify. Limits the CDRs to be rerated to only those CDRs that belong to the termination endpoint you specify. Repairs the user authentication bit for the CDRs you specify. This field allows you to run the Rerate utility to update the user authentication bit without rerating CDRs. If you check this field, RSM only repairs the user authentication bit and does not rate CDRs. If you clear this field, RSM rerates CDRs and also repairs the user authentication bit. Refer to "Updating the user authentication bit.". Determines whether the Rerate utility rerates both rated and unrated CDRs. If you leave this box unchecked, all CDRs that meet the criteria are rerated. If you check this box, the Rerate utility rerates only those CDRs that meet the criteria and whose flag field indicates that they are unrated.
Partition
Endpoint Reg ID
Port
Orig endpoint
Term endpoint
Update user authentication bit only
Rate unrated CDRs only
Updating the user authentication bit When RSM receives a CDR, it rates it. At the same time, it determines which partition the CDR belongs in based on the user authentication process. This process uses the USERAUTH field
98
RSM Provisioning
(bit) in the CDR table to identify the partition to which the CDR belongs. A USERAUTH field with a value of 2, for example, indicates to RSM that the CDR belongs to Partition 2. Note: If no other partitions are defined, RSM puts the CDR into the Admin partition. Suppose an endpoint that was previously in Partition 2 is moved to Partition 1. New CDRs will now go to Partition 1 for that endpoint; existing CDRs will still be in Partition 2. Although users in Partition 1 will see new CDRs, they will not be able to see existing CDRs that are in Partition 2. Selecting the Update user authentication bit only option will update the USERAUTH field for all existing CDRs, allowing Partition 1 users to access them. To update the user authentication bit: 1. From the Provisioning tab, click Utilities. 2. Click Rerate. 3. Check the Update user authentication bit only field. 4. Fill out the fields on the Rerate utility page to determine which CDRs RSM selects for update. 5. Click Submit to begin the update process.
Running the Trace Rate utility

The Trace Rate utility simulates the rating process for the CDRs that meet the criteria you specify and displays detailed rating information. You can use this information for troubleshooting purposes to determine why RSM is not rating certain CDRs. To run the Trace Rate utility: 1. From the Provisioning tab, click Utilities. 2. Click Trace Rate. 3. Fill out the fields on the Trace Rate utility page to select the CDRs for which you want to run the simulation. The fields on this page correspond to the fields in the CDR. (Click Clear to clear all fields on the page.)
4. Click Show to run the utility using the data you specify. For information on filters, see Filters.
Fields on the Trace Rate utility page

Field Orig Realm Orig Gateway Description The name of the origination realm. The name of the origination gateway or endpoint reg ID.
Orig IP
The origination IP address. You can specify either the Orig Gateway or the Orig IP; it is not necessary to specify both.
99
Orig Port Term Realm Term Gateway
The origination port. The name of the termination realm. The name of the termination gateway or endpoint reg ID.
Term IP
The termination IP address. You can specify either the Term Gateway or the Term IP; it is not necessary to specify both.
Term Port Dialed Number
The termination port. The field in the CDR that establishes the dialed number used in the rating process.
Call Duration Call Time Show Raw Information
The duration of the call in seconds. The time at the start of the call. Determines whether additional information on CDR rating is displayed. If you check this option, Trace Rate displays additional CDR rating information for debugging purposes.
After you select CDRs to be included in the rating simulation and click Show, rating data is displayed in the table in the lower half of the Trace Rate utility page, as described below. For each column, both origination and termination rating data is displayed.
Columns on the Trace Rate report

Column Manipulated Dialed Description The number after the rating strip and rating addback is applied that is used to match the dialcode in the Regions table.
Carrier Region Service Country
Identifies the carrier. Identifies the region. Identifies the type of service. Identifies the country.
100
RSM Provisioning
Rate Price Connection Charge
Identifies the charged rate. Identifies the charged price. Shows the fixed charge that is added to the price of the call for every billable call. The total seconds used to compute the charge price. This value is computed from the call duration, the minimum duration, and the billing increment. Displays the value of the USERAUTH field in the CDR table.
Rounded Seconds
User Auth
Status
Shows the status of the rating resultsthat is, whether the rating was successful. The following statuses are displayed: 1 = unsuccessful 2 = successful 3 = do not rate Provides a problem description in the event that the rerating process was unsuccessful.
Status Description
Validating imported data

The Check Data utility validates imported rating data. It can check for two categories of data: errors and warnings. Errors must be fixed or rating and routing will not work. Warnings may allow rating and routing to work, but the correct result is not guaranteed. Important: When data is imported into the database, RSM does not perform extensive data validation. For this reason, it is very important that you run the Check Data utility on a regular basis to ensure the integrity of your data. To run the Check Data utility: 1. From the Provisioning tab, click Utilities. 2. Click Check Data. 3. Fill out the fields on the Check Data utility page. 4. Click Show to run the utility. For information on filters, see Filters.
Fields on the Check Data utility page

Field Type of Description
101
error/warning Partition The partition for which you want data to be checked. Use the drop-down list to select the partition you want to use. Determines whether the Check Data utility checks data for errors. Data with errors must be fixed or the rating and routing process will not work. When you click this box, all the checkboxes within this category are automatically selected. Click in a checkbox again to deselect it. Inconsistent Outgoing prefix Missing ANIs Checks data for prefixes that are not the same for the carrier, region, service type, and endpoint/port. Checks data for ANIs that are used by routes but are not defined in the ANI table. Checks data for endpoints that are used by routes but are not defined in the Endpoint table. Checks data for periods that are used by rates but are not defined in the Periods table. Checks data for regions that are used by rates and/or routes but are not defined in the Regions table. Determines whether the Check Data utility checks data for warnings. The rating and routing process will still run on data with warnings, but results may not be accurate. When you click this box, all the checkboxes in this category are automatically selected. Click in a checkbox again to deselect it. Duplicate dial codes Checks data for duplicate dial codes - the same dial code defined for multiple regions. Checks data for duplicate endpoints - the same endpoint defined for multiple carriers. Checks data for expired rates - rates that are expired and are no longer used for route generation. Although expired rates do not typically cause a problem, they use up system resources. Checks for data with rates that do not have corresponding routes. Checks for data with routes that do not have corresponding rates.
Errors
Errors
Errors
Errors
Missing endpoints
Errors
Missing periods
Errors
Missing regions
Warnings
Warnings
Warnings
Duplicate end points Expired rates
Warnings
Warnings
Rates without Routes Routes without Rates
Warnings
102
RSM Provisioning
Generating and uploading routes

The Routing option in the Provisioning menu provides you with the tools you need to generate routes and upload them to MSX, as described in the following sections:

Working with Least Cost Routing Setting up data for LCR with profitability Displaying the Most Profitable Route report
Working with Least Cost Routing

Least Cost Routing (LCR) in RSM controls how calls are routed in MSX. With LCR, the call in MSX is routed to the carrier with the lowest cost. The lowest cost carrier is determined from the rating data imported into RSM. LCR is based solely on the termination (Buy) rate; the origination (Sell) rate is not taken into consideration. Note: If you select the Set Dial Code Length option in the LCR Configuration section of the System tab, the call in MSX is routed based on the longest dial code length first, then rates are compared. If you do not check this option, the call is routed based on cost. If you are doing priority-based routing, the dial code length is not used. The LCR option on the Routing menu provides you with the tools to display and generate Least Cost Routes, and upload Least Cost Routes to MSX. You can perform the following tasks:

Displaying and generating Least Cost Routes Manually updating the LCR priority Updating MSX with Least Cost Routes
To access the LCR feature:

Click the Provisioning tab. Click Routing, then click LCR. The LCR page displays.
Displaying and generating Least Cost Routes

Note: Even if you are doing priority-based routing, you still need to follow the procedures in this section to generate Least Cost Routes and update MSX with the new LCR information. To display and generate Least Cost Routes: 1. In the Partition field, select the partition in which you want the LCR update to be performed. If you logged in as an Admin user, the list includes all configured partitions plus the Admin partition. 2. If you select any partition other than the Admin partition, the LCR update will be performed on only one iServer. 3. If you select the Admin partition, select which iServer cluster will be updated. 4. In the Regions field, enter the region for which you want to update LCR data.
103
5. In the Carriers field, enter the carrier for which you want to update LCR data. 6. Click Show. RSM generates LCR data from the data in the rating tables using the criteria you specify and displays the LCR report. 7. Use Prev and Next to navigate pages if the report does not fit on one screen.
Fields on the LCR page

Field Partition Description The name of the partition whose LCR data you want to generate and update in MSX. The MSX iServers for which the LCR data will be updated when you click the Update Device option. This field is available only if you log in as an Admin user and select the Admin partition. The Region for which you want to update Least Cost Routes. A list of carriers that supply the route to the region, in ascending order of cost. The information in the Carrier field is formatted as follows: <carrier name>(<rate)><period> Note: An expired carrier rate is displayed in a red font. Send All Routes Determines whether data for all routes is generated. When this box is checked, MSX first deletes existing routes, then generates all routes from rating table data. If this box is not checked, MSX updates only those routes whose LCR data has changed since the last time the server was updated. Note: Processing time with this option can be long. Use Sticky Routes Marks the most expensive route (or the route with the lowest priority) as a sticky route for each entry. Once a sticky route is encountered during call routing, the call either completes with that route, or the call is rejected. Sticky routing forces call hunting to stop at a point before reaching the end of all routes that could potentially route a particular call. You have these options: One for all periods
iServers
Regions Carriers
One for each period
Manually updating the LCR priority

Although priority is automatically updated, RSM provides you the option of manually updating it. To update the LCR Priority assigned to a carrier:
104
RSM Provisioning
1. From the Regions column, click the region you want to update. 2. The Update LCR Priority dialog displays: 3. To change the priority, move the region name up or down.
4. To add a new priority, enter the new priority and click OK. 5. In the Update LCR Priority page, click Submit to save your changes. 6. To close the Priority page, click Close.
Updating MSX with Least Cost Routes

After you view the generated LCR data and verify it, the next step in managing LCR data is to update MSX with the new data. To update a device, follow these steps: 1. Make sure that you are on the page where you can view LCR specific details. 2. Click Update Device. 3. Click OK to accept the updates, or click Cancel if you do not wish to save the updates.
Implementing LCR with profit thresholds

RSM and MSX provide least cost routing (LCR) that incorporates profit thresholds based on RSM's calculations and priority generation. For information, see Setting up data for LCR with profitability.
LCR with profit thresholds

Service providers often want to establish termination routing in least cost order to maximize their margin for a given call. They also want to be able to limit the difference between the amount they receive and the amount they pay for a specific call. This difference may be limited to zero (carry no call at a loss) or may be a positive or negative value. To accommodate these needs, RSM and MSX provide least cost routing (LCR) that incorporates profit thresholds based on RSM's calculations and priority generation. The service provider can define positive, no profit, and negative profit thresholds on a global basis, per carrier, per region, or per route. With LCR without profit thresholds, RSM generates least cost routes such that the cheapest carrier gets the highest priority, if all carriers can handle the same dial code length. Priority is then taken into consideration by MSX during call hunting attempts. MSX will make sure calls are terminated with the carrier that has the highest egress route priority, thus the cheapest price. Although this may be an acceptable solution for some networks, it has a drawback. Since MSX is not considering the ingress carrier at the time of selecting the destination, even though MSX chooses the cheapest route, the carrier could still lose money if the ingress price was higher. For LCR with profit thresholds, ingress carriers are taken into account. RSM computes the ingress route priority with the carrier rate and customer expected profit threshold. Based on the origination-termination pair selected during the call hunting process, RSM checks the appropriate profit threshold. If the call does not meet that threshold, it will fail to complete at that termination. To illustrate this, consider the example below. The Customer (Ingress) column lists ingress carriers and their associated rates. The Supplier (Egress) column lists supplier carriers and their associated rates. Suppose Carrier A is chosen at ingress using MSX source port selection and other ingress call routing mechanisms. The profit threshold is set to .05. In this case, Carrier D would be chosen at egress, to meet a profit threshold of five or higher.
105
Customer (Ingress) Carrier A B C Rate ($/min) 0.10 0.04 0.02
Supplier (Egress) Carrier D E F Rate ($/min) 0.05 0.08 0.10
Important: RSM automatically generates the egress route priority , which is used in least cost routing to assign carrier priority. You can manually specify a route priority in RSM Console that overrides the system-generated priority in RSM. You should be aware that if you manually specify a priority, it is possible that LCR with profit threshold will not function correctly.
Implementing LCR with profit threshold

LCR with profitability threshold is a licensed feature. The license is LLCR, which stands for Lossless LCR. If the license is not enabled, the profit threshold is set to zero. If the license is enabled, RSM uses LCR with profitability threshold only if the following conditions are met:

LCR with profitability threshold is turned on for the partition. The profitability threshold field is set for the carrier.
The default behavior is to not use LCR with profitability threshold even if the LLCR license is present and LCR with profitability threshold is turned on for the partition. You must still enable the profitability threshold at the carrier level. For more information on implementing LCR with profit threshold, refer to:
Setting up data for LCR with profitability
Displaying the Most Profitable Route report

With Least Cost Routing, cost is the only factor that RSM considers when it routes a call. However, the least cost route may not be the most profitable. The Most Profitable Route (MPR) report helps you track which routes provide the greatest profit margin. For the regions and carriers you select, the report displays the most profitable customer routes in order from most profitable to least profitable. To display the MPR report: 1. Click the Provisioning tab. 2. Click Routing, then click MPR. The MPR page displays. 3. In the Partition field, select the partition that contains the MPR data you want to include in the report. If you logged in as an Admin user, the list includes all configured partitions, plus the Admin partition. 4. If you select any partition other than the Admin partition, the MPR report will show the routes only for one iServer.
106
RSM Provisioning
5. If you select the Admin partition, select the iServer cluster whose routes will be included in the report. 6. In the Regions field, enter the region whose MPR data you want to include in the report.
7. In the Carriers field, enter the carrier whose MPR data you want to include in the report. 8. Click Show. RSM generates MPR data from the data in the rating tables using the criteria you specify and displays the MPR report. 9. Click Prev and Next if the report does not fit on one screen.
Fields on the MPR page

Field Regions Description The region configuration from the rating tables. For each region, carriers are listed in ascending order of the rate. A list of carriers that supply the route to the region, in ascending order of the cost. This information is computed from carrier plans table. The information in the Carrier field is formatted as follows: <carrier name>(<rate)><period>. Note: An expired carrier rate is displayed in red font.
Carriers
107
Launching RSM Console

Launch RSM Console
The RSM Console provides quick access to multiple iServers, allowing you to coordinate operations across multiple iServers without leaving the RSM environment. Using RSM Console, you can perform many of the functions you can do in stand-alone RSM, including the following:

Configuring iServer system parameters, including Call Admission Control (CAC). Updating the database. Only the RSM and iServer databases are supported. Importing and exporting databases to and from iServer.
The RSM Console is launched by clicking on the RSM Console link at the top of the window or by clicking on the RSM Console link under the Provisioning tab. To launch RSM Console: 10. Click Provisioning>Launch RSM Console or the RSM Console link.
109
RSM System
Working with the RSM system
Use the System tab to perform system administration for RSM. System administration includes the following tasks:
ConfigurationConfigure RSM server parameters to fine-tune performance and define application properties such as mail configuration and table partition size. LoggingDebug and troubleshoot RSM software modules (Reports, database synchronization, Archiver, and so on). StatusAnalyze and debug system performance. LicenseView and update the license. BrandingUpdate the web interface DevicesConfigure iServer system information within the RSM system. Overview of PartitioningConfigure partitions within the RSM system and manage user accounts. Audit TrailTracks operations performed on the RSM system. Managing RSM Archiver servicesSet up jobs for archiving and backing up CDR and provisioning data. Importing and exporting Call Data RecordsDefine CDR streams for importing and exporting Call Detail Records. CDR ErrorsExplains how to manage CDRs with invalid data. About SynchronizationSynchronize database data between RSM and MSX. Adding system alarmsCreate alarms that monitor the RSM system.
Configuration
The Configuration page is used for configuring RSM application parameters to fine-tune application performance. It is also used to configure application properties, such as e-mail and logging configuration and enabling/disabling rating.
Accessing Configuration
To access the Configuration page, do the following: 1. Click System>Configuration. 2. The Configuration page displays. NOTE: The main objective of the Rater is to determine the buying cost and the selling price of the call in each CDR. 3. Make any necessary changes, click the Submit button.
111
Field Descriptions
Field Rater Configuration Enable Rating Table partition size (hrs) Allows you to select whether to rate the call. The duration of CDR data that each CDR table will contain, in hours. The default is 24 hours. Calls with a duration greater than or equal to this integer value will have their disconnect field set to N (normal). Coding a 0 (zero) here disables this function. Calls with a duration less than or equal to this integer value will have their disconnect field set to E (error). Coding a -1 (minus one) here disables this function. One or more sequences of dial-string numbers used to match phone numbers in a CDR. This field sets the dialed number field that is used in the rating process. This field has a drop-down list of dial code types. Description
Normal call duration
Error call duration
Dial Code Type
CDRs contain three different dialed number fields, as follows: 1. FRMSRC - The number as dialed by the originator 2. AFTERSRCCP - The number after applying the source calling plan 3. ATDEST (the default) - The number as dialed to the terminator
These three numbers could be different, depending on the number of manipulations set up by the user. The number selected for rating matches what is entered in the RSMRegions table. Rerater Configuration Rerate Automatically This controls if there is any automatic re-rating of unrated entries in the table. The default is FALSE. The number of Rerater instances to use when re-rating tables.
Rerater Instances Reports Configuration Default page length
The number of records displayed on a default page unless the user specifies otherwise. The user cannot specify a page length longer than this number.
Max page length
112
RSM System
Default high threshold color This field is used to specify the color to be used to mark the rows with high threshold, as configured in User properties. For example, #66CC66. Default medium threshold color This field is used to specify the color to be used to mark the rows with medium threshold, as configured in User properties. For example, #FF9933.
Default low threshold color This field is used to specify the color to be used to mark the rows with low threshold, as configured in User properties. For example, #FF6633. Session Configuration Session Timeout (in min) This is used to configure the session timeout in case of inactivity on the RSM Console. The user session times out after the specifed time in case of inactivity.
Email Configuration Smtp Server Pop Server Email User Email Password Email From Identifies the SMTP Server. Identifies the POP Server. Identifies the email user. Identifies the email password. Identifies the email address of the email sender. NOTE: These e-mail settings are used by the RSM to send out alarm e-mails. LCR Configuration Set Dial Code Length This field is the length used to compute a routes priority. This field is generated from the Routing LCR. The minimum price per minute margin at which the service provider is willing to carry the call. The default is 0. This is the global setting for the profit threshold. You can also set this for a carrier, a region, and a route. See Setting up data for LCR with profitability. The profit threshold is used with Least Cost Routing with profit threshold, also called Lossless LCR (LLCR). LLCR is a licensed feature in RSM. Security Configuration User Password Expired In Determines the number of days for the expiration of the RSM user password. For example, if you enter 30 in this field, the RSM user password expires in 30 days from the date it was last reset. If you leave the field empty, the password never expires. A value of 0 is not valid. A value of -1 indicates that the password does not expire. If the password has expired when the user logs in, RSM redirects the user to the Password change page. The Password Change page
System Profit Threshold
113
asks the user to enter the existing password and a new password. RSM verifies that the existing password matches the previous password, and logs the user into RSM. Audit Trail Purge Configuration Purge Audit Records Days Value in days used to determine whether records in the audit trail should be deleted. RSM deletes records in the audit trail older than the number of days specified in this field. Auto Sync Configuration Auto Sync Master The default value of the DB Sync Master when a new MSX is added.
Auto Sync Period (minutes) The time interval between DB Sync detections, i.e., DB Sync runs periodically with this interval
Logging
The RSM Logging feature allows you to debug and troubleshoot particular software modules, e.g., Reports, DBSync, Archiver and so on. This feature automatically logs information by class and method. The logging levels are: SEVERE (highest value) WARNING INFO CONFIG FINE FINER FINEST (lowest value) ALL - allows the system to log ALL modules
Accessing the Logging page

To access the Logging page, follow these steps: 1. Click System>Logging. 2. The Logging page displays. 3. Make all necessary changes. 4. Click the Submit button.
114
RSM System
Field Descriptions
Field Logfile Path Number of logfiles Max logfile size All
Description Provides the logfile path, e.g., /var/log/bn.log. Identifies the number of logfiles, e.g., 1. Identifies the maximum logfile size, e.g., 10000000 Provides a list of global logging levels, i.e., SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST and ALL. If you select ALL it logs everything.
Reports XMLMessaging Rating CDRSImportExport Common DBSync ProvisionReport Routing RatingImport WebServices Alarms Summarizer Archiver
Specifies the logging level for the reports module. Specifies the logging level for the xml messaging module. Specifies the logging level for the rating module. Specifies the logging level for the CDR Import/Export module. Specifies the logging level for the Common module. Specifies the logging level for the DBSync module. Specifies the logging level for the ProvisionReport module. Specifies the logging level for the Routing module. Specifies the logging level for the RatingImport module. Specifies the logging level for the webservices module. Specifies the logging level for the alarms module. Specifies the logging level for the Summarizer module. Specifies the logging level for the Archiver module.
Status
The Status page provides a diagnostic and debug feature that assists users and technical support in analyzing server performance and debugging performance problems. There are two types of Status pages available under the Status menu:

CDRs Status page Users Status page
The CDRs Status page provides information on RSM service, including details such as the table 115
on which you are working, service start time, end time, and so on. This page also provides details on the current version of RSM, Mysql, Java Hotspot TM, and Apache Tomcat. The Users Status page provides information on RSM users, including details such as user name, partition, login date and time, and the date and time of the user's last activity.
Accessing the Status page

To access the Status page, follow these steps: 1. Click System>Status. 2. The Status page displays 3. Use the Previous and Next buttons to navigate pages if the report doesn't all fit on one screen. 4. Click More Information to view the full Status page. 5. Click the Show button on any status element to display more information on that element. 6. NOTE: Clicking the Clear button on the Activity Log field will clear ALL activity log information. 7. Click Close to exit the Status page. Content Area summary Below is a summary for the Status page content area:
Field Descriptions
Note: Date and time are displayed in the formats specified for the partition and partition user. Refer to Date and time formats for information. Field Data Summary Description Provides details on the number of MSXs and partitions on the system, and number of endpoints configured. There is also a button showing the number of endpoints per MSX and partition. Provides details related to the number of users on the system and the number of users logged in. Provides version numbers for the RSM, JVM, Jboss, Tomcat, and Mysql software. Shows JVM related details -- that is, name, uptime, free memory, max memory, and total memory. Provides InnoDB free space and connection pool detail to include the following: 1. JDBC Pool Size: Number of connections in the pool. 2. Connections in Use: Number of connections that are currently being used. 3. Connections created: Total number of connections that have been created after the pool was instantiated. 4. Connections destroyed: Total number of connections that have been destroyed after the pool was instantiated.
Users Versions JVM Diagnostics Database Information
116
RSM System
NOTE: There are two database connection pools in the RSM: BN pool and Rater pool. The status page will show details for both pools. CDR Details Provides CDR details to include the number of CDR tables, CDRs in the system, CDR range, oldest/latest CDR per MSX, report optimization, and partition up-to-date. Provides a framework for monitoring task progress in the system. This feature shows the number of tasks running, tasks whose output is cached, details of tasks in progress and tasks whose output is stored in the system. Shows the output of "top -b -n1" on the UNIX console, the percentage of CPU time in user mode, system mode, niced tasks, iowait and idle. NOTE: Niced tasks are only those whose nice value is positive. Time spent in niced tasks are also be counted in system and user time, so the total is more than 100%. Shows the content of the hybernate cache. It includes bean name, number of beans cached and the total size occupied by each bean. The following details are provided for each file system. 9. Name 10. Size 11. Used 12. Available 13. Use percentage 14. Mount point Shows the content of the hybernet cache. It includes bean name, number of beans cached and the total size of occupied by each bean. Identifies each user logged onto the system. Identifies the partition assigned to each user. Identifies the IP address of the machine that each user logged onto. Identifies the login date and time for each user. Identifies the latest date and time of activity for each user.
Jobs Cache
Number of CPU
Disk Usage
Data Cache User Partition Client IP Login Time Last Activity
License
The license file controls the permissions for each RSM module. The license is locked to a particular machine using several criteria, instead of just the host ID. The License page serves as both the display of the current license and a way to update the license. The current license is displayed on the bottom half of the page, and the top portion provides a way to update the license. NOTE: If there is no license on the system, a message similar to the one here displays: RSM Server 4.2; Invalid signature line in license error.. Please contact your System Administrator or NexTone Support for further details.
Accessing the License page

To access the License page, do the following:
117
1. Click System>License. 2. The Update License page displays.
Field Descriptions
Field License file Description Allows you to select the license file to update.
Updating a license
To update a license, do the following: 1. Select the License file by clicking Browse. The Choose File dialog box displays. 2. Navigate to the folder that contains the license file, select the license file to update and click Update. The License Content area displays the results of the update.
Branding
The Branding option allows the System Administrator to update the web interface so that all members of a partition have the same look and feel when viewing their web interface.
Accessing Branding
To access the Branding page, do the following: 1. Click System>Branding. 2. The Branding page displays.
Adding a Banner
Only the System Administrator has access to the Banner function. To add a Banner, do the following: 1. Select a banner file by clicking Browse. 2. Select the file, preferably a .gif file, containing your banner. IMPORTANT! The banner should be no larger than 60 x 40. 3. Click Add. 4. The Branding page now displays with your banner next to the RSM logo with the following message displayed: Logo changed successfully.
118
RSM System
Updating the Logo

To update the logo, do the following: 1. Click Browse. 2. Locate a new logo. 3. Click Update. 4. The new logo has been updated. 5. The following message displays. Logo changed successfully. IMPORTANT! You must log out and log in to activate the new banner.
Removing a Banner
To remove the banner, do the following: 1. Go to the Branding page. 2. Click Browse and locate the logo you wish to remove. 3. Click Remove. 4. A message similar to the one below displays. Logo removed sucessfully.
Devices
The Devices option provides a way to configure MSX system information within the RSM system. There are two ways entries are created in this table:

When an MSX streams CDRs to this RSM system When a user manually creates an entry
Accessing the Devices page

To access Devices, do the following: 1. Click System>Devices. 2. The Devices page displays. NOTE: The column Master actually represents the MSX database status. For the redundant system, it displays the database Master/Slave status. For the standalone system it always displays Master.
Field Descriptions
Field Description
119
Cluster ID
A unique ID that indicates a particular cluster configuration. A cluster ID needs to be configured even for iServers that are not in a cluster configuration. Two iServers in a cluster should be configured with the same cluster ID. The value cannot be zero. A logical name of the device. This can be either configured or inferred from the CDR content. The version of the RSM software under which this device was added. The number of calls that handled by this device. The management IP address of the MSX Any user-defined description of the MSX system (optional) . Describes the cluster configuration of this devicewhether the machine is a master or slave, and whether it is in active or standby mode. The current operational status of the MSX. The date and time the device was created. Note: Date and time displays in the format configured for the partition.
Name
Version Call count IP Address Description Cluster Information Status Created
Last Modified
The date and time the device information was last modified. Note: Date and time displays in the format configured for the partition.
Adding a device
Note: Some fields use Msw instead of MSX. Msw was the name for MSX in previous releases. To add a device, do the following: 1. From the Devices page, click Add. 2. The Add Device page displays. 3. Enter the appropriate values for the Cluster ID (unique for a given clustered MSX systems). Selecting -new- allows you to enter a new Cluster ID. 4. Enter the iServer Name. The name should match what will be in the CDR from this MSX. 5. Enter an IP Address. This is the management IP address of the MSX. 6. Enter the MswUsername and MswPasswords. NOTE: When the RSM detects a CDR stream from a MSX system, the corresponding entry in the devices table (system created or user created) is marked as not able to be deleted and you will not be able to delete it. However, you can edit all information other than the device name. Also, for CDR streams coming from devices other than NexTone MSX systems, the IP address and password fields have no meaning. The entries in this table are used :
120
RSM System
When an admin user launches the RSM console, all MSX entries from this table will be automatically populated into the main screen. The user and partition configuration will display the devices from this list, so the admin can assign one of the systems as the MSX to which the partition/user belongs to. When a user launches RSM console and makes any changes (endpoints, realms, etc), the MSX from the user preference will be used, and the corresponding IP and passwords from the devices table will be used for the communication. During LCR>Update Device operation, the MSX from the user preference will be used to create the routes, and the corresponding IP and passwords from the Devices table will be used for the communication.
WARNING: Deleting entries in this table will orphan the corresponding CDR, realms, endpoints and iEdge group entries within the system. Deleting an entry and recreating the same entry back into the system results in the previously configured data to be lost. 7. Enter the MswPort. 8. Enter the Msw Database IP. 9. Select the Autosync Master from the list. 10. Click Submit. 11. A message similar to the one below displays: Device xxxx is added into the database
Field Descriptions
Field Cluster ID Description A unique ID that indicates a particular cluster configuration. Even iServers that are not a cluster requires a cluster id to be configured. Two iServers in a cluster should be configured with the same cluster id. The value cannot be zero. A logical name of the device. This can be either configured or inferred from the CDR content. The management IP address of the MSX. A user defined description of the MSX system (Optional). The user name to use when the RSM system attempts to contact the MSX. The passwords to use when the RSM system attempts to contact the MSX. Identifies the MSX port.
Name
Ip Address Description MswUsername MswPassword MswPort
Msw Database IP The current operational status of the MSX.
121
Autosync Master Master database for the Sync Process. The entries from the autoSyncMaster will be copied to the other i.e. if the autosync master is RSM then in case of autosyc the values will be copied from RSM to MSX.
Updating a Device
To update a device, do the following: 1. Click on the device name to be updated. 2. The Update Device page displays. 3. Make all necessary updates and click Submit. 4. A message similar to the one below displays: Device xxxx is updated into the database
Deleting a Cluster
To delete a Cluster, do the following: 1. Click the Trash Can icon, to the left of the Cluster ID you want to delete. A warning message displays. WARNING: Before you delete the selected cluster, remember that all iServers in the cluster will be deleted and cannot be retrieved. 2. Click OK to delete the select Cluster. 3. Click Cancel to exit the dialog.
Overview of Partitioning
Partitioning is the method of creating virtual RSM and iServer systems, allowing a single system to look as if it is multiple systems shared by different users. A partition is defined by a set of realms, endpoints, and regions. Partitioning starts with the Admin user creating the partition. Within that partition, users are created; there can be multiple users within a specific partition. Since the partition definition includes a default set of functions, users within the partition inherit the default functions. The administrator has the capability to further restrict user access. When users log in, they see only the data in the partition of which they are a member and do not see another user's partitioned data. Managing partitions in RSM involves the following tasks:

Access List Accessing Partitioning Adding partitions Managing users in a partition
122
RSM System
Access List
Accessing Partitioning
To access the Partitioning page, do the following:
Click System>Partitioning. The Partitions page displays by default.
Partitioning page
Use the Partitioning page to view existing partitions.
Accessing Partitioning
To access the Partitioning page, do the following:
Click System>Partitioning. The Partitions page displays by default.
Field Descriptions
Note: Some fields indicate whether an option is enabled or disabled. A yellow light bulb indicates the option is enabled; a gray light bulb disabled. Field Partition Description The name of the partition of which the user is a member. Every user must be a member of some partition. partition membership controls the endpoints and ports accessible to that user when requesting reports The system-generated identifier for the partition; between 1 and 64. The number is used in other rating tables. Also, operators need to know these numbers to generate CVS files for rating table import. Carriers - reference EndpointID from endpoints, regioncode from regions table Routes_ - reference EndpointID from endpoints, regioncode from regions table, ANI from ANI table, CarrierID from carriers_<partitionID> table Rates_ - reference PeriodID from periods table, regioncode from rates table, ,CarrierID from carriers_<partitionID> table Stylesheet System Administrator only. Allows the administrator to update the "look and feel" of a partition through the web interface. Indicates whether Answer Seizure Ratio (ASR) activity is enabled or disabled. If this feature is enabled, users who are members of this partition can retrieve ASR reports. Indicates whether Business Report is enabled or disabled. If this feature is enabled, users who are members of this partition can retrieve Business reports. indicates the option is
ID
ASR
Business
123
Route Profit
This field indicates whether billing activity is enabled or disabled. If this feature is enabled, users who are members of this partition can retrieve Route Profit reports. Indicates whether Custom reports are enabled or disabled. If Custom is enabled, users who are members of this partition can retrieve Custom reports. This field indicates whether Log activity is enabled or disabled. This field indicates whether CDR activity is enabled or disabled. This field indicates whether Actions activity is enabled or disabled. Either a Reg ID or IP address of the endpoint device. Applies to traffic with this endpoint as either the source or destination, unless the Source flag above is selected. Indicates whether routing activity is enabled or disabled. Indicates whether rating activity is enabled or disabled. Indicates the maximum total calls for the listed partition. Indicates the name of the configured device. The date and time format specified for the partition. See Date and time formats. The currency format specified for the partition. See Currency formats. Identifies the date and time the partition was created. Identifies the date and time partition information was last updated.
Custom
Log CDR Actions Endpoints
Routes Rates Maximum Total Calls Device Date Time Format
Currency Symbol Created Last Modified
Additional tasks
You can perform the following additional tasks from the Partitioning page.

Updating the partition stylesheet (system administrator only) Adding partitions
Updating the partition stylesheet (system administrator only)

The System Administrator can change the look and feel of a partition through the web interface. To edit the stylesheet, follow these steps: 1. From the Partitions content page, click the Stylesheet icon corresponding to a specific partition. 2. The Stylesheet page displays.
124
RSM System
3. Make all necessary changes to the Stylesheet properties. 4. Click Submit to save your changes.
Adding partitions
Adding a Partition
To add a partition, do the following: 1. From the Partitions page, click Add. 2. The Add Partition page displays. 3. Fill in the fields on the page. 4. To make an endpoint an Authorized Endpoint(s), move the desired endpoint from the Available Endpoints column, by clicking or . or
5. To move an Authorized Endpoint(s) to the Available Endpoints column, click . 6. Click OK to save file. 7. A message similar to the one below displays: Partition xxxx is added to the database 8. If you wish to return to the previous page, click Back.
Field Descriptions
Field Partition Info Partition The name of the partition of which the user is a member. Every user must be a member of some partition. partition membership controls the endpoints and ports accessible to that user when requesting reports This column contains a master list of all endpoints in the system. This column contains a list of endpoints that make up the partition, i.e., these are the endpoints that are in the partition. Description
Available Endpoints Authorized Endpoints
Limits Maximum Total Calls An optional limit on the maximum number of concurrent calls this endpoint can have. The maximum number of incoming calls the system can process. The defaults are: 3. Limited
Maximum Calls In
125
4. Unlimited 5. None Maximum Calls Out The maximum number of incoming calls the system can process. The defaults are: Maximum Bandwidth Total Limited Unlimited None
An optional limit on the maximum bandwidth this endpoint can have.
Maximum Bandwidth In The maximum bandwidth of incoming calls the system can process. The defaults are: Maximum Bandwidth Out Limited Unlimited None
The maximum bandwidth of outgoing calls the system can process. The defaults are: Limited Unlimited None
Capabilities Reports This field gives you access to the ASR, Business and Route Profit reports. This field gives you read/writer permission to the Logs, CDRs and Actions. Also, the Actions can be controlled individually for the following categories: Routes and Rates ARM - Block, Unblock, Endpoint Priority, Route Priority Custom Script - Execute Script Generic - Log, Mail, SNMP Trap
Alarms
-If Endpoints is checked, it gives you read/write permission to Endpoints. If you do not have write permission: the Add Endpoints option is disabled on the Update Partition page. the New option is not available on the Update Carrier Plan
126
RSM System
endpoints drop-down list. You cannot add an endpoint in RSM Console You cannot import the endpoint table to the database from the Import page.
-If Limited Access is checked, you can only overwrite a limited number of priorities. -If Routes is checked, it gives you read/write permission to access carrier plans, regions and routes. If you do not have write access: the Add button is disabled from the listing page the Name link is not clickable (no update) you cannot Import those tables to the database.
-If the "Dial Plans Only" is checked, write access is limited to "regions" only. -If "Rates" is checked, it gives you read/write permission of carrier plans and periods. If you do not have write access: the Add button is disabled from the listing page the Name link is not clickable (no update) you cannot Import those tables to the database.
-If LLCR is checked, Lossless LCR is enabled for this partition. For more information, refer to Setting up data for LCR with profitability. E911 Determines whether the E911 (emergency numbers) option is enabled for this partition. If this option is enabled, users who are members of this partition can view, read, and write E911 screens in the RSM Console. If this option is disabled, users cannot view, read, or write any E911 screens from the RSM Console.
Options ISDN Codes to Calculate ARR iServers This field allows you to add ISDN codes to calculate ARR. You also have the option to Update or Delete the ISDN codes. The generic name for any NexTone session controller, used exclusively in RSM, which may be an MSW (core-deployed, without media routing), or MSC (edge-deployed, includes media routing). Identifies the time zone as Local time or Greenwich Mean Time (GMT).
Default Time Zone Usability Date Format
Indicates the date format supported by the partition. Click the drop-down list to see the available date formats. See Date and time formats.
127
Time Format
Indicates the time format supported by the partition. Click the drop-down list to see the available time formats. See Date and time formats. Indicates the currency symbol supported by the partition. Click the dropdown list to see the available currency symbols. See Currency formats.
Currency Symbol
Managing users in a partition

The Users option under the Partitioning menu allows the RSM system administrator to manage users in a partition. To access the User page, do the following: 1. Click System>Partitioning>Users. 2. The Users page displays.
Capabilities
RSM has both partition and user capabilities. User capabilities are a subset of partition capabilities. Also, the user to have access to Capabilities, both the Partition and User Capabilities must be enabled identically. The capability type displayed on page is controlled by the license feature. For example, if the user has no alarm license, the alarm capability is hidden. if the user has no BAM license, the business and route profit checkbox are hidden
Field Descriptions
For those fields with enable/disable settings, a yellow bulb field is enabled; a gray bulb Field User Description The name by which a user is known to the system. Each individual user has a unique ID. The name of the partition of which the user is a member. Every user must be a member of some partition. Partition membership controls the endpoints and ports accessible to that user when requesting reports. Grants access to view all system administrator functions. See Managing users in a partition. Grants access to view the ASR report (accessible from the Engineering report page). Grants access to view the reports accessible from the Business reports page. displays when the
displays when the field is disabled.
Partition
SysAdmin
ASR
Business
128
RSM System
Route Profit Custom Log
Grants access to view the reports on the Route Profit page. This field indicates whether the Custom Report is enabled or disabled. Grants access to the log alarm list. Access can be read-only (i.e., view existing alarm definitions) or read/write (create and modify alarm definitions). Grants access to the CDR alarm list. Access can be read-only (i.e., view existing alarm definitions) or read/write (create and modify alarm definitions). This field indicates whether Action is enabled or disabled Either a Reg ID or IP address of the endpoint device. Applies to traffic with this endpoint as either the source or destination, unless the Source flag above is selected. This field indicates whether Routes is enabled or disabled. This field indicates whether Rates is enabled or disabled. The date and timestamp when user information was created. Note: Date and time displays in the format configured for the partition. See Date and time formats.
CDR
Action Endpoints
Routes Rates Created
Last Modified
The date and timestamp when user information was last modified. Note: Date and time displays in the format configured for the partition.
Capabilities for user/partition combinations

User root Capability SysAdmin
Non-Admin partition SysAdmin 1. Can add, delete, and modify users in their partition 2. Can access Archiver, Audit Trail, and CDR Import/Export in their partition Non-Admin partition Regular User Admin partition Can only view the User page with password, time zone, and ISDN modification information.
SysAdmin Can add, delete, and modify users
129
4.3 RSM Operations Guide Admin partition
Can add, delete, modify partitions, and access lists Can access Config, Status, License and Devices
Regular User Can only view the User page with password, time zone and ISDN modification information.
Adding users
To add a new user account, do the following: NOTE: To create a new user account, you must be logged into an account name that has administrative privileges. When adding a new user, partition capabilities take precedence over user capabilities. For example, only those user capabilities authorized by the partitioning process are accessible to the user. 1. Click System>Partitioning>Users. 2. The Users home page displays. 3. Click Add. 4. The Add User page displays (see sample page below). NOTE: When adding a new user, partition capabilities take precedence over user capabilities. For example, only those user capabilities authorized by the partitioning process are accessible to the user. 5. Place the user in a partition by selecting a Partition from the list above the User Name. 6. Click in the User Name box, and type an account name for the new user. 7. Enter the new users initial password in the New Password field, and repeat it in the Confirm New Password field. 8. Set the new users capabilities using the check boxes provided. Note that only by first enabling a category of activity (reports or alarms), can you then specify user capabilities within that category. 9. Enter the ISDN Codes to calculate ARR. You can add, update, or delete an ISDN code by clicking on the code and clicking on the appropriate key. 10. Select the iServer the user will have access to. 11. Enter the Default Time Zone. 12. Once your changes are all entered, click Submit. A message similar to the one displays: 13. User xxxx is added to the database 14. Click Back to return to the previous page.
Field Descriptions
Field Description
130
RSM System
Partition
The name of the partition of which the user is a member. Every user must be a member of some partition. partition membership controls the endpoints and ports accessible to that user when requesting reports. Is the name by which a user is known to the system. Each individual user has one ID; two users should not share one User ID. The administrator uses this field to change the users password to a new value. Allows the administrator to re-enter the value in New Password above to confirm that it was typed correctly. Identifies the user as the System Administrator. Identifies the report as ASR, Business or Route Profit. Good is the percentage of the Answer Seizure Ratio defining it as good, and therefore displays it in the chromocode color for good in the ASR report. Marginal is the percentage of the Answer Seizure Ratio defining it as marginal, and therefore displays it in the chromocode color for marginal in the ASR report. ASRs below this percentage display in the chromocode color for not acceptable.
User Name
New Password
Confirm New Password System Admin Reports
Alarms
This field gives you read/write permission to the Logs, CDRs and Actions. Also, the Actions can be controlled individually for the following categories: ARM - Block, Unblock, Endpoint Priority, Route Priority Custom Script - Execute Script Generic - Log, Mail, SNMP Trap
Routes and Rates If Endpoints is checked, it gives you read/write permission to Endpoints. If you do not have write permission: the "add endpoints" option is disabled on the Update Partition page. the "new" option is not available on the "Update Carrier Plan" endpoints list. you cannot add an endpoint in RSM Console you cannot import the endpoint table to the database from the Import page.
If Limited Access is checked, you can only overwrite a limited number of priorities. If Routes is checked, it gives you read/write permission to access carrier plans, regions and routes. If you do not have write access:
131
the Add button is disabled from the listing page the Name link is not clickable (no update) you cannot Import those tables to the database.
If the Dial Plans Only option is checked, write access is limited to "regions" only. If the Rates option is checked, it gives you read/write permission of carrier plans and periods. If you do not have write access: ISDN Codes to Calculate ARR iServers the Add button is disabled from the listing page the Name link is not clickable (no update) you cannot Import those tables to the database.
This field allows you to add ISDN codes to calculate ARR. You also have the option to Modify or Delete the ISDN codes. The generic name for any NexTone session controller, used exclusively in RSM, which may be an MSW (core-deployed, without media routing), or MSC (edge-deployed, includes media routing).
Default Time Zone Identifies the time zone as Local time or Greenwich Mean Time (GMT).
Access List
This option allows you add access lists as well as access to those endpoints you do not own, allowing you to view reports for those endpoints. To access the Access List page, do the following: 15. Click System>Partitioning>Access List. 16. The Access List page displays.
Viewing specific access list information

To view specific access list information on a partition, do the following: 17. From the Access List Partitions field, select the partition from the list. NOTE: You can use an asterisk (*) as a wildcard to display all partition variables. 18. Enter a Realm. 19. Enter an Endpoint. 20. Enter a Region. 21. Click Show.
132
RSM System
Field Descriptions
Field Access List Partition Owner Partition Realm Description Provides a listing of all available partitions.
Identifies the partition owner. In an iServer-controlled network, a realm gives a unique identity to a private network. (Note: This field supports a wildcard search using %.) Either a Reg ID or IP address of the endpoint device. Applies to traffic with this endpoint as either the source or destination, unless the Source flag above is selected. Be careful not to enter the same endpoint by Reg ID or IP address. If you enter the same endpoint by Reg ID and IP address, you will have duplicate events. Also, Reg ID or IP address are interchange-able and case sensitive. lookup - looks up the endpoints as defined in the RSM system. (Note: This field supports a wildcard search using %.)
Endpoint
Port Region
The endpoints port number, if an endpoint is specified. This field describes a region, used to group one or mode dial codes. (Note: This field supports a wildcard search using %.) Example: BHUTAN-SATELLITE
Created
Identifies the date and time the update was created. Note: Date and time displays in the format configured for the partition. See Date and time formats.
Last Modified
Identifies the date and time carrier information was last updated. Note: Date and time displays in the format configured for the partition.
Filters
See Filters.
Adding an access list

To add a access list, do the following: 1. From the Access List page, click Add. 2. The Add Access List page displays. 3. From the Access List Partition list, select a partition.
133
4. From the Owner Partition list, select the partition owner. 5. From the Realm list, select a realm. 6. From the Endpoint list, select an endpoint 7. Enter a Region. 8. Click Submit to accept the entries. 9. A message similar to the one below displays: Data is added to the database
Field Descriptions
Field Access List Partition Owner Partition Realm Description This field provides a list of all partitioned groups. A partition is defined by a set of realms, endpoints and regions. This field provide a list of all partition owners. In an iServer-controlled network, a realm gives a unique identity to a private network. (Note: This field supports a wildcard search using %.) Either a Reg ID or IP address of the endpoint device. Applies to traffic with this endpoint as either the source or destination, unless the Source flag above is selected. Be careful not to enter the same endpoint by Reg ID or IP address. If you enter the same endpoint by Reg ID and IP address, you will have duplicate events. Also, Reg ID or IP address are interchange-able and case sensitive. lookup - looks up the endpoints as defined in the RSM system. (Note: This field supports a wildcard search using %.) Region This field provides the region configuration from the rating tables. For each region, order carriers are listed in ascending order of the rate.
Endpoint
Deleting an access list

To delete a access list, do the following: 1. From the Access List home page, select the access list you wish to delete. 2. Click . A confirmation dialog displays.
3. Click OK to accept the deletion. 4. A message similar to the one below displays: Selected access list is deleted from the database 5. Click Cancel to exit the deletion process.
134
RSM System
Audit Trail
The Audit Trail tracks operations performed on the RSM system.
Accessing the Audit Trail page

To access the Audit Trail page, do the following: 1. Click System>Audit Trail. The Audit Trail page displays. 2. Click the Previous and Next buttons if the report doesn't all fit on one screen.
Field Descriptions
Field User Name Partition Description The name of the user who performed the operation. The name of the partition of which the user is a member.
Client IP Address The IP address of the client machine associated with the user who performed the operation. Action Key Status Created The operation that was performed on the RSM data. The RSM module affected by the operation. Indicates whether the operation failed or was successful (ok). The date and time the audit trail entry was created. Note: Date and time displays in the format configured for the partition. See Date and time formats. Detail Displays additional information on the audit trail entry. Click the Detail link to open a page containing information on the operation associated with this audit trail entry.
Clearing audit trail entries

1. To clear all displayed audit trail entries, click Clear. WARNING: Clicking removes all output information from the page. The cleared information cannot be retrieved. 2. To return to the Audit Trail page window, click Back.
Managing RSM Archiver services

Use the Archiver page for managing RSM Archiver services. These services allow you to schedule jobs to back up, delete, or archive CDRs and provisional data stored on RSM server. To display the Archiver page:
135
1. Click the System tab. 2. Click Archiver. The Archiver page displays. A list of archive jobs that have already been created are listed at the bottom of the page. 3. Click the Previous and Next buttons if the report doesn't all fit on one screen. NOTE: The Archiver function archives the CDRs into a file.
Field Descriptions
Field Name Description The name assigned to the archiving job. This name becomes the prefix of the output file name. Identifies whether the action specified in the job is performed on CDR or Provisional data. Identifies the action that is to be performed. You have these options: Archivebacks up and then deletes the data. Backupbacks up the data. Deletedeletes the data without backing it up. Dir Created The complete path to the directory where the output file will be created. Date and time the job was created. Note: Date and time displays in the format configured for the partition. See Date and time formats. Now Sun through Sat Indicates that you want to execute the job immediately. Indicates the day(s) of the week, Sunday through Saturday, on which you want to execute the job.
Type
Action
Adding an archive job

To add an archive job, do the following: 1. On the Archiver page, click Add. 2. The Add Archive page displays. NOTE: When backing up data on the RSM server, the mysql user name should have write permission into the directory you specify in the job. 3. Enter the job parameters (see table below for a description of each field) and click the Submit button. 4. To exit the Add Archive page, click Back. 5. The job is added to the list of archive jobs and you are returned to the Archiver page.
136
RSM System
Field Descriptions
Field Job Name Description The name of the archive job and the prefix that will be assigned to the output file name. Indicates whether the action specified in the job will be performed on CDR or Provisional data. Identifies the days on which the job will be run. Now - the job will run only once, immediately following submission of the job. S through S - Represents the day of the week, Sunday through Saturday. NOTE: Selecting "Now" will deactivate the Time selection fields. Time Identifies the time the job should be run, if a day of the week has been selected. The time is listed in the format configured for the partition or partition user. Identifies the action that is to be performed. You have these options: Archivebacks up and then deletes the data. Backupbacks up the data. Deletedeletes the data without backing it up. Data Identifies how old, in number of days, the data in the report will be. (For example, if "100" was specified, the report would be generated for all data/records 100 days or older.) Indicates that the data selected for the archive job will be filtered by Begin and End dates. Specifies the beginning date for selecting data for the job. Data older than the date you specify will not be selected. (You must enter the date and time in the format specified for the partition and partition user.) Specifies the ending date for selecting the data for the job. Data later than the date you specify will not be selected. (You must enter the date and time in the format specified for the partition and partition user.) The complete path to the directory where the output file will be created.
Type
Days
Type
Filter
Begin Date
End Date
Directory
Deleting an archive job

To delete an archive job:
137
1. Click the Trash Can icon next to the archive job you want to delete. 2. A pop-up message displays: "Are you sure you want to delete Archive <name of archive>." 3. Click Yes to delete the archive job.
Importing and exporting Call Data Records

NOTE: Before configuring any stream, at least one mapping should exist within system. Use the CDR Import/Export option on the System menu to define CDR streams. A CDR stream in RSM carries out the following tasks:

It collects the CDRs from a data source using a collector agent. It processes and converts these CDRs according to rules specified in the mapping component. It transfers these CDRs to a Consumer for CDR consumption.
The two types of CDR streams available in RSM are Import and Export. The Import CDR streams are used to import third-party CDRs into the RSM system. The Export CDR streams are used to export CDRs stored in the RSM system to an external system (such as a billing server). Both types of streams execute the same work flow as described above. Import-type streams have a fixed consumer, the Rater Bean; export-type streams have a fixed collector agent that collects rated CDRs. NOTE: Once a complete mapping is stored in an .xml file, the file is placed in
/home/nextone/CDRStream/transform
Required directories
The host machine running the RSM software must have the following directories:

/home/nextone/CDRStream/transform for storing Mapping xmls. /home/nextone/CDRStream/log/ for pipeline logs
Adding a CDR map

The configuration of a CDR Stream is done by configuring a collector agent, a mapping component or a transformer and configuring a consumer. IMPORTANT: Before configuring any stream, at least one CDR mapping should exist in system. To add a CDR map, do the following: 1. Choose the System>CDR Import/Export. 2. The CDR Import/Export home page displays. 3. Click New Import Stream or New Export Stream.
138
RSM System
Creating an import stream

1. On the CDR Import/Export page, click the New Import Stream. 2. The CDR Stream parameters page displays. 3. Click Add. 4. The CDR Import page displays. 5. Enter the Stream Name. 6. Enter the Field Name. 7. Enter the Format. 8. Select a Type from the list. 9. Select a Transform from the list 10. Select a Transform List from the list. 11. Click Create New Field to add the new mapping field. 12. NOTE: If you click Add Field first, the system tries to add the same field twice. 13. The new mapping field information displays in the lower right hand box. 14. Click Save Mapping to save the new map. 15. The following message is displayed: Mapping XML Saved.
Field Descriptions
Field Mapping Name Description Enter a unique mapping name. This name should be meaningful to you for use later during the configuration of the CDR Stream. The complete mapping is stored in an xml file located in the /home/nextone/CDRStream/transform/ directory. Allows you to enter the field to be mapped in the incoming CDR. Allows you to specify the format of the incoming CDR field. The format of the incoming field is 'uint32', 'string', strftime format for date, or custom group patterns inside curly brackets. This field is an optional field. Describes the type of incoming CDR. The types are Not Required, Date, Time and Additional. If the type selected is Additional, a new field is added to incoming CDR based upon theconstant or Variable transform described in it. Identifies the transforms by their defined Outname. On selecting any one of these transforms, a section describing the details of the transform appears in
Field Name Format
Type
Transform
139
the lower right block. The following transforms are available: keep - this is the simplest transform. It just requires an OutName. The incoming field is mapped to with no data transformation. ipaddr - transforms the incoming IP address into a outgoing IP address specified in a attribute format. condition - if incoming field is null or not available, then change the output field by the value of the incoming field whose NAME is given in IfEmpty. time - transforms the uint32 format time in this CDR Field into the float format (e.g., %5.2f) specified in this transforms format. The format is converted into a float, based upon the value selected. (i.e., Hour, Minute or Second). date - the date transform should be applied to the date fields of incoming CDRs. The incoming field format for this date should be either uint32 or the date time format described in the strftime function of c language. The OutName is the name of the output field from this mapping. The Zone should be either a null or valid value for a UNIX time zone, literally expressed. The output format is again similar to the incoming field format. variable - normally used as an additional field. A current date/time value is added in the output CDR in format given. concatenate - To be provided. constant - normally used as an additional field. A fixed value defined in Value is added in the output CDR. expr - a mathematical computation is performed on the value in this CDR field according to the expression in the value= element. To perform a computation on a CDR field value using the expr type, the value must be assigned to a variable. MatchKey element names the variable and Value describes the computation to be done.
Transform List
This field has a list of names of output fields in the current mapping. If no input fields are defined, this box does not appear.
Removing a field To remove a mapping field, do the following: 1. Click Remove Field. 2. The field is removed from the lower right hand box. Modifying a field To modify a field, do the following: 1. Click Modify Field. 2. Make all necessary modifications.
140
RSM System
3. Click Modify Field again. 4. Your modifications display in the lower right hand box.
Creating a CDR Stream

Once the mapping is configured, you can create a CDR stream. The CDR Stream configuration consists of five parts as follows: CDR Stream configuration is divided into: Mandatory configuration Optional Advanced Configuration.
Mandatory Configuration consists of: Basic CDR Stream parameters CDR Stream Consumer/Collector Agent parameters
Optional Advanced Configuration consists of: Mapping between selected Mapping infields names and actual input names/positions at the CDR Source CDR Stream Consumer parameters (For CDR Import Stream this is not required, it will be the rater of RSM) Mapping between selected Mapping transforms out names and actual output names/positions for the CDR's Destination NOTE: For CDR Streams of both types (Import and Export) the basic parameters are identical except for one difference. In the case of an Export type, the collector Agent is fixed and in the case of an Import type the Consumer is fixed. To create a CDR Stream List:, do the following: 1. Choose the System>CDR Import/Export. 2. The CDR Stream List page displays. 3. The New Import (CDR) Stream parameters window displays.
Field descriptions on the CDR Stream List page

Field PipelineID Name Debug Level Description This is an internal ID for display purposes only. Identifies the stream name. Identifies the debug level for the stream.
Data Source Type Identifies the data source type for the CDR stream.
141
Status Next Start Time Last Execution Status Last Successful Batch Execution
This field identifies whether or not the alarm is enabled or disabled. Identifies the next start time for running the CDR steam list. Identifies the last execution status for the CDR stream.
Identifies the last successful batch execution for the CDR stream.
Field descriptions on the New Import (CDR) Stream parameters window

Field Stream Name Schedule Description This field identifies the stream name. This field consists of two entries as follows: Start Time - This field identifies the mm/dd/yyyy and hh:mm:ss start tune. Frequency (sec) - This field identifies the interval in seconds between two invocations of the PipeLine Service.
Transformer: Use Existing Mapping Data Source Start Automatically
Identifies the transformer mapping to be used.
Identifies a file type, i.e., DB, Delimited File, HTTP. Indicates whether the CDR Stream should re-start automatically or manually by the Administrator. To be provided. The table name from which CDRs are selected. To be provided. To be provided.
JDBC Driver Name Table Name Database User ID Primary key
Database Password To be provided. Start Value URL Where Clause Batch Size To be provided. To be provided. To be provided. Number of rows to read in every database read. Default is 100.
142
RSM System
NOTE: Based on the selected collector agent the administrator needs to specify the parameters for the collector agents. These parameters are used for initiation of a session with the CDR source. In the case of Export Stream, the collector agent is automatically selected.

Enter all applicable information and click the Save button to accept your entries. NOTE: If you selected DB in the Data Source field, these parameters are required. JDBC Driver Name Table Name Database User ID Primary Key Database Password Start Value URL Batch Size NOTE: If you selected Delimited File in the Data Source field, these parameters are required.
File Location - Directory where file is kept. Default is "/home/nextone". File Name - the name of the file in which CDRs are stored, Required Row Delimiter - Default is enter ("\n") Field Delimiter - Default is tab ("\t") Escape Sequence - Optional File Position to read from - Default is 0. Delete after read - (should file be deleted, after all the CDRs have been read from this file) Batch Size - default is 100.
New Export Stream

This function is based on the start time of RSM CDRs. All CDRs having a start time greater then To create a CDR Stream List, follow these steps: 1. Choose the System>CDR Import/Export. 2. The CDR Stream List home page displays. 3. Click the New Export Stream button. 4. The New Export (CDR) Stream parameters window displays.
143
NOTE: Based on the selected collector agent the administrator needs to specify the parameters for the collector agents. These parameters are used for initiation of a session with the CDR source. In the case of Export Stream, the collector agent is automatically selected. 5. Enter all applicable information and click the Save button to accept your entries.
Advanced Configuration
This option allows you to map between transformation in fields and the collector Agent parameters. In order for mapping component to apply rules defined in the mapping xml file, the file positions (CDR DB = File) or column names (CDR DB = DB) in the collector agent should be correctly mapped to the fields described in the mapping xml. In case of DB Collector agent in CDR Import Stream:
The field name in the mapping xml should be mapped to column name in the data source table. If no column name for this field exists, this should be left blank.
In case of Delimited File Collector Agent in CDR Import Stream
The field name in the mapping xml should be mapped to the correct field position in a CDR row. If CDR row does not contain this field, it should be left blank.
Setting Collector Agent Parameters

Based on the selected collector agent, the administrator needs to specify certain parameters. These parameters are used for the initiation of a session with the CDR source. NOTE: In case of Export Stream, the collector agent is automatically selected. To set collector agent parameters, do the following: 1. Choose the System>CDR Import/Export. 2. The CDR Stream List home page displays. 3. Follow all preceding steps, until you come to the collector agent page. 4. If the collector agent is DB (external database), do the following: 5. Enter the JDBC Driver class (Required). 6. Enter the Table Name (Required). 7. Enter the Database User Id (Required). 8. Enter a Database password (Required). 9. Enter the Database JDBC URL (Required). 10. Enter the Primary Key column name (Required). 11. Enter the Start Value. The Default is 1000. 12. Enter the Batch Size. The Default is 0.
144
RSM System
13. Enter a Where Clause (Optional). 14. If the collector agent is a Delimited file type (the data source is a file), do the following:
Enter the File Location . This is the directory where file is kept. Default is /home/nextone. Enter the File Name. This is the name of the file in which CDRs are stored. (Required) Enter the Row Delimiter. The default is (\n). Enter the Field Delimiter. The default is tab (\t). Enter the Escape Sequence. This field is Optional Enter the File Position to read from. The default is 0. Enter the Delete after read . This file should be deleted, after all the CDRs have been read from this file. Enter the Batch Size. This is the number of rows to read for every database access (read or write). Default is 100.
15. If the collector agent is a Export Collector, do the following:
Enter the Offset:, which indicates the starting offsets of the CDR files in RSM. The default value is 0. Enter the Batch Size , which is the number of rows to read for every database access (read or write). Default is 100. Select a Group name from the list.
Mapping Between Transform in Fields and Collector Agent Parameters

In order for the mapping component to apply the rules defined in the mapping xml, the file positions (i.e., file as the CDR data source) or column names (database as the CDR data source) in the collector agent should be correctly mapped to in fields described in the mapping xml. If the DB Collector agent is in CDR Import Stream:
The field name in the mapping xml should be mapped to the column name in the data source table. If a column name for this field does not exist, this should be left blank.
If the Delimited File Collector agent is in CDR Import Stream:
The field name in the mapping xml should be mapped to correct field position in a CDR row. If CDR row does not contain this field, it should be left blank.
If the Export Collector Agent is in CDR Export: Stream:

The field name in the mapping xml should be mapped to column name in CDR tables. In the case of CDR export, the following parameters are used
CDR Errors
This section introduces the concepts of the CDR Receptor module (CRM) that NexTone RSM
145
provides as a CDR receiving interface.
CDR Receptor Module (CRM)

CRM acts as a single point for inserting CDRs into the RSM database. In the current RSM system, an initial integrity check is not done on inserted CDRs. If the CDR has invalid/hostile characters or fields, the CDR insertion often failed to insert the CDR into RSM and the CDR insertion process was halted without any useful logging or identification of inconsistent CDRs or the CDR field causing the problem. In order to circumvent this, the CRM has been added to act as a CDR receiver and perform primary validation and quarantine those of CDR fields with invalid characters. The invalid CDRs which are filtered by CRM can be manually edited and then inserted into the RSM system using the web interface. NOTE: The CRM cannot validate CDRs for the presence of the character ";" in CDR fields. The presence of ";" in a CDR field results in division of the CDR field into two fields which may cause the CDR insertion into the database to fail. It is not possible to pro actively identify the presence of ";" in any CDR field because ";" itself acts as CDR field delimiter. In this scenario if during the CDR insertion process a problem is detected due to and inconsistent format in a field data type it is logged into the CDR Logging file.
CDR Validation
Incoming CDRs can be validated by verifying the presence of invalid characters in any field. If the CDR is found to contain any of the invalid characters, the CDR is logged into the CDR log file as specified in the bn.properties file.
CDR Logging
For logging the invalid CDRs identified instance of file logger is created using the logging file name specified in bn.properties. If invalid CDRs are identified during CDR validation or parsing into CDR Bean, they are logged into the log file.
Re-Import of CDRs
During the CDR streaming process some CDRs may be identified and logged as bad CDRs in the log file. You can manually edit these CDRs and correct the problematic CDR fields. Once the CDRs have been modified you can try to re-submit them to the RSM system using the web interface. This interface takes a CDR file and attempts to insert it into the RSM system. If there is any error during this process, the user is notified and further import of CDRs will not be attempted. The user is shown the line number in file which interrupted the CDR insertion.
User Input and Output

There are three criteria the user should address during the input and output process, they are:
User should specify the name of file which can be used to log the CDRs not successfully inserted into the RSM database because of invalid characters or field data types. Performing validation of CDRs can be quite resource intensive. Therefore, you can now enable or disable CDR validation from the system properties file. During the import of manually edited CDR files, you must provide the file name using the web interface.
146
RSM System
Accessing CDR Errors

To access Re-Import CDRs, follow these steps: 16. Select System>CDR Errors. 17. The Re-Import CDRs page displays. 18. Select the CDRs to be modified from the Available CDR Re-Import Files. 19. Click the button. button.
20. If you wish to modify all CDRs click the
21. Specify the name of the file that can be used to log the CDRs not successfully inserted into the RSM database by clicking the Browse button. NOTE: During the import process you must specify the file using the web interface. 22. Click the Browse button.
About Synchronization
Occasionally, the databases between MSX and RSM can get out of sync. Among the reasons that this can occur are:

User executes CLI commands to add database entries to MSX. Data successfully added into MSX but failed when added into RSM. Data successfully added into MSX but a network related error occurred.
The Synchronization feature in RSM allows you to perform the following tasks:
Manually synchronize database data from MSX to RSM (import) and from RSM to MSX (export) Detect an out of synch condition between RSM and MSX databases Audit and auto synchronize between MSW and RSM Synchronize RSMLite
IMPORTANT: Database synchronization and auditing is limited by the size of the database. The synchronization between MSX and RSM is restricted to System Administrators. Furthermore, when the synchronization process is taking place, the affected partition user should be temporarily suspended for operation.
Manual database synchronization between MSX and RSM

The synchronization process allows you to:
Synchronize database data from MSX to RSM (import), allowing you to overwrite RSM database data with MSX database data. Synchronize database data from RSM to MSX (export), allowing you to overwrite MSX
147
database data with RSM database data. Out of sync detection This function detects differences between the RSM and MSX databases. A background service periodically compares and detects the out-of-sync incidents between the two databases that are within a configurable time interval. A set of configurable parameters is provided in the bn.properties file. The time period value is also configured through the system configuration web page. Out of sync detection mechanism For performance reasons, it is not possible to completely compare records in both databases to detect their differences. Instead, RSM uses a version number to track the record change. Each table serviced by the DB synchronization process has a version number column. The version number is 0 at insertion time, and is incremented at each update. The DB synchronization service gets the table indices and version number column from both sides, and then compares them to detect the following differences:
Unmatched - the index of a row only exist in one database, which means a record was deleted or added in only one database, not the other. Updated - the versions of the records with the same index do not match, which means a record was updated in only one database.
Database audit/auto synchronization

The audit between MSW and RSM compares and automatically synchronizes the databases based on the configuration elements. There are three options:
MSX as database master - when differences are detected, RSM will be synchronized up to MSX data, i.e., MSX data will always override RSM data. RSM as database master - when differences are detected, MSX will be synchronized up to RSM data, i.e., RSM data will always override MSX data. No database master - when differences are detected, they will be logged into the difference table, and wait for administrator to inspect and determine the operation.
The configuration is cluster based. You can choose a database master in the Device Configuration page. Also, there is a system parameter in the system configuration page to set the default value for newly added devices. Synchronizing database schemas between RSM and MSX The following tables and their schemas are synchronized between RSM and MSX:

Endpoints Callroutes CallPlans CallBindings Realms IEdgeGroups
148
RSM System

Triggers Vnets CdcProfiles Subnets
The order and name of the columns in each table follow those in RS, with extra columns appended at the end of the table. All the tables on the RSM side use PartitionId as the foreign key; the corresponding table on MSX may not necessarily use the foreign key. Therefore, MSX has to create and maintain a groups table just as RSM does.
Synchronization Menu
Accessing synchronization
To access Synchronization, follow these steps: 1. Select System>Synchronization. 2. The Synchronization Differences page displays. This is the default page. You have these options: Difference page - lists all the differences that have been detected between the MSX and RSM databases that have not been synchronized. Each entry lists the cluster id, table name, table key values, and the difference type. If the type is "unmatched" it means the entry is missing in one of the databases. If the type is "updated" it means the entry value has been updated in one of the databases. Clicking the entry allows you to view entry specific details for both databases. Each entry provide three options:

Sync to MSX - uses the MSX value to override the RSM value Sync to RSM - uses RSM value to override MSX value Dismiss - dismisses the entry without taking action
Manual Sync page - Select a cluster, then select the operation to perform for each of the tables:

Copies from RSM to MSX Copies from MSX to RSM No action taken
NOTE: A progress bar shows the progress of the operation during the manual synchronization. A "stop" button can be used to interrupt the operation. After the operation is completed, the manual synchronization page is displayed again, showing the summary at the bottom of the page.
Working with system alarms

Use system alarms to create alarms that are used to monitor the RSM system. System alarms are based on either CDRs or other system resources. The system alarm triggers an action when the conditions configured in the alarm are met. Multiple actions can be configured for a single
149
system alarm. There are four types of System Alarms: Audit, Bad CDR, CDR Alarm Failed to Run on Time and Failed Alarm Action. Note: You can also create alarms using the Alarming tab. Alarms you create under the Alarming tab are used to monitor activities on the MSX server, not the RSM system. To create system alarms. you first define a set of actions, then create the alarms, indicating for each alarm what action you want the system to perform when the alarm is triggered. To access System Alarms, do the following: 1. Click System>System Alarms. 2. The System Alarms page displays. The Events page displays first by default.
System tab: alarm actions

Actions are performed when the conditions for an alarm are met. You first define the types of actions that are available, then create an alarm and specify which actions you want to associate with an alarm. You can specify multiple actions for the same alarm. See System tab: types of alarm actions for information on the actions that can be performed.
Adding a new action

To access the Actions page, do the following: 1. Log onto the system as described in Logging into RSM. 2. Click on System>System Alarms>Actions. 3. The Actions page displays. To add an Action, do the following: 4. Click Add . 5. The Add Action page displays. 6. Select an action Type from the list. 7. Give the action a Name. 8. Enter other field data based on the action type you select. 9. Click Submit. 10. A message similar to the one below displays: Successfully added action 'xxxx'. 11. If you do not wish to submit the entry, click Back.
Field Descriptions
Field Type Description Identifies the type of action to be added. Four types of actions are available in
150
RSM System
the System tab: Execute Script, Log, Mail, and SNMP Trap. For information on the additional fields displayed when you select an action type, refer to System tab: alarm actions. Name A name to be used to identify the action. The name you specify is used when you create an alarm and assign an action to it.
Updating an Action
To update an action, do the following: 1. On the Actions main page, locate the action you want to update by scrolling down the Name column. 2. Click the action you want to update. 3. The Update Action page displays. 4. Make all necessary changes and click Submit. 5. A message similar to the following displays: Successfully updated the action 'xxxx'.
Deleting an Action
To delete an Action, do the following: 1. Click the Trash Can next to the Action you want to delete. A confirmation dialog displays. 2. Click OK to delete the selected action 3. A message similar to the following displays: Successfully deleted the action 'xxxx'. 4. Click Cancel to cancel the deletion process and return to the Actions page.
System tab: types of alarm actions

Following is a list of the alarm actions available from the System Alarms option on the System tab. Field Execute Script Description This action executes a script on the RSM server. Enter the name of the script you want to execute in the Script Name field. The script must be available in the nextonehome/actionscripts on the RSM server and must have the Execute privilege enabled. This action appends an entry either to the RSM system log file (syslog) or to another log file. To configure for syslog, configure the syslog server Host Name, an optional Log Name (a string that appears in all syslog messages; default is 'RSMLog'),
Log
151
Facility and Severity. The syslog messages are sent to UDP port 514 on the server. To configure for a plain file log, enter the complete log file path name under Log Name and ignore the rest of the fields. To configure for syslog, configure the syslog server Host Name, an optional Log Name (a string that appears in all syslog messages, default is 'RSMLog'), Facility and Severity. The syslog messages are sent to UDP port 514 on the server. To configure for a plain file log, enter the complete log file path name under Log Name and ignore the rest of the fields. Mail This action sends an email to a recipient. To specify multiple recipients, list them with a comma separator. This action depends on your settings for the email configuration settings you specify using the Configuration option under the System tab. See Configuration for information on these settings. SNMP Trap Allows device monitoring of the RSM server using SNMP. This action sends a SNMP v2c trap to the configured trap receiver. The trap is an enterprisespecific trap that specifies specific alarm details. When you create an alarm, you can associate it with the SNMP Trap action, causing RSM to send a SNMP trap whenever it detects the condition configured in the alarm. The alarm description for the alarm supplements the information in the SNMP trap, making it easier to associate the information in the trap with the alarm that triggered it. The following information is required when you create an SNMP Trap action:
Receiver IP: The IP address of an external entity that receives the SNMP traps from the RSM server. Community: The password that is used to send traps to the Receiver.
Adding system alarms

Use the Alarms option under the System Alarms submenu to add system alarms. System alarms monitor certain conditions on the RSM server. Note: The alarms you create using the Alarming tab monitor conditions on the MSX server. To add system alarms: 1. Click the System tab, then click System Alarms. 2. Click Alarms. The Add System Alarms page displays.
Field Descriptions
Note: Date and time are displayed in the formats specified for the partition and partition user. Refer to Date and time formats for information.
152
RSM System
Field Alarm Type
Description Identifies the alarm type. Select an alarm type from the drop-down list. Some of the other fields on the Add System Alarms page will be enabled/disabled depending on your choice of alarm type. Allows you to enter a name for this set of conditions. A host can be an MSX, or any device (such as a third-party gateway) that sends CDRs to the RSM. The RSM agent, or the programs that are sending the CDRs to the RSM, is responsible for populating this field in the CDRs. For MSX, the hostname of the machine is filled in as default.
Name Host
On Trigger Action The action that is to be performed when the conditions in the alarm are met. For example, if the alarm type is Bad CDR, you could set the On Trigger Action to email, which would cause an email to be sent when a bad CDR was detected. Off Trigger Action The action that is to be performed when the conditions in the alarm are no longer being met. For example, if the alarm condition is set to Bad CDR, you could set the Off Trigger Action to Log, which would log the alarm in the syslog. Note: The Off Trigger Action field is disabled for the Audit, DB Sync Alarm and Failed Alarm Action alarm types; it is enabled for all other alarm types. Alarm Severity Defines the severity level of the alarm. The drop-down list includes the severity levels that you can define: None, Warning, Minor, Major, and Critical. None is the default. When RSM creates alarm events, each event entry in the Alarm Events screen is color-coded to indicate the severity level. The following severity levels can be associated with an alarm: 1. Critical: associated events are violet 2. Major: associated events are red 3. Minor: associated events are orange 4. Warning: associated events are yellow 5. None: associated events are not color-coded Description Enter the text that you want to appear on the Event listing page when this alarm occurs. Applies only to the Monitor CDR Streaming alarm type. This field determines how long CDR streaming should be monitored. NexTone recommends not setting a Duration longer than necessary, because the longer the Duration, the more CDRs have to be evaluated, which can have a net adverse effect on system performance. The RegID, Realm, and Name of the MSX of the endpoint device. Applies to traffic with this endpoint as either the source or destination as selected.
Duration (min)
Available Endpoints
153
Selected Endpoints Evaluate All Available Endpoints Individually Endpoints
Displays the endpoints you have selected from the Available Endpoints list.
Allows the user to separately query any endpoint on the database.
Allows the user to select endpoints by origination/source or termination/destination. This field describes a region, used to group one or mode dial codes. Example: BHUTAN-SATTELITE Alarms can have a region parameter configured. Only calls that belong to this region are subjected to the alarm criteria. A usage for this is to specify an alarm only for traffic to and from a certain region.
Regions
Supplier Customer Start Date
The supplier is the traffic terminator. The customer is the traffic originators. This is a time filter that identifies the date and time at which the alarm goes into effect. This is a time filter that identifies the date and time at which the alarm ceases to be in effect.
End Date
Start Week Days This is a time filter that identifies the start day(s) of the week. End Week Days Start Time This is a time filter that identifies the end day(s) of the week. This is a time filter that identifies the time to start counting/looking for alarm conditions. For a description of how start time applies to Gateway Minutes alarms, see Gateway Minutes Alarms. Alarms can have a certain time-of-day configured at which they are considered active. No actions are performed during times that fall out of the active time periods. The time-of-day configuration is flexible enough to be able to provide any combination of weekdays, and a start and end time for those selected days. This time-of-day is different from the Start Time configuration in the alarms. The Start Time is a specific calendar day/time at which the alarm starts becoming active. The time-of-day configuration provides an active day/time relative to the current absolute time End Time The point in time at which this rate ceases to be in effect. Selected from a pulldown list, the first digit of the entry is the index (Record Number) into the table on the Times page. The rest of the entry comes directly from the Times table. Currently, this field is used to specify the port usage (in percentage value) on
System Load
154
RSM System
the MSX. Alarms can have a System load parameter configured. Only if the system load is at or above the configured limit, would the alarm be considered active. The system load in this case is the number of concurrent calls on the system. A usage for this is to not trigger an alarm if the system is running at off-peak or maintenance conditions. Condition Some key names have values associated with them. This pull-down allows you to specify the comparison operator to use in conjunction with the Value field to select only those records that enable you to detect this alarm condition. Possible values are: less than less than or equal to greater than greater than or equal to
Value %
In this field you specify the numeric value relating to the comparison operator specified using the Condition pull-down. For gateway minutes reports or Error Description CDR Alarms this must be a whole number (no decimals). For ASR reports, enter only the number, without a percent sign, %.
System tab: alarm events

An event is defined as an actual occurrence of the alarm conditions you defined using the Add System Alarm page. The System Alarms Events page provides a list of the alarm events that occurred since the last time the list was manually cleared. NOTE: Events are collected in the file: /var/log/iserver.log, in plain text format, which can be viewed with a text tool.
Viewing alarm events

To view Events, follow these steps: 1. Log onto the system as described in Logging into RSM. 2. Click System> System Alarms> Events. 3. The System Alarm Events page displays. 4. Click the Prev and Next buttons if the report doesn't all fit on one screen. Note: The Alarm Events page is automatically refreshed every 60 seconds.
Fields to select alarm event data
155
Note: Date and time are displayed in the formats specified for the partition and partition user. Refer to Date and time formats for information. Fields Alarm Severity Description The severity level of the alarm. You can select None, Warning, Minor, Major, or Critical. RSM displays events only for those alarms having the severity level you specify. Specify the start date for the event. Type in a date or click the Calendar icon to select the date from a calendar. RSM selects only those events whose start date matches the date you specify. Specify an end date for the event. Type in a date or click the Calendar icon to select the date from a calendar. RSM selects only those events whose end date matches the date you specify.
Start Date
End Date
Alarm event data

Note: Date and time are displayed in the formats specified for the partition and partition user. Refer to Date and time formats for information. Field Trash can icon Description Allows you to delete the alarm event in this row. Select multiple check boxes to clear a group of alarm events.
Date Time The system date and time stamped onto the record when it was entered into the event log file. Location Specifies the line number in the iServer.log file on the MSX. This field is applicable only to Log alarms, not CDR alarms. Additional descriptive information. For log events, this is taken from the actual record in the log file; for CDR events, it is system-generated information. Defines the severity level of the alarm. The drop-down list includes the severity levels that you can define: None, Warning, Minor, Major, and Critical. When RSM creates alarm events, each event entry in the Alarm Events screen is color-coded to indicate the severity level. The following severity levels can be associated with an alarm: Critical: associated events are violet Major: associated events are red Minor: associated events are orange Warning: associated events are yellow None: associated events are not color-coded
Description The text from the Description field in the alarms definition. Details Severity
Clearing alarm events

You can clear individual alarm events or groups of alarm events using the check boxes associated with each alarm event. To clear alarm events: 1. Click the check box to the left of the alarm event for each alarm event you want to clear. Select multiple check boxes to clear groups of alarm events.
156
RSM System
2. Click Clear. WARNING: Clicking Clear removes all output information from the page. The cleared information cannot be retrieved.
157
RSM Streaming
RSM Streaming
Streaming is the RSM process by which unrated CDRs can be inserted into databases other than the one on the RSM server, or saved into flat files. One or more data streams can be set up and then named in the addStream parameter. Data sent to 3rd-party systems via streaming can also be modified and otherwise controlled. The database insert/update process is controlled from the RSM agent. Streams are configured via one XML file for each stream. Each stream sends data to one destination (database or flat file). The process by which CDR data is modified is known as a transform. In the sample XML below, you will see instances of a transform type element. T NOTE: Only DBMS is supported in MySQL. Editing the nars.lastseen File To start the editing process, Edit the "nars.lastseen" file in the /usr/local/RSMagent/ directory, enter:
/full_cdr_dir_path/cdr_file_name:cdr_line_no NOTE: This file tells the RSM agent to start streaming from the CDR file name and line number specified. The format of the file should be: Example: /vars/cdrs/D20041008.CDT:0 CAUTION: The RSM agent should only be used to send current CDRs (or current day's CDRs). Please use the cdrcatchup.pl script to send old CDRs in another stream. This way you have access to the current CDRs right after the upgrade. cdrcatchup.pl usage is described in the next section. Creating a Database Stream To stream unrated CDRs into another database other than the one on the RSM server, you must: 1. Identify and specify those fields in the RSM database you want to move to the upstream database. 2. Identify the corresponding fields on the upstream database. 3. Create the xml file for that stream. 4. Edit the .RSMcfg file to include the new stream name. Starting and Streaming CDRs with the RSM Agent 1. Start the RSM agent, enter: ./RSMagent all start 2. Make sure the RSM agent is running, enter: ./RSMagent all status For d6 or older version, you should see the following:
159
F S UID PID PPID C PRI NI 8S 0 27394
ADDR
SZ
WCHAN TTY
TIME CMD 23:36 perl TIME CMD
1 1 41 20 e6eb67e8 3940 e6d19336 ? ADDR SZ
F S UID PID PPID C PRI NI 8S 0 27402
WCHAN TTY
1 0 40 20 e819d0c0 2049 e93bfe8a ?
0:01 perl
NOTE: For version d7 or newer, the results are slightly different than above. 3. Make sure the RSM agent is sending CDRs, enter: cat RSM.lastseen; sleep 100; cat RSM.lastseen 4. Compare the line numbers of the first and second result. There should be a significant difference. The streaming speed can vary from 40 CDRs per sec to 100+ CDRs per sec Streaming CDRs Using cdrcatchup.pl The cdrcatchup.pl script can be used to send another stream of CDRs to the RSM server. Usually this is the preferred method of sending old CDRs to the RSM. In 4.0 narsagent, we have a script called "runcadrcatchup" in the agent directory. Running this script triggers the cdrcatchup.pl script. You are not required to export the perl library this way. 1. Modify the runcdrcatchup script by editing the last line of the runcdrcatchup script, enter: runcdrcatchup -s /full_cdr_dir_path/start_cdr_file_name:start_line_no -e /full_cdr_dir_path/end_cdr_file_name:end_line_no > /tmp/cdrcatchup.log

nohup is used to prevent the cdrcatchup from abort when the SSH session expires the "-s" option specifies the start cdr file and line number the "-e" option specifies the end cdr file and line number
Example: nohup perl cdrcatchup.pl -s /var/cdrs/D20041001.CDR:1 -e /var/cdrs/D20041001.CDR:1000 > /tmp/cdrcatchup.log 2. Run the cdrcatchup.pl script. You run cdrcatchup.pl by running the runcdrcatchup, enter: ./runcdrcatchup & 3. "&" run the script in the background Backing up RSM Database Use the following mysqldump commands from shell to backup the RSM database. NOTE:This doesn't backup the CDRs. mysqldump -ect bn actions mysqldump -ect bn alarms > actions.sql > alarms .sql
mysqldump -ect bn carrierplans > carrierplans sql mysqldump -ect bn endpoints > endpoints sql
160
RSM Streaming
mysqldump -ect bn events mysqldump -ect bn groups mysqldump -ect bn license mysqldump -ect bn periods mysqldump -ect bn plans mysqldump -ect bn regions mysqldump -ect bn routes mysqldump -ect bn users
> events .sql > groups .sql > license.sql > periods.sql > plans .sql > regions.sql > routes .sql > users .sql
The above assumes that the MySQL root password is empty. If not, use the following syntax: mysqldump -ect -u root -pPASSWORD bn actions Sample XML Streaming Setup File Below is an example of a stream-defining XML file for a database stream. The subsection following the sample details the differences for a flat-file stream. You may find this example useful for reference when reading the sections that follow, which discuss the elements of the NARS streaming XML. Each XML file is located on the session controller machine, where the rest of the NARS configuration files are, in /usr/local/RSMagent. While the actual file name is whatever the administrator wants it to be, choosing a name that makes sense to someone else can be helpful during setup and troubleshooting. The filename is then entered in the RSM.cfg file at that files addStreams parameter. <?xml version="1.0" encoding="utf-8" ?> <stream>  <db dbtype="mysql" dbname="RSM2" dbtable="nextone" dbhost="127.0.0.1" dbuser="root" dbpass="" />  <CDR>  <field no="1" name="start-time" fmt="string">  </field> <field no="2" name="start-time" fmt="uint32"> > actions.sql
161
<transform type="date" format="%T %Z %a %b %e %Y" zone="UTC" outname="ConnectTime" /> <transform type="date" format="%Y%m%d%H%M%S" outname="CreationDate" /> </field> <field no="3" name="call-duration" fmt="HH:MM:SS"/> <field no="4" name="call-source" fmt="A.B.C.D"> <transform type="keep" outname="RemoteGateway" /> </field> <field no="5" name="call-source-q931sig-port" fmt="uint32"/> <field no="6" name="call-dest" fmt="A.B.C.D"> <transform type="keep" outname="NASIPAddress" /> </field> <field no="7"/> <field no="8" name="call-source-custid" fmt="string"/> <field no="9" name="called-party-on-dest" fmt="string"> <transform type="keep" outname="CalledStationId" /> </field> <field no="10" name="called-party-from-src" fmt="string"/> <field no="11" name="call-type" fmt="{ IF|IV }"/> <field no="12"/> <field no="13" name="disconnect-error-type" fmt="{A|B|N|E}"/> <field no="14" name="call-error" fmt="uint32"/> <field no="15" name="call-error" fmt="string"/> <field no="16"/> <field no="17"/> <field no="18" name="ani" fmt="string"/> <field no="19"/> <field no="20"/> <field no="21"/> <field no="22" name="cdr-seq-no" fmt="uint32"/> <field no="23"/>
162
RSM Streaming
<field no="24" name="callid" fmt="string"> <transform type="keep" outname="InConfId" /> <transform type="keep" unique="true" outname="SessionId" /> </field> <field no="25" name="call-hold-time" fmt="HH:MM:SS"> <transform type="time" value="min" format="%5.2f" outname="HoldTimeInMin" /> </field> <field no="26" name="call-source-regid" fmt="string"/> <field no="27" name="call-source-uport" fmt="uint32"/> <field no="28" name="call-dest-regid" fmt="string"/> <field no="29" name="call-dest-uport" fmt="uint32"/> <field no="30" name="isdn-cause-code" fmt="uint32"> <transform type="keep" outname="DisconnectCause" /> </field> <field no="31" name="called-party-after-src-calling-plan" fmt="string"/> <field no="32" name="call-error-dest" fmt="uint32"/> <field no="33" name="call-error-dest" fmt="string"/> <field no="34" name="call-error-event-str" fmt="string#string"/> <field no="35" name="new-ani" fmt="string"/> <field no="36" name="call-duration" fmt="uint32"> <transform type="keep" outname="SessionTime" /> <transform type="expr" matchkey="K" value="K/1000" format="%5.3f" outname="DurationInK" /> </field> <field no="37" name="incoming-leg-callid" fmt="string"/> <field no="38" name="protocol" fmt="{sip|h323}"/> <field no="39" name="cdr-type" fmt="{start1|start2|end1|end2|hunt}"/> <field no="40" name="hunting-attempts" fmt="uint32"/> <field no="41" name="caller-trunk-group" fmt="string"> <transform type="condition" ifempty="6" outname="Destination" /> </field>
163
<field no="42" name="call-pdd" fmt="uint32"/> <field no="43" name="h323-dest-ras-error" fmt="uint32"/> <field no="44" name="h323-dest-h225-error" fmt="uint32"/> <field no="45" name="sip-dest-respcode" fmt="uint32"/>  <field type="constant" value="answer" outname="CallOrigin" /> <field type="constant" value="VOIP" outname="CallType" /> <field type="variable" value="CDRFILE" outname="SrcFile" /> <field type="variable" value="CDRLINE" outname="SrcLine" /> <field type="variable" value="iServerID" outname="iServerId" /> <field type="variable" value="DATETIME" format="%Y-%m-%d %H:%M:%S" outname="InsertionTime" /> </CDR> </stream> Flat-file Streaming Considerations The above sample XML code is for a database stream. This same XML could be used for streaming to a flat file, by incorporating the following alterations: The <db ... /> element near the top might instead read: <file dir="/dest/dir" separator="%" prefix="NA-" suffix=".CDP" />. For details on the fields in this element, see Table 51 on page 236. The code must contain a line with the following: <field type="constant" value="CDRFILE" outname="SrcFile" /> This line ensures that for each input CDR file, a corresponding output file is created (with the configured prefix and suffix). Below the <CDR> block, the code must contain a new OUTPUT block, constructed as shown in this example: <OUTPUT> <field no="1" name="MswId"/> <field no="2" name="Empty"/> <field no="3" name="ANI"/> <field no="4" name="Empty"/> <field no="5" name="Empty"/>
164
RSM Streaming
<field no="6" name="IncomingRoute" separator="/"> <subfield no="1" name="SrcIP" /> <subfield no="2" name="SrcPort" /> </field> <field no="7" name="CallDate"/> <field no="8" name="CallDuration"/> </OUTPUT> Sample Streamed Flat-File Below is a sample of data streamed to a flat file. Note the percent sign (%) field separators between fields (as defined in the example file element), and the virgule (slash character, /) between the subfields of the IncomingRoute field (e.g., 10.0.0.3/0), as defined in the output block. Two contiguous separators (%%) indicate a blank field. 0000bead%%011914275988863%%%10.0.0.3/0%2004-01-26 16:33:26%000:09:31 0000bead%%01191448651389%%%10.0.0.5/0%2004-01-26 15:47:33%000:55:25 0000bead%%011914273001955%%%10.0.0.3/0%2004-01-26 16:29:37%000:13:23 0000bead%%01191448849509%%%10.0.0.5/0%2004-01-26 15:43:34%000:59:27 0000bead%%011914220141981%%%10.0.0.4/0%2004-01-26 16:08:55%000:34:07 0000bead%%011444294967295%%%10.0.0.1/0%2004-01-26 16:10:31%000:32:32 0000bead%%011914224016535%%%10.0.0.4/0%2004-01-26 16:00:27%000:42:37 0000bead%%01191445528781%%%10.0.0.5/0%2004-01-26 16:42:44%000:00:21 0000bead%%011443530810844%%%10.0.0.1/0%2004-01-26 16:08:52%000:34:14 XML Elements This table lists the XML definition elements of the above example, and explains the RSM streaming functions support of each.
Element Name
Description Destination Database Elements (applies only to database streams)
dbtype dbname dbtable
Always mysql, this is the type of the destination database. The name of the destination database. The name of the table in the dbname database to which the streamed data is sent.
165
dbhost replace
The IP address of the machine to which the stream is sent. If the stream contains a field with a transform having a unique=true element in it (as field no 24 in the example), and this replace element is also set to true, records streamed with that field already existing are replaced in the destination database by the streamed record. The username used to log into the streaming destination database. The password for the user account named in dbuser. Destination File Elements (applies only to flat-file streams)
dbuser dbpass
dir separator
The complete path to the directory where the file will be created. The field-separator character that will be used in the created file, such as a colon or semicolon. (optional) One or more characters prepended to the name of the CDR file being processed, to obtain the destination file name. (optional) One or more characters appended to the destination file name to indicate its file type. Output Block Elements
prefix
suffix
name
The name component of the name:value pair that will be written to the output file. Note that this value must match the outname specified in any transforms used in flat-file streaming. Identifies a field within a field. In this example, ScrIP and SrcPort are subfields of the IncomingRoute field. Note that the value of the name parameter for this element must also match the transform outname. As with fields, subfields are written to the output file in the order indicated by the no= parameter The character NARS inserts between the subfields comprising the higher-level field. Field Elements (applies to all streams)
subfield
separator
field no
The number of the field within the source CDR according to the session controllers CDR definition. The CDR field name according to the session controllers CDR definition. The column name for this field in the remote database or flat file Defines the format of the field to which this transform applies; if the data in the field doesnt match this format, the transform is not applied
name
outname fmt
166
RSM Streaming
and/or the field is omitted from the stream. For example, uint32 would restrict application of this transform to values of a 32-bit unsigned integer. If multiple values are listed in curly braces, { }, separated by the or character, |, only these values are permitted for this field; other values are ignored. transform type The type of data transformation being performed; see Transform Types, on page 238 for details. Used with the date and time transforms, specifies the format of data to be written to the destination database If the transform type is date, the rules for this fields contents are found in man strftime If the transform type is time, the rules for this fields contents are found in man printf. unique /field This column is a unique key in the destination database This element by itself ends the field definition for a field with a transform nested within it. This element allows you to specify an unchanging value for a field that doesnt exist in the CDR, and send that value in every streamed record. This element allows you to send certain NARS values in every streamed record, useful when streaming data to one database from multiple session controllers, for example, where the variable could contain the name of the session controller host machine. Valid values for this are: CDRFILE, the name of the file containing the CDRs being streamed CDRLINE, the line number of that CDR in the CDR source file MSWID, the name of the session controller DATETIME, the system timestamp when the record was streamed
format
field type= constan
field type= variable
167
RSM Administration
RSM Administration
This section provides procedures for system administrators to use. The category of work covered here is broadly known as Operations, Administration and Maintenance, or OA&M.
System startup
Normally, during a system startup, the processes that comprise the RSM system will be started, as programmed in the startup files. To manually start the server, enter: /etc/init.d/jboss start /etc/init.d/mysql stop/start
System shutdown
To stop the server before shutting down the platform on which the server is running, enter: /etc/init.d/jboss stop
System backup
In order to do a system backup, you must stop jboss just as in the system shutdown above.
Displaying software versions

To see what versions of software are actually running on the RSM system, left click on the RSM Powered by NexTone logo on any RSM page once you are logged in. A pop-up lists the installed system components with the version number for each. Below is an example of an installed system components listing. RSM 4.0c1-6 Mysql 4.1.7-standard Java HotSpot(TM) Server VM 1.4.2_02-b03 Apache Tomcat/5.0.28 RSM 4.0c1-6 Mysql 4.1.7-standard Java HotSpot(TM) Server VM 1.4.2_02-b03 Apache Tomcat/5.0.28
Abnormal OA&M procedures

Contact NexTone support for assistance and/or procedures to follow in the event of an abnormal situation, such as: System recovery following a (disk drive failure, unexpected power loss, etc.) Backup restoration after a (database corruption, system file deletion, etc.) Troubleshooting scenarios
169
See Configuration.
Other administrative tools

The RSM system provides some command-line tools for administrators to use occasionally to handle special situations connected with the RSM agent component. These are detailed in this section. To use these tools, the administrator must be logged in as root to the session controller platform on which the RSM agent software is running. For information on logging into the session controller, consult the NexTone iServer (MSX) Installation Guide and the NexTone iServer (MSX) Operations Guide. These tools are located in the session controllers /usr/local/RSMagent directory. The procedures that follow assume that this is the administrators present working directory. Sending or re-sending CDR files At times it may be necessary to send (and rate, as appropriate) one or more existing CDR files that were never sent to the RSM server. This can happen for various reasons, such as a new RSM system being added to an existing iServer installation. With cdrcatchup.pl, you can send to the server CDRs created prior to installation of the RSM system. If the RSM agent is configured to rate CDRs, they will also be rated. Synopsis: cdrcatchup.pl [-c config_file] <-s start_file[:line]> <-e end_file[:line]> [-d debuglevel] Options: -c config_file Specifies that a RSM configuration file other than the standard /usr/local/RSMagent/RSM.cfg file will be used when running this command. Enter the files complete path and name. Files are processed according to the timestamps on the start_file and the end_file. The -s and -e options are required, but line numbers for them are optional. -s start_file[:line] A file to begin processing from, with an optional line number within the file. -e end_file[:line] The file at which to stop processing, with an optional line number within the file. -d debug_level A range from 0 (no debug) to 7 (verbose). If this option is not specified, the debug level defaults to verbose mode (7). Deleting stored CDRs cdrdel is used to remove CDRs from the RSM database. It can be used as a stand-alone command, but more commonly it is run as a Linux crontab scheduled task. If necessary, edit the crontab file (use crontab -e) to add an entry for cdrdel (or change an existing entry), to schedule the task. See man crontab for details on how to set up a cron task.
170
RSM Administration
Next, edit the script /usr/local/RSMagent/cdrdel to set the values of some parameter variables, as necessary. An example of the block of code in cdrdel is: old=60; limit=50000; host=localhost; user=root; pass=''; mintime=150; factor=1; The above parameters break down as follows: old = the number of days worth of CDRs to retain in the database limit = the maximum number of CDRs to delete in each attempt host = the mysql server host user = the mysql username pass = the mysql password mintime = the minimum number of seconds for the script to sleep before attempting to run again. factor = used to calculate the script sleep time. It the previous execution took n minutes, then the script sleeps for n * factor minutes, but at least mintime (if mintime > n * factor) before executing the script again. Acceptable values are 1 or 2. Each time this script runs, it deletes CDRs older than old days, with each attempt deleting a maximum of limit number of CDRs, and the interval between each attempt being at least mintime seconds. Once the target is achieved, it exits. The purpose of the limit parameter is to minimize performance impact when there are large numbers of CDRs to delete. It effectively breaks the processing up into smaller chunks. Agent process assurance The RSMpm tool checks for the existence of the RSM agent processes, and starts the agent if it is not already running. It can be used as a stand-alone command, but more commonly it is run as a Linux crontab scheduled task. If necessary, edit the crontab file (use crontab -e) to add an entry for cdrdel (or change an existing entry), to schedule the task. See man crontab for details on how to set up a cron task. Synopsis: RSMpm Options: (none) Selective rating With the rateone.pl tool, you can re-rate a single CDR (the -r option) or a range of CDRs matching SQL filter criteria (the -s option), in RSM database. Single-CDR rating mode can be useful when troubleshoot rating problems. All debug outputs from the rating attempt are placed in /tmp/RSMone.log. Records rated with rateone.pl remain in the RSM database. This tool runs from this directory on the iServer switch. Synopsis:
171
rateone.pl [-r recordnum] [-s SQL_statement] Options: One option, and only one, either -r or -s is required. -r recordnum Specifies one record number to attempt to rate -s SQL_statement SQL_statement is the WHERE clause of the final SQL statement of the database query. Common usage is when a new endpoint is added into the rating table (carrierplans table), but the endpoint has been creating CDRs for some time in the past. Then one could use -s Orig_IP = '10.0.0.1' (with the appropriate IP address, of course) as the option to rate all entries from the cdrs table for the originating endpoint at that IP address. Some common RSM database fields that might be used with this command are listed in Table 54.
Some common RSM database fields

Field Name date_time Description The date and time stamp on a CDR The regid of the originating gateway The regid of the terminating gateway Format
a
Supported Relationships >, <, =
'2006-01-11 00:00:00'
orig_gw
alphanumeric, up to 24 chars. alphanumeric, up to 24 chars
=, like
term_gw
=, like
orig_ip
The IP address of the originating nnn.nnn.nnn.nnn gateway The IP address of the terminating nnn.nnn.nnn.nnn gateway A port number on the originating gateway integer
=, like
term_ip
=, like
orig_port
>, <, =
term_port
A port number on the terminating integer gateway
>, <, =
Be sure to surround values with single quotes (where indicated), since those values contain non-alpha characters. Note: The SQL wildcard character, %, is also supported. For example, orig_gw like Mexico-% would match (and therefore rate) all regids beginning with Mexico-.
Performing database administration tasks

The following are some of the database administration tasks that the RSM DBA needs to perform when necessary for disaster prevention or recovery. They include: 172
RSM Administration
Backing up an entire database Backing up and restoring one or more tables within a database A utility for dumping the contents of a database in a format that includes SQL statements for re-creating the database Note: To perform these procedures, you must be logged into the RSM server using Telnet or SSH, not a browser. The information given here is the minimum required to perform the operation; details on each command, along with when and how to use it, can be found in the on-line manuals on the MySQL web site. NOTE: Backup data is dumped to a flat file; you must have OS-level permission to write to this file.
Full database backup

Periodic backups should be made of the complete database, with all its tables, indexes, structure, etc., for recovery in the event of a complete loss of the databases integrity. For this purpose, MySQL recommends the following procedure: Log onto the RSM server using the root account, or another account with administrative privileges. Decide on a destination location for the backup. Create a new directory if necessary. NOTE: The flat file resulting flat file can be very large, so be sure to provide enough space in your partition for it! At the system prompt, enter: mysqldump -A -a -x -F [-u=username [-p[=passwd]] ] RSM > backup_file_path where: -A = all databases -a = all database create options -x = lock all tables -F = flush logs before starting dump -u = use this username (optional) -p = and this password (or prompt) RSM = the database name backup_file_path is the full path to the flat file into which the databases contents will be placed, including the filename. This command dumps all databases under the mysql server into a flat text file. For something other than this operation, see Database or Table Dump, below. A complete description of the process of backing up full databases is available on the MySQL web site at http://www.mysql.com/doc/en/Backup.html.
173
Backing up individual tables

There may be times when you need to back up the contents of a one or more individual tables, rather than the entire database. In those cases, MySQLs backup table command is used. Its syntax is: backup table tbl_name[,tbl_name...] to backup_directory_path Before executing the backup table command, you must enter the mysql environment, and type use RSM. A complete description of the process of backing up tables is available on the MySQL web site.
Restoring individual tables

If you have backed up one or more individual tables, at times you may want to restore that tables contents, rather than restoring the entire database. MySQLs restore table command is used for this. Its syntax is: restore table tbl_name[,tbl_name...] from backup_directory_path A complete description of the process of restoring tables is available on the MySQL web site.
Database or table dump

MySQL also provides a utility program by which an entire database or part of it can be dumped to flat files for transferring data to another SQL database. (Its the same utility used in Full Database Backup, above, but with different options.) This utility is suited to transferring data to another SQL database, not necessarily MySQL. It is the same mysqldump command used above for the full database backup. The generic syntax for this command is: mysqldump [OPTIONS] database [tables] Several variations on this command are available to suit the resulting dump to your need. Details on this command, its options, and process are available on the MySQL web site at http://www.mysql.com/doc/en/mysqldump.html.
174

RSM 4.3 Og

Hochgeladen von

Dokumentinformationen

Originaltitel

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

RSM 4.3 Og

Hochgeladen von

Copyright:

Verfügbare Formate

NexTone RSM (Real-time Session Manager)

2. Understanding the RSM user interface ________________________________________ 7

3. RSM Reporting ___________________________________________________________ 15

4.3 RSM Operations Guide

5. RSM Provisioning ________________________________________________________ 67

4.3 RSM Operations Guide

6. Launching RSM Console__________________________________________________ 109

7. RSM System ____________________________________________________________ 111

4.3 RSM Operations Guide

8. RSM Streaming__________________________________________________________ 159

9. RSM Administration ______________________________________________________ 169

4.3 RSM Operations Guide

Who should use this guide

What Documentation Is Required

MySQL 5.0 Reference Manual

4.3 RSM Operations Guide

Contacting Customer Support

RAM: Route Analysis Module (standard)

ESM: Events and Statistics Module (optional)

Actions that may be taken include:

4.3 RSM Operations Guide

ARM: Adaptive Routing Module (optional)

BAM: Business Analysis Module (optional)

WIM: Web Interface Module (optional)

OSP: Over Subscription Module

QoS: Quality of Service Module

Selecting time zones

4.3 RSM Operations Guide

Understanding the RSM user interface

4.3 RSM Operations Guide

Working with RSM

Verifying the version number

Working with the main RSM window

Understanding the RSM user interface

the RSM dialogs/windows.

Top-level Menu area Menu area Action area Content area

Top-Level Menu area

4.3 RSM Operations Guide

Understanding the RSM user interface

Date and time formats

4.3 RSM Operations Guide

Example 13:59:59 01:59:59 PM 13:59 01:59 PM

Understanding the RSM user interface

The following are the currencies supported:

4.3 RSM Operations Guide

Tugrik Naira Nuevos Sole

4.3 RSM Operations Guide

4.3 RSM Operations Guide

Searching using wildcards

Reports available in RSM

Displaying the Engineering report

4.3 RSM Operations Guide

Clearing the Engineering report

Emailing and saving Engineering reports

HTML XML CSV Text

4.3 RSM Operations Guide

Saving a new Filter

Types of ASR reports

ASR by Source Reg ID

and port number.

ASR by Customer ASR by Day

Field Descriptions for ASR by Source IP report

Minutes Avg PDD (msec) Avg DUR