RSM 4.2-1 Og

BN-RSM-4.
2-1-OG-1
Real-time Session Manager (RSM)

Operations Guide
Release 4.2, Issue 1
July 21, 2006
101 Orchard Ridge Drive, Suite 300

Gaithersburg, MD 20878, USA
7/21/06
Copyright 2002-2006 NexTone Communications

All rights reserved. This publication and its contents are proprietary to NexTone Communications. No part of this publication may be reproduced, distributed or modified in any
form or by any means without the written permission of NexTone Communications, 101
Orchard Ridge Drive, Suite 300, Gaithersburg, MD 20878.
US Patents and Patents Pending.
The information in this document is subject to change without notice. NexTone Communications makes no warranty of any kind with regard to this material, including, but not
limited to, the implied warranties of merchantability and fitness for a particular purpose.
Trademarks
NexTone, NexTone iServer, NexTone MSW, NexTone MSC, NexTone NARS, NexTone
iView and NexTone RSM all are trademarks of NexTone Communications, Inc. Other
trademarks, marks, names, or product names referenced in this publication are the property of their respective owners, and NexTone Communications neither endorses nor sponsors any such products or services referred to herein.
Document Revision History
Release and Revision Number
Date
Description of Changes
Release 4.2, Beta
06/09/2006
Incorporated Release 4.2 features.
Release 4.2, 1
07/21/2006
Incorporated Release 4.2 features.
2006 and NexTone Communications, Inc. Proprietary
7/21/06
TABLE OF CONTENTS
CHAPTER 1: PREFACE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Who Should Use This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Assumptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Document Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Contacting NexTone Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Sample GUI Pages Provided in this Book . . . . . . . . . . . . . . . . . . . . . . 4
CHAPTER 2: NEW FEATURES . . . . . . . . . . . . . . . . . . . . . . . . . 1

WHATS IN THIS CHAPTER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
NEW FEATURES IN RELEASE 4.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Alarm Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
ADD CDR ALARM PAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Audit Trail Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

CDR Validation and Logging Feature . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Diagnostic and Debug Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
New iView Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
RSM and MSX Database Synchronization Feature . . . . . . . . . . . . . . 3
License Control Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Logger Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Rating and Routes Generation Feature . . . . . . . . . . . . . . . . . . . . . . . . 4
RSM Operations Guide
7/21/06
<< Table of Contents >>
System Alarms Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

User Interface Customization Feature . . . . . . . . . . . . . . . . . . . . . . . . . 4
Web Services Interface Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
CHAPTER 3: INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . . . . 6
VOIP TELEPHONY AND RSM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
HIGH-LEVEL VIEW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
RSM COMPONENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Server-Side Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
RAM: THE ROUTE ANALYSIS MODULE (STANDARD) . . . . . . . . . . . . . . . . . 8
ESM: THE EVENTS AND STATISTICS MODULE (OPTIONAL) . . . . . . . . . . . . . 8
ARM: THE ADAPTIVE ROUTING MODULE (OPTIONAL) . . . . . . . . . . . . . . . . 9
BAM: THE BUSINESS ANALYSIS MODULE (OPTIONAL) . . . . . . . . . . . . . . . . 9
WIM: THE WEB INTERFACE MODULE (OPTIONAL) . . . . . . . . . . . . . . . . . . . 9
Agent-side Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
CDRSERVER
HTTP POST
LOGPP
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
License File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
COMPONENT LICENSING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
RSM RATING FEATURES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
COMMON RSM SYSTEM OPERATIONS . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Logging into the RSM System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Login Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Logging out of RSM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
7/21/06
WINDOW STRUCTURE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
WINDOW STRUCTURE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
TOP LEVEL MENU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
MENU AREA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
ACTION AREA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
CONTENT AREA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
VERIFYING THE CURRENT VERSION . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Multiple Items in a List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Selecting Dates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Selecting Time Zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
CHAPTER 4: RSM PLATFORM DESCRIPTION . . . . . . . . . . . . . 22

INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
PLATFORM SOFTWARE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
RSM System Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
RSM System Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
MEMORY REQUIREMENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
DISK STORAGE REQUIREMENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
REQUIRED SOFTWARE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
RSM Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
RSM System Agent Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Client Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
CHAPTER 5: RSM REPORTING . . . . . . . . . . . . . . . . . . . . . . . 25

INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
REPORTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
7/21/06
Report Dates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Search Wildcards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Reports Available . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Customizable Chromocode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Requesting Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
ENGINEERING REPORTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
FIELD DESCRIPTIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Obtaining Engineering Report Details . . . . . . . . . . . . . . . . . . . . . . . . 31

Types of Engineering Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
NEW FILTER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
SETTING A FILTER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
DELETING A FILTER. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
BUSINESS REPORTS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Accessing the Business Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
CLEARING THE BUSINESS REPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Types of Business Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

LISTING OF BUSINESS REPORTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
ROUTE PROFITABILITY REPORTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

CLEARING THE ROUTEPROFIT REPORT . . . . . . . . . . . . . . . . . . . . . . . . . . 43
VIEWING THE ROUTE PROFIT CONTENT AREA . . . . . . . . . . . . . . . . . . . . . 44
CUSTOM REPORTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
CLEARING THE CUSTOM REPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Obtaining Custom Report Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

SVGViewer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
7/21/06
The Unrated CDRs Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

REQUESTING THE UNRATED CDRS REPORT . . . . . . . . . . . . . . . . . . . . . . . 54
CHAPTER 6: RSM ALARMING . . . . . . . . . . . . . . . . . . . . . . . . 56

INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Defining Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
New Alarm Features in RSM 4.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
ADMINISTERING RSM ALARMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Alarm Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
ALARM EVENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Clearing the Alarms Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
CDR Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Adding a New CDR Alarm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
UPDATING A CDR ALARM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
DELETING A ALARM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
LOG ALARMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Accessing the Log Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
ADDING A NEW LOG ALARM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
UPDATING LOG ALARMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
DELETING A ALARM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
ALARM ACTIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
ACTION TYPES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
ADDING A NEW ACTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
UPDATING AN ACTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
DELETING AN ACTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
7/21/06
CHAPTER 7: RSM SYSTEM . . . . . . . . . . . . . . . . . . . . . . . . . . 88

INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Accessing the System Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
CONFIGURATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Accessing the Configuration Home Page. . . . . . . . . . . . . . . . . . . . . . 91
LOGGING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Accessing the Logging Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . 95
STATUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Accessing the Status Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Viewing Status CDRs Content Page. . . . . . . . . . . . . . . . . . . . . . . . . 101
LICENSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Accessing the License Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Updating a License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
BRANDING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Accessing Branding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
ADDING A BANNER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
UPDATING THE BANNER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
REMOVING A BANNER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
DEVICES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Accessing the Devices Home Page . . . . . . . . . . . . . . . . . . . . . . . . . 106
Adding a Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Updating a Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Deleting a Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
PARTITIONING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
7/21/06
ACCESSING THE PARTITIONS PAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

ADDING A PARTITION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
CAPABILITIES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
UPDATING THE GROUP BASED STYLESHEET (SYSTEM ADMINISTRATOR ONLY)
121
UPDATING A PARTITION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
SysAdmin User Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
ADDING A NEW USER ACCOUNT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
UPDATING A USER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
DELETING A USER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Access List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

ADDING A ACCESS LIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Viewing Content Page Information . . . . . . . . . . . . . . . . . . . . . . . . . . 136

DELETING A ACCESS LIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
ARCHIVER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Archiving CDRs and Provisional Data . . . . . . . . . . . . . . . . . . . . . . . 138
Adding an Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Deleting a Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
AUDIT TRAIL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Accessing the Audit Trail Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Clearing Audit Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Viewing Audit Details Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
CALL DATA RECORD (CDR) IMPORT/EXPORT . . . . . . . . . . . . . . . . . . . 147

REQUIRED DIRECTORIES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Configuration of CDR Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
7/21/06
Adding a CDR Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

Creating a Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Removing a Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Modifying a Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Creating a CDR Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
NEW EXPORT STREAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
ADVANCED CONFIGURATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Setting Collector Agent Parameters . . . . . . . . . . . . . . . . . . . . . . . . . 160
CDR ERRORS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

CDR RECEPTOR MODULE (CRM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
CDR VALIDATION. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
CDR LOGGING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
RE-IMPORT OF CDRS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
USER INPUT AND OUTPUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
ACCESSING THE RE-IMPORT CDRS . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
SYNCHRONIZATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Database Manual Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Out of Sync Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Out of Sync Detection Mechanism . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Database Audit/Auto Synchronization . . . . . . . . . . . . . . . . . . . . . . . 165
DB Schemas Synchronization between RSM and MSX. . . . . . . . . 166
Accessing Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
RSMLite Specific Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . 169
SYSTEM ALARMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

Accessing the System Alarms Home Page . . . . . . . . . . . . . . . . . . . 170
7/21/06
Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
CLEARING ALARM EVENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Creating Actions for System Alarms . . . . . . . . . . . . . . . . . . . . . . . . . 172

ACCESSING ACTIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
ADDING AN ACTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
UPDATING AN ACTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
DELETING AN ACTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
CHAPTER 8: RSM PROVISIONING . . . . . . . . . . . . . . . . . . . . 177

INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
RATING OVERVIEW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Provisioning Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
RATING OPTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

Rates Summary Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
RATES SUMMARY CONTENT LEVEL . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
REGIONS SUMMARY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

Regions Summary Content Level . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
RATING TABLES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Accessing the Rating Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Rates and Routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
ACCESSING THE RATES AND ROUTES . . . . . . . . . . . . . . . . . . . . . . . . . . 191
VIEWING RATES AND ROUTES CONTENT DETAILS . . . . . . . . . . . . . . . . . 193
Routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
ACCESSING ROUTES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

Accessing the Route Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
7/21/06
VIEWING SPECIFIC ROUTE CONTENT . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

ADDING A NEW ROUTE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
UPDATING A ROUTE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
DELETING A ROUTE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Automatic Number Identification (ANI) . . . . . . . . . . . . . . . . . . . . . . . 202

ADDING AN ANI PREFIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Rates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
ACCESSING RATES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
VIEWING RATE CONTENT PAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
ADDING A NEW RATE PLAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
UPDATING AN EXISTING RATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
DELETING AN EXISTING RATE PLAN . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Regions Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

ACCESSING THE REGIONS HOME PAGE . . . . . . . . . . . . . . . . . . . . . . . . . 208
VIEWING SPECIFIC REGION CONTENT . . . . . . . . . . . . . . . . . . . . . . . . . . 209
ADDING A NEW CALLING REGION . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Updating a Region . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

DELETING A DIAL CODE FOR AN EXISTING REGION . . . . . . . . . . . . . . . . 213
Periods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
VIEWING DETAILS FOR A SPECIFIC PERIOD . . . . . . . . . . . . . . . . . . . . . . 215
ADDING A NEW PERIOD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
UPDATING PERIODS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
DELETING A PERIOD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
IMPORT FORMAT HELP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Rerate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Trace Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
10
7/21/06
ACCESSING TRACE RATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
ROUTING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Accessing LCR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
VIEWING SPECIFIC LCR CONTENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
UPDATING THE LCR PRIORITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
UPDATING A DEVICE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Most Profit Routing (MPR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

ACCESSING MPR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
VIEWING CONTENT FOR A SPECIFIC MPR . . . . . . . . . . . . . . . . . . . . . . . 235
LAUNCHING RSM CONSOLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

RSM Console Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
WARNING MESSAGE WORKAROUND . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Setting Session Limits on Calls by Endpoints . . . . . . . . . . . . . . . . . 240

iEdge Group (IGRP) Limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
ACCESSING THE IEDGE GROUP UTILITY . . . . . . . . . . . . . . . . . . . . . . . . 241
MENU OPTIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
ADDING AN IEDGE GROUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
MODIFYING AN IEDGE GROUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
DELETING AN IEDGE GROUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
CLOSING THE IEDGE GROUPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Subnet CAC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

NEW ENTITY. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
CREATING A NEW IEDGE POLICY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
CLI COMMANDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Creating Subnet Based CAC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

ADDING A NEW POLICY OBJECT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
11
7/21/06
MODIFYING A POLICY OBJECT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

IEDGE
GROUP PARAMETERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
CHAPTER 9: RSM STREAMING . . . . . . . . . . . . . . . . . . . . . . 255

INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Editing the nars.lastseen File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Creating a Database Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Starting and Streaming CDRs with the RSM Agent . . . . . . . . . . . . 256
Streaming CDRs Using cdrcatchup.pl . . . . . . . . . . . . . . . . . . . . . . . 256
Backing-up RSM Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
SAMPLE XML STREAMING SETUP FILE . . . . . . . . . . . . . . . . . . . . . . . . . 258

Flat-file Streaming Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . 260
SAMPLE STREAMED FLAT-FILE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
XML Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

Transform Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
12
7/21/06
APPENDIX A: SELECTED DATABASE OPERATIONS . . . . . . . . A-1

APPENDIX B: CLI COMMANDS . . . . . . . . . . . . . . . . . . . . . . . B-1
APPENDIX C: CLI SCRIPTS . . . . . . . . . . . . . . . . . . . . . . . . . C-1
APPENDIX D: RSM ADMINISTRATION . . . . . . . . . . . . . . . . . . D-1
APPENDIX E: GENCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-1
APPENDIX F: CDR TRIM INFORMATION . . . . . . . . . . . . . . . . F-1
APPENDIX G: GENEP INFORMATION . . . . . . . . . . . . . . . . . . G-1
APPENDIX H: GLOSSARY. . . . . . . . . . . . . . . . . . . . . . . . . . . H-1
13
7/21/06
LIST OF TABLES
Table 1. Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Table 1. Types of Engineering Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Table 2. List of Business Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Table 3. Alarming Tab Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Table 4. Alarm Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Table 5. Action Types Listing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Table 6. System Tab Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Table 7. Admin and Non-Admin User Capabilities . . . . . . . . . . . . . . . . . . . . . 127
Table 8. Provisioning Tab Menus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Table 9. Rating Tables Data Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Table 10. Streaming XML Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Table 11. Streaming Transform Types and Elements . . . . . . . . . . . . . . . . . . . 264
Table 12. Command Line Arguments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-3
Table 13. Some Common RSM Database Fields . . . . . . . . . . . . . . . . . . . . . . D-6
2006 and NexTone Communications, Inc. Proprietary.
7/21/06
LIST OF FIGURES
Figure 1. Security Alert Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Figure 2. Certificate Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Figure 3. Welcome to RSM Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Figure 4. Engineering Reports Page Example . . . . . . . . . . . . . . . . . . . . . . . . . 14
Figure 5. Logout Link Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Figure 6. Engineering Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Figure 7. Top Level Menu Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Figure 8. Menu Area Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Figure 9. Action Area Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Figure 10. Content Area Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Figure 11. Version Number Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Figure 12. Date Selection Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Figure 13. Engineering Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . . 28
Figure 14. Engineering Report Content Area Example . . . . . . . . . . . . . . . . . . 31
Figure 15. Engineering ASR Graph Example. . . . . . . . . . . . . . . . . . . . . . . . . . 32
Figure 16. Saved Filters Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Figure 17. Saved Filters Dialog Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Figure 18. Delete Filter Dialog Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Figure 19. Business Report Main Page Example. . . . . . . . . . . . . . . . . . . . . . . 36
, Issue 2
7/21/06
<< List of Figures >>
Figure 20. Business Report Content Page Example . . . . . . . . . . . . . . . . . . . . 37

Figure 21. Route Profitability Report Example . . . . . . . . . . . . . . . . . . . . . . . . . 42
Figure 22. Route Profit Content Page Example . . . . . . . . . . . . . . . . . . . . . . . . 45
Figure 23. Route Profit Printable View Example . . . . . . . . . . . . . . . . . . . . . . . 45
Figure 24. Custom Report Home Page Example. . . . . . . . . . . . . . . . . . . . . . . 47
Figure 25. Custom Report Content Page Example . . . . . . . . . . . . . . . . . . . . . 48
Figure 26. SVGViewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Figure 27. Alarm Events Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . 64
Figure 28. CDR Alarms Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Figure 29. Add CDR Alarm Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Figure 30. Update CDR Alarm Page Example (Partial View). . . . . . . . . . . . . . 75
Figure 31. Delete Alarm Dialog Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Figure 32. Log Alarms Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Figure 33. Add Log Alarm Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Figure 34. Update Log Alarm Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Figure 35. Delete Log Alarm Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Figure 36. Add Action Page Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Figure 37. Update Action Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Figure 38. Delete Action Dialog Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Figure 39. System Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Figure 40. Configuration Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Figure 41. Logging Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Figure 42. Status Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
7/21/06
Figure 43. More Information Page Example. . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Figure 44. Status Users Content Page Example . . . . . . . . . . . . . . . . . . . . . . 101
Figure 45. License Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Figure 46. Branding Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Figure 47. New Banner Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Figure 48. Devices Home Page Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Figure 49. Add Device Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . . 107
Figure 50. Update Device Home Page Example . . . . . . . . . . . . . . . . . . . . . . 110
Figure 51. Delete A Cluster Dialog Example . . . . . . . . . . . . . . . . . . . . . . . . . 110
Figure 52. Partitions Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Figure 53. Add Partition Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Figure 54. Stylesheet Content Page Example . . . . . . . . . . . . . . . . . . . . . . . . 122
Figure 55. Stylesheet Page Example (Partial View). . . . . . . . . . . . . . . . . . . . 122
Figure 56. Update Partition Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Figure 57. Add Endpoint Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Figure 58. Users Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Figure 59. Add User Home Page Example (Partial View) . . . . . . . . . . . . . . . 129
Figure 60. Update User Home Page Example (Partial View). . . . . . . . . . . . . 133
Figure 61. Access List Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . . 135
Figure 62. Archiver Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Figure 63. Add Archive Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . 141
Figure 64. Audit Trail Page Example (Partial View) . . . . . . . . . . . . . . . . . . . . 145
Figure 65. Audit Trail Details Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
7/21/06
Figure 66. CDR Import/Export Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . 149

Figure 67. New Import Window Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Figure 68. Create a New Mapping Example. . . . . . . . . . . . . . . . . . . . . . . . . . 151
Figure 69. New Import Stream Window Example. . . . . . . . . . . . . . . . . . . . . . 156
Figure 70. New Export Stream Window Example . . . . . . . . . . . . . . . . . . . . . 159
Figure 71. Re-Import CDRs Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Figure 72. Synchronization Home Page Example . . . . . . . . . . . . . . . . . . . . . 167
Figure 73. Difference Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Figure 74. Manual Synchronization Page Example . . . . . . . . . . . . . . . . . . . . 169
Figure 75. System Alarms Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Figure 76. Events Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Figure 77. Actions Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Figure 78. Add Action Page Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Figure 79. Update Action Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Figure 80. Delete Action Dialog Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Figure 81. Rating Data Table Relationships. . . . . . . . . . . . . . . . . . . . . . . . . . 178
Figure 82. Provision Tab Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Figure 83. Rates Summary Home Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Figure 84. Rates Summary Content Example . . . . . . . . . . . . . . . . . . . . . . . . 183
Figure 85. Regions Summary Home Page Example . . . . . . . . . . . . . . . . . . . 186
Figure 86. Regions Summary Content Example . . . . . . . . . . . . . . . . . . . . . . 188
Figure 87. Rates and Routes Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Figure 88. Rates and Routes Page Example . . . . . . . . . . . . . . . . . . . . . . . . 192
7/21/06
Figure 89. Rates and Routes Content Example (Partial View). . . . . . . . . . . . 194
Figure 90. Routes Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Figure 91. Route Content Page Example (Partial View) . . . . . . . . . . . . . . . . 199
Figure 92. Add Route Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Figure 93. Update Route Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Figure 94. Delete Route Dialog Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Figure 95. Add ANI Dialog Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Figure 96. Rates Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Figure 97. Rates Content Page Example (Partial View). . . . . . . . . . . . . . . . . 205
Figure 98. Add Rate Window Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Figure 99. Update Rate Window Example . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Figure 100. Regions Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Figure 101. Add Region Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Figure 102. Update Region Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Figure 103. Periods Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Figure 104. Periods Content Page Example . . . . . . . . . . . . . . . . . . . . . . . . . 215
Figure 105. Add Period Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Figure 106. Range Period Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Figure 107. Specific Period Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Figure 108. Import Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Figure 109. Import Format Help Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Figure 110. Rerate Home Page Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Figure 111. Trace Rate Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . 227
7/21/06
Figure 112. LCR Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

Figure 113. LCR Details Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Figure 114. Update LCR Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Figure 115. MPR Home Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Figure 116. MPR Content Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Figure 117. Java Splash Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Figure 118. Warning Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Figure 119. Java Web Start Dialog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Figure 120. Loading iView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Figure 121. RSM Console Main Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Figure 122. iServer Main Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Figure 123. Utilities List Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Figure 124. iEdge Group Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Figure 125. Add iEdge Group Page Example . . . . . . . . . . . . . . . . . . . . . . . . 246
Figure 126. Modify iEdge Group Page Example . . . . . . . . . . . . . . . . . . . . . . 248
Figure 127. Utilities Policy List Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Figure 128. Subnet Page Example (Partial View) . . . . . . . . . . . . . . . . . . . . . 252
Figure 129. Add Policy Page Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
7/21/06
1
PREFACE
Who Should Use This Guide
This document is intended for persons who use RSM software, as well as for
anyone having a need to know how RSM works.
Assumptions
This document assumes that you have a working knowledge of:
Microsoft Internet ExplorerTM, Version 6.0 (or higher)
Unix
General knowledge of RSM.
Document Content
This book contains:
An overview, of how the RSM system fits in with the other NexTone
products with which it integrates.
A list of features, see Chapter 2, New Features, on page 1, provided in the
release of the RSM 4.2 software covered in this guide.
Detailed descriptions of the RSM system and its component parts, and
how the system integrates with the other products with which it interacts.
Specifications for the hardware and software platforms on which the
RSM software components will be installed.
Normal-use procedures for requesting reports of engineering-related data,
business-level data on calls, and profitability data.
Description of tools and procedures for administering various alarms,
actions, and events.
Procedures for entering and maintaining rating data in the RSM database.
7/21/06
Preface
1.
<<1. Preface>>
1.
Preface
Procedures for setting up streaming of CDR data to files or third-party

systems.
Procedural and reference information for system administrators.
Appendices, including:
A list of normal database operations, with a link to the MySQL web
site location where more information can be found. See
Chapter A, Selected Database Operations.
A set of illustrations depicting the flow of the RSM web browserbased interface.
A glossary containing some of the terms used in this book. See
Chapter H, Glossary.
7/21/06
<<1. Preface>>
1.
Conventions
Preface
For consistency and clarity, the conventions described in Table 1 are

employed in this book.
Table 1. Conventions
Convention
Example
Labels on window text boxes into which you can

enter values are shown in sans-serif type. Window
titles show in bold face of the same family.
Enter the address of the host

machine into the IP Address:
field.
All CLI commands are printed in small, condensed,

monospace font.
At the prompt, type:
Information you supply when entering a command is

shown in oblique (or italic) of the command font.
mkdir directory_name
Special keys on the keyboard are shown with key

names in angle brackets. In this example, you would
press and hold the Ctrl key, then strike the S key.
Press <Ctrl>+S
Terminal screen excerpts and human-readable text

file contents are shown in condensed monospace font.
<CR_SRC> " " </CR_SRC>
Commands with a list of options from which one

must be chosen are shown with the options in square
brackets, separated by the | symbol. The example
means choose either tsm, us, bridge or iwf.
[tsm|ua|bridge|iwf]
cd /usr/local
Contacting NexTone Support

In the event that you decide to contact NexTones customer technical support
group, you have two options:
1. You may email questions to support@nextone.com, or
2. Go to NexTones web site at: http://www.nextone.com/support.html (or
select Support from the main menu on the NexTone home page), for a
description of other available support options.
7/21/06
<<1. Preface>>
1.
The human interface into most RSM system functions discussed in this document is certified to work with Microsofts Internet Explorer (IE) web browser.
Other browsers, such as Netscape Navigator (see Client Requirements, on
page 24), may also work but are not certified. Throughout this book, many
samples of web pages and dialog boxes are provided.
It is worth noting that the samples are based on IE 6.0, the most current build
available as of the release of this RSM Operations Guide. Other browsers may
differ in appearance and functionality.
7/21/06
Preface
Sample GUI Pages Provided in this Book
2
NEW FEATURES
WHATS IN THIS CHAPTER
2.
This chapter provides a list of new features in this release.
New Features
NEW FEATURES IN RELEASE 4.2

Below is a list of new features in release 4.2 of RSM.
Alarm Feature
In RSM Release 4.2, there is one new feature in the alarms functionality, as
follows:
ADD CDR ALARM PAGE

Partition - this option is for System Administrators only. It allows the
Admin user to view and use entries made by non-admin users.
Group by all/selected endpoints
Applied only to alarms that do not have quantity accumulators, i.e., no
Dollar Amount or Gateway Minutes. The user can select particular endpoints which will serve as additional filtering criteria.
CDR Profit/Loss Alarm
Calculates the profit/loss for each CDR. This is triggered when the configured threshold is met.
The Alarm Type field displays the alarm name in complete name format
rather than abbreviated format. For example, CDR Error Description vs.
CDR Error Desc.
The Conditions are spelled out and two new conditions were added, i.e.,
less than equals and greater than equals. The condition equals was
removed.
7/21/06
<<2. New Features>>
Under Endpoint, the source check box was changed to two radio buttons
with options for Origination/Source and Termination/Destination.
The Group by check box has been renamed to Group by all/selected endpoints.
Re-lay Outing applies to the Add/Update CDR alarm and log page. The
size in which the information is displayed is increased so that the information is well presentable.
Any Endpoint
In Release 4.2, the user has the capability to separately querying any endpoint on the database. In the current environment, a temp table is created
triggering the alarm, a query is then made against that table taking into
consideration all endpoint related information.
Therefore the alarm is triggered if any of the chosen endpoints (any of all
endpoints in case no endpoints particularly chosen) satisfies the query
condition.
Note: The check box is automatically disabled if you are creating or updating
"Dollar Amount and Gateway Minutes alarm types. Also, the check
box can be used with or without Source check box and used with all
existing conditions and filters.
Audit Trail Feature

The Audit Trial feature provides,
an option to view audit trail details by clicking a Details link, you can also
purge the trails.
the ability to audit all requests via Web Services giving you the ability to
retrieve information other than the User Interface.
provides an Add Time lapse option for Audit Trail
7/21/06
2.
New Features
The Regions/Supplier/Customer was separated out of the endpoint table

and given its own unique location. The Regions field has an auto-complete action, e.g., if you Add an Alarm an enter Italy-Proper and you add a
second alarm and enter Italy-Proper, the region name is automatically
listed.
<<2. New Features>>
CDR Validation and Logging Feature
Diagnostic and Debug Feature

This feature provides the user and technical support with a tool to analyze
server performance and the capability to debug performance problems
detected in the field.
Diagnostic details are accessible from the RSM web client and the debug feature is accessible from a URL provided by the technical support team.
New iView Feature

The new iView allows the user to,
Log into RSM
Logout of RSM
Start embedded iView
Add, update and view devices (MSWs)
RSM and MSX Database Synchronization Feature

This feature identifies the causes of database inconsistencies between the
MSX and RSM databases. This feature provides the user with the ability to
detect and report inconsistencies and a means to synchronize the database
from MSX to RSM and vice versa.
7/21/06
2.
New Features
CDR Receptor Module (CRM) provides a CDR receiving interface. CRM is

the single point for inserting CDR's into the RSM database. In the current
RSM system, CDRs are inserted without an integrity check on the CDR being
inserted. If the CDR has invalid/hostile characters or fields the CDR insertion
into RSM fails and the CDR insertion process is stopped without providing
inconsistent CDR logging or identification of the CDR or the field causing the
problem. In order to circumvent this type of situation, the CDR Receptor
Module acts as a CDR receiver performing primary validation of CDR fields
quarantining those CDR's with invalid characters. The invalid CDR's which
are filtered by CRM can be manually edited and then inserted into the RSM
system using the Web Interface.
<<2. New Features>>
License Control Feature

This feature is used to specify the maximum number of users which can be
configured per partition on the system.
Logger Feature
This feature allows for the debugging and general troubleshooting of RSM
4.2. via the Logger option under the System Tab.
Rating and Routes Generation Feature

This feature provides a means to achieve better performance, usability and
code maintainability.
System Alarms Feature

This feature allows for the creation of system alarms, based either on CDRs or
other system resources, and any action to be taken based on the configuration.
User Interface Customization Feature

This feature allows the System Administrator to change the look and feel of
RSM user interface by managing the .css profile. The changed interface
allows every member of the partition to have a similar web interface. The System Administrator can also update the logo to a new logo.
Web Services Interface Feature

Web services is a technology allowing applications to communicate with each
other in a platform- and programming language-independent manner. This
feature provides provisioning access to NexTones endpoints, subnets and
iEdgeGroups.
A Web service is an interface that describes a collection of operations that are
network accessible through standardized XML messaging. A Web service
uses a standard, formal XML notion, called a service description. It covers
all the details necessary to interact with the service, including message formats (that detail the operations), transport protocols and location. The interface hides the implementation details of the service, allowing it to be used
independently of the hardware or software platform on which it is imple-
7/21/06
New Features
2.
<<2. New Features>>
mented and also independently of the programming language in which it is

written.
New Features
2.
7/21/06
3
INTRODUCTION
This chapter presents an overview of how the RSM system fits in with the
other NexTone products with which it integrates. The last section of this chapter, Common RSM System Operations, on page 12, describes a few selected
operations that are common to many tasks, such as logging into the system.
VOIP TELEPHONY AND RSM
In todays telephony market, the majority of information is carried over previous generation circuit switched technology. VoIP is a packet switched
technology offering some significant advantages for everyone from enterprises to telephony carriers. But since only a fraction of traffic is carried over
VoIP, it must be able to co-exist with circuit-switched communication. The
NexTone session controller systems, the iServer facilitates this interoperation
of circuit and packet switched technologies.
Further complicating this scenario, there are two competing standards for
VoIP communication: H.323 and SIP. NexTones session controllers also
provide an interworking function (IWF) between H.323 and SIP, making possible virtually seamless communication across all current telephony fabric. In
addition, equipment providers support the standards to varying degrees, with
differing methods.
On top of all this, the appearance of many competing carriers in the market
requires a targeted, integrated solution to keep track of the traffic, rates,
routes, profitability, etc. With RSM, a carrier or end-user of telephony services can not only actively monitor traffic, but also take advantage of dynamic
routing changes, track route profitability, monitor billing, and more.This document presents certain particulars of NexTones RSM software system for
2006 and NexTone Communications, Inc. Proprietarys.
7/21/06
3.
Introduction
Voice over Internet Protocol, commonly known as VoIP, is a next-generation

approach to telephony transport. VoIP allows the use of nearly ubiquitous
internet protocol networks to reliably and inexpensively carry voice conversations, fax transmissions, modem connections, and practically anything else
that can be done with a telephone.
<<3. Introduction>>
network monitoring, analysis and reporting, and CDR (Call Detail Record)
rating. It is targeted to installation, use, and maintenance of an RSM system.
HIGH-LEVEL VIEW
The Real-time Session Manager System (RSM) is the new management architecture that combines NARS, RSM Console and a centralized database into a
single NMS solution for NexTone products. RSM provides an integrated set
of tools that allow access, via a web-browser, to RSM system configuration
and a view of various performance characteristics of a VoIP network controlled by a NexTone session controller.
RSM COMPONENTS
A NexTone RSM system consists of a combination of required and optional
components. The sub-sections below divide the components into categories of
those running on the RSM server, and those running on the session controller
server. Each section lists the main components, with functional descriptions
of each.
Server-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
7/21/06
3.
Introduction
Viewed at its simplest level of detail, the RSM system consists of two parts:
an agent component which co-resides on a NexTone iServer, and a server,
which runs on its own, separate hardware platform. The agent and the server
cannot be located on the same machine, since they run on different operating
systems. (The agent runs on the session controller platform under Solaris, and
the RSM server for 4.1 runs under Linux.) However, even if they could run on
the same OS, processing and memory requirements to achieve acceptable performance on both systems would still dictate that they should run on separate
platforms.
<<3. Introduction>>
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: THE ROUTE ANALYSIS MODULE (STANDARD)

The Route Analysis Module (RAM), running on the RSM server platform,
processes CDRs in real-time, 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.
3.
The ESM module facilitates alarming.

Alarm categories are as follows:
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: caused by the following
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 the following:
Logging the error to a log file
E-mailing a notification to a particular user account
7/21/06
Introduction
ESM: THE EVENTS AND STATISTICS MODULE (OPTIONAL)
<<3. Introduction>>
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: THE ADAPTIVE ROUTING MODULE (OPTIONAL)

This module provides a set of actions to change the 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 4.1, ARM provides a way to disable calls, at endpoint ingress or
egress, based on a detected alarm condition.
BAM: THE BUSINESS ANALYSIS MODULE (OPTIONAL)

This module processes CDRs from the RSM server database to produce ondemand business reports including the following:
Revenue and profit analysis, and profitability by route
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: THE 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 endpoints (including gateways) the user can view and for which he
can produce reports
The RSM system features the user can access
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. For more information on
chromocodes, see Customizable Chromocode, on page 27.
7/21/06
Introduction
3.
A count of unrated CDRs on the session controller, with certain details
<<3. Introduction>>
Note: Certain browsers are certified to work with the RSM system. Others
may work, but yield unexpected results, and are not supported. The
certified browsers are listed in Client Requirements, on page 24.
Agent-side Components
The RSM systems agent software runs on the session controller platform. It
consists of the components detailed in this section.
CDRSERVER
The agent component called cdrserver reads the CDR files created by the host
session controller. 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.
HTTP POST
The NARS agent on the MSWs will delivers CDRs to the RSM server using
the HTTP protocol. The HTTP POST operations are throttled down to keep
them at one POST per second to avoid excessive network traffic. Each POST
operation can deliver multiple CDRs, delimited by the new line character.
Each CDR entry is of the same comma separated format as the MSW CDRs.
LOGPP
The logpp agent component reads iServer log files and informs the RSM
server of any events of interest.
License File
For RSM releases prior to 3.1, a connection to the RSM server was required,
even to just stream CDRs to a third-party (i.e., non-RSM) server. For versions
3.1 and later, the agent software will run 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/RSMagent/RSM.lc. If the file doesnt exist on the ses-
10
7/21/06
3.
Introduction
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 time, expression and conditional
transformations. Details on streaming capability and setup are given in RSM
Streaming, on page 213.
<<3. Introduction>>
sion 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 agent1. 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, please contact your
NexTone representative.
RSM RATING FEATURES
3.
The rating actions performed by RSM 4.x include the following:
Introduction
Rating based on:

Any of the three numbers associated with a call (from source, aftersource Calling Plan (CP), and at destination).
Peak or off-peak rates
Holiday rates
Rate regions
Overriding normal criteria for a cause code being considered normal or
error, thus forcing an action that would not otherwise have occurred.
Assessing one-time connection service charges
1. If a copy of the license file is located on the session controller.
11
7/21/06
<<3. Introduction>>
COMMON RSM SYSTEM OPERATIONS

Certain operations within the RSM system are common to many web pages or
dialog windows. In order to make many of the procedures in this document
less cluttered, those operations are detailed in this section, and only referenced in the other sections. Once you are familiar with how theyre done, you
probably wont need to keep referring back here.
Logging into the RSM System

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.
Note: Your supervisor or system administrator should be able to provide you
with the URL address.
3.
2. The Security Alert dialog displays.
Introduction
Figure 1. Security Alert Dialog
3. Select Yes to proceed with the login
12
7/21/06
<<3. Introduction>>
or click No to exit out of the login process.

To view the certificate, click View Certificate.
A dialog similar to the one below displays.
Figure 2. Certificate Dialog
Introduction
3.
13
7/21/06
<<3. Introduction>>
4. The Welcome to RSM log-in window displays.
Figure 3. Welcome to RSM Dialog
3.
5. Enter your User ID and Password.
7. The system takes you to the main RSM system page, which happens to be
the Engineering reports page.
Figure 4. Engineering Reports Page Example
14
7/21/06
Introduction
6. Hit the <Enter> key or click the Login button.
<<3. Introduction>>
8. Once logged into the RSM system, you can access those functions to
which your user profile entitles you. For example, only the "root" user is
authorized to access the rating function, found under the Provisioning tab
in RSM system release Release 4.2.
9. For all other users, the Rating function will not appear on the page.For
more information on user privileges, see the section, Users, on page 125.
Note: The root user and users who have root access privileges are authorized to access the rating function in RSM system release Release 4.2.
Otherwise, the rating function does not appear on the page.
Note: The Reporting tab is selected, by default, showing the criteria window
for the Engineering report page, as shown below.
IMPORTANT: If you have successfully logged in, DO NOT select a new

browser window and re-login!
Login Privileges
In RSM, there are two levels of login privileges:
3.
User
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 RSM 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:
1. Click the Logout link.
Figure 5. Logout Link Example
2. You are returned to the Login window.
15
7/21/06
Introduction
Administrator
<<3. Introduction>>
WINDOW STRUCTURE
Upon successfully logging into RSM, the main system page of the RSM system displays.
Figure 6. Engineering Home Page Example
Note: Upon logging onto RSM, the Reporting tab is displayed, by default.
3.
Introduction
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:
16
7/21/06
<<3. Introduction>>
RSM Console Used to launch the RSM (formerly iView) Console

window.
Help Used to access the RSM Help guide.
Logout Used to log out of the RSM application.
TOP LEVEL MENU

The Top Level Menu area of the RSM window also 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 tab 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.
3.
Introduction
Figure 7. Top Level Menu Example
17
7/21/06
<<3. Introduction>>
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 submenus available on each tab.
Figure 8. Menu Area Example
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.
Introduction
Figure 9. Action Area Example
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.
Figure 10. Content Area Example
3.
18
7/21/06
<<3. Introduction>>
VERIFYING THE CURRENT VERSION

To verify the version of RSM that you are working on, do the following:
1. Move your cursor to the RSM Powered by NexTone icon, located on the
upper left side of a page.
2. Left-click your mouse.
3. The RSM Versions dialog displays. The following is an example of this
dialog.
Figure 11. Version Number Example
3.
4. Click Close to exit out of the dialog.
In some web pages or dialog windows, a list of items may be presented from
which to choose one or more entries. To select more than one, you hold down
a modifier key, such as <Ctrl> or <Shift>, while clicking on the entries to
select them. The exact modifier key and procedure will vary with the browser
you use, and the platform its running on. On Windows using Internet
Explorer (IE), for example, holding down the <Ctrl> key allows you to select
multiple items one at a time. That same operation using IE on an Apple Macintosh uses the command key. It is worth the effort to learn your particular
platforms key-click procedures. It will make your work easier.
Selecting Dates
Some dialog boxes allow you to enter date ranges for functions such as reporting and rating. When this is an option, selecting the date is done through a
19
7/21/06
Introduction
Multiple Items in a List
<<3. Introduction>>
pop-up window where you specify the date by clicking on a calendar graphic
like the one shown in Figure 5.
Figure 12. Date Selection Dialog
To move one month forward or backward in time (think of play on a tape

deck), 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 deck), 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.
Selecting Time Zones

Some dialog windows allow you to specify time zones to apply against 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.
20
7/21/06
3.
Introduction
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.
<<3. Introduction>>
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:
ls /usr/share/zoneinfo
This command gives a list of times zones recognized by the operating system,
many of which are expressed as city names (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 subdirectories 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.
Introduction
3.
21
7/21/06
4
RSM PLATFORM DESCRIPTION
INTRODUCTION
This chapter details the hardware and software of the platforms on which the
components of the RSM system run.
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.
RSM System Agent

The RSM systems agent components run on the same physical machine as
the session controller (iServer) with which they are paired. The session controllers run on an Intel machine under Solaris for x86 2002 Edition. For current information, including Solaris patch level requirements for your specific
session controller installation, see the Multi-protocol Signaling Switch
Installation and Operations Guide, publication number 09-0600001-nnn-a.
Where nnn is the book release number and a is the book revision letter.
RSM System Server

RSM has certified platforms on which the RSM system server can be
deployed.
The RSM system server runs on a separate platform from the session controller. It also operates under a different operating system, Linux.
Server storage (memory and disk) sizing parameters are dependent primarily
upon the number of expected CDRs per day, and the number of days of on-
22
7/21/06
4.
iVMS Platform
Description
The RSM agent has no additional resource requirements (memory, disk, etc.)
beyond those for the session controller.
<<4. RSM Platform Description>>
line CDR retention. As a service to its customers, NexTone will size the
server according to a formula it has developed to ensure sufficient capacity
and performance. The number will likely grow somewhat with each release,
due to increases in CDR size. Also, disk subsystem performance degrades as a
direct function of percentage of capacity used, once the percent used passes
around 60-70 percent. Some headroom should be allowed for these considerations.
MEMORY REQUIREMENT
Components contributing to the total memory requirement include the following:
CDR online database storage
Database overhead
Operating System basic overhead
DISK STORAGE REQUIREMENT

In addition, to ensure adequate performance, the RSM server has two disk
storage requirements:
The main database data storage volume, /mysqldata, should run on a
RAID volume from all other disks, which by definition will give it a separate mount point.
The /mysqllogs volume should also be on a separate mount point, but can
co-reside on the same physical volume as the operating system.
Beyond the issues of sizing, the server must be able to run Red Hat Enterprise
Linux ES version 3. NexTone staff will work with the customer to determine
the best server sizing for a given installation based on its projected utilization.
RSM Server
The RSM Release 4.2 server, in addition to the operating system, needs the
following software installed on it for basic operations:
MySQL database client-server package version 4.2.x
J2SE Java SDK (software development kit) version 1.4.2_03
4.
iVMS Platform
Description
REQUIRED SOFTWARE
23
7/21/06
<<4. RSM Platform Description>>
JBOSS version 3.2.6, JDK 1.4.2

NexTone RSM server, version Release 4.2
The above versions are just the major release numbers.To see what versions
of software are actually running on the RSM system, click on the RSM logo,
on the upper left corner, on any RSM page once you are logged in. A pop-up
window lists the installed system components with the version number for
each.
RSM System Agent Requirements

RSM Release 4.2 agent components will run without any special software
installed on their host platform beyond what the NexTone session controller
already has running.
Client Requirements
The RSM system user and administrator access RSMs functionality through a
web browser client running locally on their workstation.
The RSM system is fully tested with Microsofts Internet Explorer 6.
In addition, browsers known to generally work with RSM, but not certified to
be without issues, include:
Netscape
FireFox
Safari
4.
iVMS Platform
Description
Other browsers may work, but have not been tried, and are also not certified.
While some of these may work with the RSM systems web interface, functionality is not guaranteed, and the appearance of the web pages may differ
substantially from the samples provided in this book.
24
7/21/06
5
RSM REPORTING
INTRODUCTION
This chapter describes how to use to the RSM systems reporting capabilities.
The normal RSM system user (that is, not only the system administrator) has
access to the report function. There are two classes of reports, the technical
and business reports.
Note: The actual web pages you see may differ slightly from the illustrations
shown in this guide, based on your browser and its computer platform.
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.
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.
25
7/21/06
RSM Reporting
5.
<<5. RSM Reporting>>
Search 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
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. Date ranges are also
specifiable.
Request engineering reports using the procedure given in Engineering
Reports, on page 28.
The engineering report set includes the following:
Answer Seizure Ratio (ASR), sorted by one of many possible key
parameters, such as source IP address, Reg ID, Region, Supplier,
Customer, Day, Hour, Minute, or CDR file
The List Calls
Business
These reports can be filtered by origin or destination registration or port,
or by searching for a particular embedded string. Date and time ranges are
also specifiable, as is refresh interval.
Request business reports using the procedure given in Business Reports,
on page 35.
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
26
7/21/06
RSM Reporting
5.
5.
RSM Reporting
A count of unrated CDRs, along with certain details

RouteProfit
Request route profitability reports using the procedure given in Route
Profitability Reports, on page 41.
The reports include the following:
Customer or supplier
Based on one or more plan IDs
Filterable by date
Custom
These reports are not otherwise provided in the standard complement of
reports listed above.
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.
WARNING: Because user preferences do not take effect until the next
login, you are required to logout and re-login.
Requesting Reports
Follow the procedures in this section to obtain your available reports.
Note: Keep in mind that you will only be able to pull data on those endpoints
and/or other entities for which you are authorized based on your user
accounts group assignment.
27
7/21/06
ENGINEERING 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 Reporting tab displays
the Engineering report window by default.
The Engineering menu 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, on page 32.
1. Begin by logging onto the system as described in Logging into the RSM
System, on page 12.
2. By default, you are brought to the engineering report page as illustrated
below.
Figure 13. Engineering Home Page Example
Note: If you want a business, route profit, or custom report, click on the corresponding link, and follow the procedures in the Business Reports, on
page 35, Route Profitability Reports, on page 41 or Custom Reports,
on page 46.
3. Choose the specific report you want from the Report, i.e., ASR by Source
IP, list.
4. Select the Host by scrolling through the host id list.
28
7/21/06
RSM Reporting
5.
5. Enter the Begin and End dates for the report. Note that you enter dates by
clicking on the calendar icon to the right of the date fields and clicking on
the date you want in the calendar pop-up.
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 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.
6. Select the Time Zone from the list.
7. Enter any additional search criteria in the appropriate fields.
Note: RSM supports the use of wildcards supported by MySQL in the Orig
Reg ID and Dest Reg ID fields.
8. Select a Partition from the list.

9. Select your desired Refresh Interval from the list, or accept the default.
10. Click Show.
Note: To clear the page of entered search criteria, click the Clear button.
11. After some processing time, your report displays.

12. Use the Prev and Next buttons pages to navigate through the report if it
doesnt all fit on one screen.
29
7/21/06
RSM Reporting
5.
5.
Field
Report
RSM Reporting
FIELD DESCRIPTIONS
Description
This field identifies the type of Engineering report.
There are currently eleven reports available.
Note: NOTE: The dialog shown

above differs for each subfunction, since each sub-function has different data. The
example in the figure is for the
ASR by Source IP function.
Host
A host can be an MSW/MSC, 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 MSW/MSC,
the hostname of the machine is filled in as default.
Begin Date
Specifies the beginning date range of CDRs to be

included in the report.
End Date
Specifies the ending date range of CDRs to be

Time Zone
Specifies the timezone the report is going to use,

i.e., if GMT is selected, then the Start and End date
are in GMT and, all date time (first call, last call,
etc.) are displayed in GMT, except in the CDR
detail view.
Orig Reg ID
Allows the user to specify the endpoints originating

registration ID. (Search Wildcards, on page 26, can
be used.) The registration identification is a credential for an endpoint in the iServer database. This
entity is generated by the Network Administrator,
and must be unique to an iServer database. Each
reg ID can be split into sub-entities called uports.
Orig Port
Allows the user to specify the endpoints registration port.
Dest Reg ID
Allows the user to specify the endpoints destination registration ID. (Search Wildcards, on page 26,
can be used.)
Dest Port
Allows the user to specify the endpoints destination port.
30
7/21/06
5.
Description
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.
Page Number
Identifies the page number of the displayed report.
Page Length
This field indicates the number of entries to be displayed per page. The default is 100 lines of displayed information per page.
Refresh Interval
This field specifies how often, in minutes, the RSM

automatically refreshed the report.
RSM Reporting
Field
Obtaining Engineering Report Details

Once the basic parameters have been entered from the main Engineering
Report page, clicking Show sends the report request to the server and, in a
moment, the report displays. From the results page, there are a few options for
examining the returned data more closely.
The initial report sums the data by device registration ID and port. The columns it displays are shown in the example in Figure 14, Engineering Report
Content Area Example, on page 31.
Figure 14. Engineering Report Content Area Example

From this point, you have one option to take you to another view:
Note: You must choose the iServer time zone from the list menu when running reports. Also, both the iServer and RSMs time must be accurate,
or the reports will be inaccurate. When the timezone can be specified,
this needs to be the time zone of the CDR of the switch you are reporting against.
1. Clicking on the 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. In this example, it is ASR (%), since the ASR by
Source IP report was chosen.
31
7/21/06
5.
RSM Reporting
2. An example of that graph is shown below.
Figure 15. Engineering ASR Graph Example
Remember that, at any time, you can return to any previous page by using
your browsers Back button.
Types of Engineering Reports

The following is a description of each of the 11 types of Engineering Reports.
Table 1. Types of Engineering Reports

ASR Report
Description
ASR by Source IP
The ASR by Source IP output is sorted by source IP

address and port number.
ASR by Source Reg ID
The ASR by Source Reg ID output is sorted by the

source registration ID and port number.
ASR by Destination IP
The ASR by Destination IP output is sorted by the

destination IP and port number.
ASR by Destination Reg ID
The ASR by Destination Reg IP output is sorted by

destination registration ID and port number.
32
7/21/06
5.
Description
ASR by Region
The ASR by Region output is sorted alphabetically

by region.
ASR by Supplier
The ASR by Supplier page output is sorted alphabetically by supplier.
ASR by Customer
The ASR by Customer output is sorted alphabetically by customer.
ASR by Day
The ASR by Day output groups on a ASR day-byday basis. Information is displayed chronologically,
with the most recent date first. Day is displayed in
YYYY-MM-DD format.
ASR by Hour
The ASR by Hour output page groups system ASRs

on an hourly basis and displays information by date
and hour for one day. It will list 24 entries, with one
entry for each hour of the day.
ASR by Min
The ASR by Minute output page groups system

ASRs on an minute basis and displays information
by date and minute for one day.
List Calls
The List Calls report page lists system ASR calls for
a given day.
RSM Reporting
ASR Report
Note: If there are no CDRs in the system and a start and stop date is not
specified, the dates default to 12/31/69. Otherwise, the dates default to
the most recent dates selected.
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 retyping it over again.
33
7/21/06
5.
RSM Reporting
Figure 16. Saved Filters Example
NEW FILTER
To create a new filter, from the engineering home page, follow these steps:
1. Click the Filter button. The Saved Filters dialog displays.
Figure 17. Saved Filters Dialog Example
2. In the Filters field, select --New Filter--.

3. In the Save As field, give the new filter a name.
4. Click the Save button.
34
7/21/06
5.
RSM Reporting
SETTING A FILTER
To set a specific filter for use, follow these steps:
1. From the Filters field, select the filter you wish to use.
2. Click the Set button.
DELETING A FILTER
To delete a filter, follow these steps:
1. Click on the filter you wish to delete.
2. Click the Delete button.
3. The delete dialog displays.
Figure 18. Delete Filter Dialog Example
4. Click the OK button to delete the selected filter.

5. Click the Cancel button, to exit the dialog.
BUSINESS REPORTS
These reports can be filtered by origin or destination registration or port, or by
searching for a particular embedded string. Date and time ranges are also
specifiable, as is refresh interval.
There are 44 available business reports. The reports are grouped by the following:
Region
Customer Route
Supplier Route
35
7/21/06
5.
RSM Reporting
Supplier
Customer
Cust Plan
Supplier Plan
Orig REGID
Orig IP
Term REGID
Term IP
For each report group, the reports are additionally sorted by the following:
Calls, Minutes, Revenue, and Profit. For a description of each of the 44 types
of reports, see Types of Engineering Reports, on page 32.
Accessing the Business Report

To access the Business report, follow these steps:
1. Log onto the system as described in Logging into the RSM System, on
page 12, and click the Reporting>Business button at the top of the page.
2. The Business report page shown in Figure 19 displays.
Figure 19. Business Report Main Page Example
3. Choose the specific report you want from the Report, i.e., Region by Calls,
list.
4. Select the Host by scrolling through the host id list.
36
7/21/06
5. Enter the Begin and End dates for the report. Note that you enter dates by
clicking on the calendar icon to the right of the date fields and clicking on
the date you want in the calendar pop-up.
7. Enter search criteria, if you wish, in the appropriate fields.
Note: RSM supports the use of wildcards supported by MySQL in the Orig
Reg ID and Dest Reg ID fields.

10. Click Show.
Figure 20. Business Report Content Page Example

CLEARING THE BUSINESS REPORT

To clear the page of entered search criteria, click the Clear button.
WARNING: Clicking Clear removes all output information from the
page. The cleared information cannot be retrieved.
Types of Business Report

There are 44 types of business reports. The reports are sorted by the following:
Region
Customer Route
Supplier Route
Supplier
Customer
Cust Plan
37
7/21/06
RSM Reporting
5.
5.
RSM Reporting
Supplier Plan
Orig REGID
Orig IP
Term RegID
Term IP
Each report also has four sort criteria as follows:
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.
LISTING OF BUSINESS REPORTS

Table 2 provides a list of the available ASR reports and their descriptions.
Table 2. List of Business Reports

ASR Report
Description
Region by Calls
This report is sorted by region, with the highest

number of calls displaying first.
Region by Minutes
This report is sorted by region, with the highest billable minutes displaying first.
Region by Revenue
This report is sorted by region with the highest revenue displaying first.
Region by Profit
This report is sorted by region with the highest profit

margin. The region with the highest profit displays
first.
Customer Route by Calls
This report is sorted by customer route with the

highest number of calls displaying first.
38
7/21/06
ASR Report
Description
Customer Route by Minutes
This report is sorted by region, with the highest billable minutes displaying first.
Customer Route by Revenue
This report is sorted by region, with the highest revenue displaying first.
Customer Route by Profit
This report is sorted by region, with the highest revenue displaying first.
Supplier Route by Calls
This report is sorted by supplier route, with the

Supplier Route by Minutes

highest billable minutes displaying first.
Supplier Route by Revenue

highest revenue displaying first.
Supplier Routes by Profit

highest profit margin displaying first.
Supplier by Calls
This report is sorted by supplier, with the highest

Supplier by Minutes

billable minutes displaying first.
Supplier by Revenue

revenue displaying first.
Supplier by Profit

profit margin displaying first.
Customer by Calls
This report is sorted by customer, with the highest

Customer by Minutes

Customer by Revenue

Customer by Profit

Cust Plan by Calls
This report is sorted by customer plan, with the

Cust Plan by Minutes

highest billable minutes displaying first.
39
7/21/06
RSM Reporting
5.
ASR Report
Description
Cust Plan by Revenue

highest revenue displaying first.
Cust Plan by Profit

Supplier Plan by Calls
This report is sorted by supplier plan, with the highest number of calls displaying first.
Supplier Plan by Minutes
This report is sorted by supplier plan, with the highest billable minutes displaying first.
Supplier Plan by Revenue
This report is sorted by supplier plan, with the highest revenue displaying first.
Supplier Plan by Profit
This report is sorted by supplier plan, with the highest profit margin displaying first.
Orig REGID by Calls
This report is sorted by Orig REGID, with the highest number of calls displaying first.
Orig REGID by Minutes
This report is sorted by Orig REGID, with the highest billable minutes displaying first.
Orig REGID by Revenue
This report is sorted by Orig REGID, with the highest revenue displaying first.
Orig REGID by Profit
This report is sorted by Orig REGID, with the highest profit margin displaying first.
Orig IP by Calls
This report is sorted by Orig IP, with the highest

Orig IP by Minutes
This report is sorted by Orig IP, with the highest billable minutes displaying first.
Orig IP by Revenue
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

Term REGID by Calls
This report is sorted by Term REGID, with the highest number of calls displaying first.
Term REGID by Minutes
This report is sorted by Term REGID, with the highest billable minutes displaying first.
Term REGID by Revenue
This report is sorted by Term REGID with the highest revenue displaying first.
40
7/21/06
RSM Reporting
5.
5.
Description
Term REGID by Profit
This report is sorted by the Term REGID, with the

Term IP by Calls
This report is sorted by Term IP, with the highest

Term IP by Minutes

Term IP by Revenue

Term IP by Profit

RSM Reporting
ASR Report
Filters
Refer to Filters, on page 33.
ROUTE PROFITABILITY REPORTS

The Route Profitability report shows billing activity. Please note, this report
cannot be used to generate customer bills; a separate system is needed to turn
rated CDRs into paper bills.
page 12.
2. Click the Route Profit button at the top of the page.
3. The billing report page shown in Figure 21 displays.
41
7/21/06
5.
RSM Reporting
Figure 21. Route Profitability Report Example
4. Choose the specific report you want from the Report, i.e., Customer, list.
Note: Default is the Customer report.
5. Select one (or more) Carrier(s) for your report. You can select more than
one by using either one or both of the following methods:
Hold down <Ctrl> while clicking on each individual Carrier.
Select a range by clicking on the uppermost one, then holding down
<Shift> while clicking the bottom one.
6. Select the Host from the list.
8. Enter any date range criteria you wish in the Begin Date and End Date
area. Note that you enter dates by clicking on the calendar icon to the
right of the date fields and clicking on the date you want in the calendar
pop-up.
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.
9. Select a Time Zone from the list.
10. Enter search criteria, if you wish, in the appropriate fields.
42
7/21/06
5.
RSM Reporting
12. Click Show.
CLEARING THE ROUTEPROFIT REPORT

1. To clear the page of entered search criteria, click the Clear button.
43
7/21/06
5.
Field
RSM Reporting
Field Descriptions
Description
Report
Identifies the type of Route Profit report, i.e., Customer, Supplier.
Carrier
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.
Host
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.
Partition
This field provides a list of all partitioned groups. A

partition is defined by a set of realms, endpoints
and regions.
Begin Date
Specifies the beginning date range of CDRs to be

End Date
Specifies the ending date range of CDRs to be

Time Zone
The time zone for time specified in the End Date

field.
Page Number
This field indicates the page number of the displayed information.
Page Length
This field indicates the number of entries to be displayed. The default is 100 lines of displayed information.
Refresh Interval
This field automatically refreshes the report results

without your having to resubmit the request.
VIEWING THE ROUTE PROFIT CONTENT AREA

The route profit content area allows you to view more detailed billing information.
44
7/21/06
5.
RSM Reporting
Figure 22. Route Profit Content Page Example
2. The actual CDRs from which the report is taken can be saved into a file
on your workstation.
Clicking on Download in the column heading (Plan) saves all CDRs
for all plans shown in the table.
Clicking on 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, into a default file named customercdrs.
Locate the directory where you want the file, and click Save.
Note: You can select to save All, Completed, and Error activity using the
Download option.
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 home page.
2. A dialog similar to the one below displays.
Figure 23. Route Profit Printable View Example
Filters
See Filters on page 33.
45
7/21/06
CUSTOM REPORTS
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.
To access the Custom report, follow these steps:
System, on page 12.
2. Click Reporting>Custom.
3. The Custom home page displays
46
7/21/06
RSM Reporting
5.
5.
RSM Reporting
Figure 24. Custom Report Home Page Example.
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.
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. Enter any additional search criteria in the appropriate fields.
47
7/21/06
5.
RSM Reporting
Note: When entering a grouping value, remember to click the check box that
enables that field.
11. Click the Show button.

12. The content area of the custom report displays.
Figure 25. Custom Report Content Page Example
The actual CDRs from which the report is taken can be saved into a file
on your workstation.
12.1 Clicking [All], [Completed], or [Error] in the Download column
heading saves all CDRs for all plans shown in the table.
12.2 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.
13. Use the Previous and Next buttons pages to navigate through the report if
it doesnt all fit on one screen.
48
7/21/06
5.
Field
Dial String
RSM Reporting
Field Descriptions
Description
Use this parameter to specify one or more digits to
match on. Used in conjunction with the Group and
Strip parameters, you can examine any subset of
digits in the dialed number. Remember, 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, with a total for each city.
These three parameters would be set to:
Dial String: 18832
Strip: 4
Group: 5
This setup would first filter on 18832 to select only
calls from the US (188) to India (32). It would then
strip off the four digits that it matched on (18832),
and group (aggregate) the remaining records by the
next five digits in the dialed numbers, which are the
city code.
Region
Specify one region code here. (This field allows

wildcards.)
Duration
Specify a call duration (in seconds) here,

based on the relational operator (>, =, or <) in
the list next to the 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.
ISDN Code
This is the ISDN Disconnect Cause Code.

Enter one numeric code. Clicking the field
label brings up a list of valid codes.
49
7/21/06
5.
Description
IP Address
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 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.
RSM Reporting
Field
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.
Wildcards can broaden the selection.
Customer
This field identifies the customer who is the

traffic originator.
Supplier
This field identifies the supplier who is the

traffic originator.
ASR
Clicking the Display box for this field shows

Answer Seizure Ratio in the report.
ARR

Average Request Rate for ISDN calls.
Average PDD

the average post-dial delay for calls selected.
Total Calls

the aggregate total for all calls matching the
selection criteria.
Rating Status
Used to store the operational state (summarized, marked to be re-rated, etc.) of the rating
process.
50
7/21/06
5.
Description
RSM Reporting
Field
Partition

and regions.
Partition
The quantity of digits to aggregate together when

sorting the report results.
Strip
The quantity of leading digits to be removed

(stripped) from the dialed number before matching
digits and aggregating results.
Display
Allows you to select the group and display the order

by which the fields will display.
Group Order
Lists the fields by group order. You can move the

order of the fields by highlighting the field and clicking either the Up or Down buttons.
Display Order
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.
Host

Begin Date
Specifies the beginning date range of CDRs that is

covered by the report.
End Date
Specifies the range of the query ending date.
Time Zone
Element used with the time transform, any valid

value for a Unix timezone, literally expressed, in
quotation marks.
Page Number
Identifies the page number of the displayed report.
51
7/21/06
5.
Description
Page Length
This field indicates the number of entries to be displayed per page. The default is 100 lines of displayed information per page.
Refresh Interval
This field specifies how often, in minutes, the RSM

automatically refreshes the report.
RSM Reporting
Field
CLEARING THE CUSTOM REPORT

1. To clear the page of entered search criteria, click the Clear button.
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. Initially the system displays the following window.
52
7/21/06
5.
RSM Reporting
Figure 26. SVGViewer
2. Scroll down an select either the Internet Explorer for WIN or the Mozilla
for Win.
3. Follow all instructions.
4. Close your browser window and log in again.
The Unrated CDRs Report

The contents and use of most available RSM system reports are straightforward and self-evident to telecom professionals. The Unrated CDRs report,
however, is somewhat more complex, and it may not always be obvious how
and when it is useful.
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.
53
7/21/06
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:
page 12, and click Reporting>Custom at the top of the page.
The custom report page displays.
2. Enter appropriate grouping criteria. For this example the selected grouping criteria is Dial String, ASR and ARR.
3. At the bottom of the Custom report page, choose Rating Status and select
Unrated.
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. (For help
with selecting dates, see Selecting Dates, on page 19.) 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.
54
7/21/06
RSM Reporting
5.
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 Show requests the report.
Note: Depending on your grouping criteria and other factors, the report can
take several minutes to be displayed.
7. 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.
8. Clicking on the Detail link at the end of any record in the report takes the
report down one level of detail.
9. You can also specify Download criteria by which to view All, Completed,
and Error raw data.
55
7/21/06
RSM Reporting
5.
6
RSM ALARMING
INTRODUCTION
Note: The actual web pages you see may differ slightly from the illustrations
shown in this guide, based on your browser and its computer platform.
The RSM system provides an alarming function to alert appropriate personnel

of exceptions to normal operations, so that appropriate management or technical action can be taken.
With RSM, the user sets up those conditions under which an alarm is triggered, and what the system does when one is triggered. This setup function is
accessed by clicking on the Alarming tab at the top of the RSM home page
(see Figure 13, Engineering Home Page Example, on page 28). All the user
activities described below are performed from pages in RSM web-based
interface.
Specifically then, the process is:
1. The user defines an action to be performed when an event occurs.
2. The user then specifies a set of conditions that define an alarm, tying to
that alarm one or more of the actions defined in step 1.
3. A real-world event, meeting the conditions set in step 2, triggers the
alarm.
4. An entry is placed in the Event list, and the action or actions defined for
that alarm are performed.
The RSM system can detect an alarm in two ways, as follows:
system-level log files or
call detail record (CDR) files.
56
7/21/06
RSM Alarming
6.
This chapter describes how to use to the RSM systems alarming function.
Alarming is a setup function to which the normal user (that is, not only the
system administrator) has access.
<<6. RSM Alarming>>
In both cases, RSM scans files written by the system. RSM looks for specific
conditions, such as a processor restart (system log), or a customer exceeding
their allotted minutes (CDR).
Defining Alarms
An alarm is a set of conditions defining an operational exception, intended to
trigger one or more actions. An event is an instance of that alarm.1
There are two categories of alarm, Log and CDR. The basic procedures for
administering them are the same, but they have two separate add/update
screens because of having different parameters by which to define an alarm
condition for each.
CDR alarms are triggered based on the traffic patterns detected from the
CDRs generated on an MSx.
Log alarms are triggered based on the events that appear in the MSx log
file.
So then, setting up RSM alarming involves two high-level operations: creating (or changing) actions, and defining (or changing) alarms.
Each defined alarm appears on one line. In addition to providing information,
the first three columns in the listing function as follows:
The first column contains a trash can icon that allows you to delete that
alarm.
The second column, labeled Status, 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 off and then turn it back on later, just by clicking the light-bulb
icon again.
The third column, Partition is for Administrator's only.
The fourth column, labeled Name, gives access to the Update Alarm page,
so that you can edit the parameters that define it.
1. Events are collected in the file: /var/log/iserver.log, in plain text format, which
can be viewed with a text tool such as more (or less) or pg.
57
7/21/06
6.
RSM Alarming
Once one or more actions are defined, alarms may be created that trigger
those actions. The procedures for creating and changing alarms are presented
in this section.
<<6. RSM Alarming>>
The remaining columns on the listing summarize the parameters that define
the alarm.
New Alarm Features in RSM 4.2

In RSM Release 4.2, there is one new feature in the alarms functionality, as
follows:
The Alarm Types now have a full name, not abbreviated.
For example, Average Success Rate, Average Post Dial Delay.
Partition - this option is for System Administrators only. It allows the
Admin user to view and use entries made by non-admin users.
Applied only to alarms that do not have quantity accumulators, i.e., no
Dollar Amount or Gateway Minutes. The user can select particular endpoints which will serve as additional filtering criteria. The Group by check
box was renamed to Group by all/selected endpoints.
CDR Profit/Loss Alarm
Calculates the profit/loss for each CDR. This is triggered when the configured threshold is met.
The Alarm Type field displays the alarm name in complete name format
rather than abbreviated format. For example, CDR Error Description vs.
CDR Error Desc.
Test action buttons are available to test available action(s). Prior to configuring the System alarm you can test whether the action is or is not
working by clicking one of these buttons.
The Conditions are spelled out and two new conditions were added, i.e.,
less than equals and greater than equals. The condition equals was
removed.
The options are:
less than
less than or equal to
greater than
greater than or equal to
58
7/21/06
RSM Alarming
6.
<<6. RSM Alarming>>
Under Endpoint, the source check box was changed to two radio buttons
with options for Origination/Source and Termination/Destination.
The Regions/Supplier/Customer was separated out of the endpoint table
and given its own unique location. The Regions field has an auto-complete action, e.g., if you Add an Alarm an enter Italy-Proper and you add a
second alarm and enter Italy-Proper, the region name is automatically
listed.
In Release 4.2, the user has the capability to separately querying any endpoint on the database. In the current environment, a temp table is created
triggering the alarm, a query is then made against that table taking into
consideration all endpoint related information.
Therefore the alarm is triggered if any of the chosen endpoints (any of all
endpoints in case no endpoints particularly chosen) satisfies the query
condition.
Note: The check box is automatically disabled if you are creating or updating
"Dollar Amount" and "Gateway Minutes" alarm types. Also, the check
box can be used with or without "Source" check box and used with all
existing conditions and filters.
ADMINISTERING RSM ALARMS

Administration of alarms in RSM begins with clicking the Alarming tab at the
top of the RSM home page. The system initially places you on the CDR
Alarms page. Setting up RSM alarming involves two high-level operations:
creating (or changing) actions and defining (or changing) alarms.
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
59
7/21/06
6.
RSM Alarming
Re-lay Outing applies to the Add/Update CDR alarm and log page. The
size in which the information is displayed is increased so that the information is well presentable.
<<6. RSM Alarming>>
different partition. Only users in an Admin partition can see data from
all other partitions.
Alarming Tab
The Alarming tab contains the following menus and submenus. The CDR
menu is active by default.
Alarms
Table 3. Alarming Tab Menus
6.
Function
Alarms Events
Used to set, modify, and delete alarms events,

which are occurrences of alarm conditions.
CDR Alarms
Used to set, modify, and delete CDR alarms.
Log Alarms
Used to set, modify, and delete CDR alarms.
Actions
Used to set, modify, and delete actions, which are

conditions for a log alarm.
RSM Alarming
Menus
Alarm Types
The Alarm Types are as follows:
Table 4. Alarm Types

Alarm Type
Description
Average Call Duration (ACD
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.
Average High Packet Loss
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 time exceeds a configured threshold. The average is calculated using
values from both sides of a call.
60
7/21/06
<<6. RSM Alarming>>
Table 4. Alarm Types (Contd)

Alarm Type
Average Low Voice Quality
Description
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.
6.
RSM Alarming
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.
Average Post Dial Delay

(APDD)
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 (ARR)
Average Request Rate is essentially ASR calculated within a subset of the total calls. ASR is the
ratio of the normal calls (ISDN code = 16) to the
total calls and ARR is the ratio of the normal calls
(ISDN code = 16) 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.
Average Success Rate (ASR)
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
61
7/21/06
<<6. RSM Alarming>>

Alarm Type
Description
Cdr Error Description
This alarm triggers when an internal error causes a

call to disconnect. Multiple CDR errors could be
configured for a single alarm.
High Packet Loss
This alarm is based on the Packets Lost and Packets Received values in the CDRs.
6.
Low Voice Quality
RSM Alarming
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 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.
Post Dial Delay (PDD)
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.
62
7/21/06
<<6. RSM Alarming>>

Description
Dollar Amount
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.
Gateway Minutes
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, reenable it manually from the CDR Alarm page. This
trigger does not have the "trigger off" capability.
Profit/Loss
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.
6.
RSM Alarming
Alarm Type
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
Event page provides a list of events having occurred since the last time the list
was manually cleared.
To view Alarm Events, follow these steps:
1. Sign into the RSM system as described in Logging into the RSM System,
on page 12.
2. Click Alarming>Alarms Events.
3. The Alarms Event home page displays.
63
7/21/06
<<6. RSM Alarming>>
Figure 27. Alarm Events Home Page Example
RSM Alarming
6.
4. Click the <Prev and Next > buttons if the report doesn't all fit on one
screen.
Note: The event page is automatically refreshed every 60 seconds.
Field Descriptions
Field
Description
Date Time
The system date and time stamped onto the record

when it was entered into the event log file.
Location
This field is not applicable to CDRs, only to Log

Alarms.
Description
The text from the Description field in the alarms

definition.
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.
Clearing the Alarms Events

To clear all information from the page, do the following:
1. Click Clear.
WARNING: Clicking removes all output information from the page. The
cleared information cannot be retrieved.
64
7/21/06
<<6. RSM Alarming>>
CDR Alarms
CDR alarms are triggered based on the traffic patterns detected from the
CDRs generated on an MSx. CDR alarms can be viewed, enabled/disabled,
added, updated, and deleted via the CDR Alarms menu option. The CDR
Alarms page provides, line-by-line, a listing of current alarms with the following information:
the status of the alarm, either Enabled or Disabled
the name assigned to the alarm (clicking on the name also takes you to an
update screen in which the parameters of the alarm can be edited.
the host or device that sends the CDRs to RSM
a description of the alarm
the action to be performed when the conditions for the CDR alarm are met
The display initially lists those sets of conditions currently defined as producing CDR alarms. That is, an alarm that is triggered when the contents of CDR
files are examined for specific conditions. When the conditions are met, an
action is taken.
Figure 28. CDR Alarms Home Page
65
7/21/06
RSM Alarming
6.
Note: Rather than deleting an alarm, you can disable it by clicking on the
Enabled icon. Then, when you want to re-enable the alarm, click on
the Disabled icon.
<<6. RSM Alarming>>
Adding a New CDR Alarm

To add a new CDR alarm, follow these steps:
Note: At this time no more then 200 active alarms at one time is supported.
Having more then this number affects performance and will eventually
cause the db server to run out of connections.
on page 12.
2. Click the Alarming tab.
RSM Alarming
3. By default the CDR Alarms page displays.
Note: The CDR Alarm page shows a list of currently-specified log alarms.
4. Click on the Add button at the top of the page.

5. The Add CDR Alarm page displays.
6.
66
7/21/06
<<6. RSM Alarming>>
Figure 29. Add CDR Alarm Page Example
RSM Alarming
6.
6. Select the type of alarm from the Alarm Type list. Some of the other fields
will be enabled/disabled depending on your choice of alarm type.
Note: RSM seeds the Alarm field for you, but you are free to edit the fields
contents to whatever makes sense, given the other conditions you
associate with it; i.e., the contents of the other fields in the Add CDR
Alarm page.
7. Select a Partition from the list. This is for the "root" user only.
8. Press <Tab> or click in the Name box, and enter a name for this set of
conditions.The system seeds the name with the contents of the alarm type
field, but you can alter that to whatever makes sense given the other conditions you associate with it, i.e., the contents of the other fields in the
RSM Add CDR Alarm dialog box.
67
7/21/06
<<6. RSM Alarming>>
9. 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.
10. From the On Trigger Action, choose a block action to turn on the trigger.
11. From the Off Trigger Action, choose a block action to turn off the trigger.
12. 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 or is not working.
13. In the Description field, enter the text that you want to appear on the Event
listing page when this alarm occurs. Again some generic text is supplied
for you to customize, either adding to or replacing it.
14. The parameters in the Conditions area allows you to specify individual
data found within CDRs for RSM to use as alarm triggers.
15. The parameters in the Endpoint area allows you to specify endpoint data
found within the CDRs.
16. The Region/Supplier/Customer area allows you to specify region, supplier,
and customer details.
17. Click the Additional Filters link to display additional alarm filters.
18. 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.
19. The parameters in the System Load Filter area provide ways to specify filter data within CDRs for RSM.
20. When finished entering data, click the Submit button.
21. A message similar to the one below displays.
Successfully added alarm 'xxxx'.
22. Your new alarm is saved, the dialog box closes, and you are returned to
the Alarm page.
23. The new alarm is listed on the Alarm page.
Note: To activate the new alarm, click the "disabled" alarm to make it
enabled.
68
7/21/06
RSM Alarming
6.
<<6. RSM Alarming>>
Field Descriptions
Description
Alarm Type
Identifies the alarm type, i.e., ASR, CDR Error

Description, etc.
Partition

and regions. ONLY FOR ROOT USER.
Name
Allows you to enter a name for this set of conditions. Note that RSM also seeds Name with the
contents of the alarm type field, but you can add to
or change that.
Host
A host can be an MSW/MSC, 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 MSW/MSC,
the hostname of the machine is filled in as default.
On Trigger Action
When this set of conditions is met, it triggers a certain action to be triggered on.
6.
All alarms can have two sets of actions assigned to

them. The first set of actions (ON-trigger actions)
are performed when the trigger condition is
reached. For example, if the trigger condition is
ASR < 50%, and the ASR falls below 50%, then the
ON-trigger actions are performed. 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
When this set of conditions is not met, it triggers a

certain action to be triggered off.
Description
The text from the Description field in the alarms

definition.
Key
Shows the applied condition of the alarm type

selected in the Alarm Type field. For example, in
the Alarm Type field you selected Average Packet
Delay Variance (APDV). The key field displays
apdv.
69
7/21/06
RSM Alarming
Field
<<6. RSM Alarming>>
Field
Condition
Description
Some key names have values associated with
them. This list 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)
> (greater than)
Bear in mind that the equal to operator has limited

value with numeric fields, since only an exact
match will meet the condition. In addition, gateway
minutes reports should always use the greater than
operator, since the exact number of minutes would
virtually never exactly equal the trigger value.
Value (sec)
This field identifies the value that was added to

build the condition. This field changes based on the
Alarm Type selection. For example, if you selected
Average Call Duration (ACD) this field would read
as Value (sec). If you chose an Alarm Type of Average Packet Delay Variance (APDV) the filed would
read as PDV (msec).
Min CDR Count
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.
70
7/21/06
RSM Alarming
6.
= (equal to)
<<6. RSM Alarming>>
Field
Depending on the alarm type, either:
If the Alarm Type 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.
If the Alarm Type is 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.
6.
RSM Alarming
Duration (min)
Description
Note: Note that a Gateway Minutes

alarm is automatically disabled
after being triggered. You can
re-enable it from the Alarm >
CDR page, when youre ready
runs every sample period seconds, measuring the errors of
that type during the preceding
Duration minutes. End point
and Port are optional.
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.
Available endpoints
Either a regID 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 end point by regID
or IP address. If you enter the same end point by
regID and IP address, you will have duplicate
events. Also, regID or IP address are interchangeable and case sensitive.
lookup - looks up the end points as

defined in the RSM system.
71
7/21/06
<<6. RSM Alarming>>
Field
Description
Selected Endpoint
Displays the Endpoints you have selected from the

Available Endpoints list.
Evaluate All Available Endpoints Individually
Allows the user to separately query any endpoint on the database.
Endpoints
Allows the user to select endpoints by origination/

source or termination/destination.
Regions
This field describes a region, used to group one or

mode dial codes.
6.
RSM Alarming
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.
Supplier
The supplier is the traffic terminator.
Customer
The customer is the traffic originator.
Start Date
This is a time filter that identifies the date and time

at which the alarm goes into effect.
End Date
This is a time filter that identifies the date and time

at which the alarm ceases to be in effect.
Start Week Days
This is a time filter that identifies the start day(s) of

the week.
End Week Days
This is a time filter that identifies the end day(s) of

the week.
72
7/21/06
<<6. RSM Alarming>>
Field
Start Time
Description
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.
6.
End Time
The point in time at which this rate ceases to be in

effect. Selected from a 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.
System Load
Currently, this field is used to specify the port usage

(in percentage value) on the iServer.
RSM Alarming
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.
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 offpeak or maintenance conditions.
73
7/21/06
<<6. RSM Alarming>>
Field
Condition
Description
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)
> (greater than)
= (equal to)
6.
Value (%)
RSM Alarming
Bear in mind that the equal to operator has limited

value with numeric fields, since only an exact
match will meet the condition. In addition, gateway
minutes alarms should always use the greater than
operator, since the exact number of minutes would
virtually never exactly equal the trigger value.
In this field, specify the numeric value relating to
the comparison operator, specified in the Condition
list. For gateway minutes or Error Description CDR
Alarms, this must be a whole number (no decimals). For ASR reports, enter only the number,
without a percent sign (%).
UPDATING A CDR ALARM

To modify a alarm, follow these steps:
1. Click the alarm (under the Name column).
2. The Update CDR Alarm page displays.
74
7/21/06
<<6. RSM Alarming>>
Figure 30. Update CDR Alarm Page Example (Partial

View)
RSM Alarming
6.
Note: The field descriptions for Update CDR Alarm are the same as those for
Add CDR Alarm.
3. When all updates have been made, click the Submit button.
4. Click the Back button, to close the Update CDR Alarm page.
DELETING A ALARM
To delete a Alarm, follow these steps:
1. Locate the CDR Alarm you wish to delete.
2. Click the trash can icon.
75
7/21/06
<<6. RSM Alarming>>
Figure 31. Delete Alarm Dialog Example
6.
4. Click the OK button to delete the selected alarm.

Successfully deleted alarm xxxxx.
2. Click the Cancel button to cancel out of the deletion process and return to
the Alarm page.
LOG ALARMS
Log alarms are triggered based on the events that appear in the MSx log file.
Log alarms can be viewed, enabled/disabled, added, updated, and deleted via
the Log Alarms menu option. The Log Alarms page provides, line-by-line, a
listing of current alarms with the following information:
a delete shortcut used to remove the alarm.
the status of the alarm, either Enabled or Disabled
Note: Rather than deleting an alarm, you can disable it by clicking on the
Enabled icon. Then, when you want to re-enable the alarm, click on
the Disabled icon.
the name assigned to the alarm (clicking on the name also takes you to an
update screen in which the parameters of the alarm can be edited.
the host or device that sends the CDRs to RSM
a description of the alarm
the action to be performed when the conditions for the Log alarm are met
The display initially lists those sets of conditions currently defined as producing log alarms, that is, an alarm that is triggered when the contents of log files
are examined for specific conditions. When the conditions are met, an action
76
7/21/06
RSM Alarming
5. A message similar to the following displays:
<<6. RSM Alarming>>
is taken. Actions can take several forms, as described in ESM: the Events and
Statistics Module (optional), on page 8.
Accessing the Log Alarms

To access log alarms, follow these steps:
on page 12.
2. Click on Alarming > Log Alarms.
3. The Log Alarms home page displays.
Figure 32. Log Alarms Home Page Example
Note: The Log Alarm page shows a list of currently specified log alarms.
4. The CDR page shows a list of currently-specified CDR alarms.

5. Click the Prev and Next buttons if the report doesn't all fit on one screen.
77
7/21/06
6.
RSM Alarming
Note: At this time no more then 200 active alarms at one time is supported.
Having more then this number affects performance and will eventually
cause the db server to run out of connections.
<<6. RSM Alarming>>
Field Descriptions
Description
Status
This field identifies whether or not the alarm is

enabled or disabled.
Partition Name
This field identifies the name given to the set of

conditions.
Host

Description
This field provides descriptive text entered on the

log alarm listing page.
Action
This field identifies one or more actions to be performed when the conditions for a log alarm are met.
6.
ADDING A NEW LOG ALARM

To add a new log alarm, follow these steps:
1. Click on the Add button at the top of the page.
2. The Add Log Alarm page displays.
78
7/21/06
RSM Alarming
Field
<<6. RSM Alarming>>
Figure 33. Add Log Alarm Page Example
RSM Alarming
6.
Note: If at any time you wish to leave a dialog without saving your work, just
click the Back button.
3. Select the type of event from the Event type list. Note that RSM seeds the
Event field for you, but you are free to edit the fields contents to whatever makes sense given the other conditions you associate with it; i.e., the
contents of the other fields in the Add Alarm dialog box.
4. Press <Tab> or click in the Name box, and enter a name for this set of
conditions. Note that RSM also seeds Name with the contents of the alarm
type field, but you can add to or change that.
5. In the Action field, highlight one or more actions to be performed when
the conditions for this log alarm are met.
6. Click the Test Action buttons if you wish to test available action(s).
7. 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.
8. Finally, enter a longer text description of the alarm. This descriptive text
appears on the log alarm listing page, in the Description column.
9. When finished entering data, click the Submit button.
79
7/21/06
<<6. RSM Alarming>>
10. Your new alarm is saved, and the dialog box closes, and you are returned
to the Alarm page.
Successfully added alarm xxxx.
12. The new alarm is listed on the Alarm page.
Field Descriptions
Field
6.
Description
A descriptive name of the event that was triggered
on the iServer, that triggers the log alarm.
Event
The actual text logged into the iserver.log file on the

iServer. The event that triggers the log alarm.
Name
This field identifies the name given to the set of

conditions.
Action
This field identifies one or more actions to be performed when the conditions for a log alarm are met.
Host

Description
This field shows descriptive text entered on the log

alarm listing page.
RSM Alarming
Event Type
UPDATING LOG ALARMS

To update an alarm that is already defined, follow these steps:
1. On the Name column, double-click the alarm you wish to modify.
2. The Update Log Alarm page displays.
80
7/21/06
<<6. RSM Alarming>>
Figure 34. Update Log Alarm Example
RSM Alarming
6.
Note: The field descriptions for Update CDR Alarm are the same as those for
Add CDR Alarm.
3. You are free to change any of the parameters specified on the screen. If
you change the Event type, you may also need to change any parameters
associated with it. All parameters are accessible to all alarm types.
4. For changes to fields other than to the Event type, just migrate 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.
5. Once your changes are all entered, click Submit, and the dialog box
closes.
6. Click the Back button to discard any changes you made.
DELETING A ALARM
To delete a Alarm, follow these steps:
1. Click the trash can icon, i.e., the trash can to the left of the Status column.
81
7/21/06
<<6. RSM Alarming>>
2. A dialog similar to Figure 35 displays.
Figure 35. Delete Log Alarm Dialog
3. Click the OK button to delete the selected alarm.

the Log Alarms page.
ALARM ACTIONS
Actions are performed when one or more of the following conditions for a log
alarm are met.
SNMP Trap
Email
Execute Script
Log
82
7/21/06
RSM Alarming
6.
<<6. RSM Alarming>>
ACTION TYPES
The following is the list of new actions that were added in release 4.X.
Table 5. Action Types Listing
Block Endpoints
Description
This is not a new alarm, but a change to the existing alarm. 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 instead
sets the max calls to the trickle value. This 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 usage of 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 the ARM
license is enabled.
Executive Script
This action executes an external script file. An

external script/program could then be used to
extend the functionality of actions provided by the
RSM system.
Log
This action logs the alarm to either syslog or a to a

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
This action lowers the route priority of all route

belonging to region and carrier as specified in the
alarm.
Mail
This action sends an email to a recipient. To specify multiple recipients, list them with a comma separator.
83
7/21/06
6.
RSM Alarming
Action
<<6. RSM Alarming>>
Table 5. Action Types Listing (Contd)

Description
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.
Set Route Priority
This action modifies the route priority by the specified value (the existing priority
will be changed by this amount).
SNMP Trap
This action sends a SNMP v1 trap to the configured

trap receiver. The trap is an enterprise specific trap
with an OID of .1.3.6.1.4.1.7684.1.1.1. An additional OID of .1.3.6.1.4.1.7684.1.1 specifies the
specific alarm details, including the alarm name
and alarm description.
6.
RSM Alarming
Action
See Example below:

1.3.6.1.4.1.7684.1.1.1
genericTrap OBJECT-TYPE
SYNTAX OCTET STRING
TRAP
DESCRIPTION "This is a generic trap from the
RSM; the object value contains the description of
the configured event that occurred on the RSM
server."
::= { ISO(1) org(3) DOD(6) Internet(1) private(4)
enterprises(1) nextone(7684) RSM(1) traps(1) 1 }
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 NEW ACTION

To define an Action, follow these steps:
Note: When the action is triggered, a email is sent to the specified email
address.
1. Log into the RSM system as described in Logging into the RSM System,
on page 12.
84
7/21/06
<<6. RSM Alarming>>
2. Click on the Alarming>Actions link.

3. The Actions home page displays.
4. Click the Add button.
5. The Add Action page displays.
Figure 36. Add Action Page Example
RSM Alarming
6.
6. Select an action Type from the list.

Note: The dialog shown above differs for each selection under Type, since
each selection has different data. For example, if you select a Type
and Block from the list, the Add Action page re-displays with information unique to this selection.
7. Give the action a Name.

8. Enter the Trickle.
9. Click the Submit button.
Note: If at any time you wish to leave a dialog without saving your work, click
Back.

Successfully added action xxxx.
85
7/21/06
<<6. RSM Alarming>>
UPDATING AN ACTION
To update a action, follow these steps:
1. On the Actions main page, click the action you wish to update.
2. The Update Action page displays.
Figure 37. Update Action Page Example
RSM Alarming
6.
3. Make all necessary changes and click the Submit button.

Successfully updated the action
DELETING AN ACTION
To delete a Action, follow these steps:
1. Click the trash can icon, next to the action you wish to delete. The following dialog displays.
Figure 38. Delete Action Dialog Example
86
7/21/06
<<6. RSM Alarming>>
2. Click the OK button to delete the selected action.

Successfully deleted action xxxx.
the Action page.
RSM Alarming
6.
87
7/21/06
7
RSM SYSTEM
INTRODUCTION
This section provides information on the following System tab features:
Configuration
Logging
Status
License
Branding
Devices
Partitioning
Archiver
Audit Trail
CDR Import/Export
Synchronization
System Alarms
Accessing the System Home Page
7.
To access the System home page, follow these steps:
RSM System
page 12.
2. Click the tab labeled System.
3. The System home page displays.
88
7/21/06
<<7. RSM System>>
Figure 39. System Home Page Example
The System tab contains the following menus and submenus. The Configuration menu is active by default.
Table 6. System Tab Menus

Submenu
Configuration
Used for configuring RSM application parameters to fine-tune application performance as

well as to configure the application properties,
such as, e-mail and logging configuration and
enabling/disabling rating.
Logging
Status
Function
7.
Used for debugging and general troubleshooting base on logical parts (modules) RSM.
CDRs
Displays status of RSM as well as details of

processes being run, including ID, total CDRs,
start and end date.
Users
Displays information on the users currently

logged into RSM, including user name, partition, and login time.
RSM System
Menus
89
7/21/06
<<7. RSM System>>

Menus
Function
License
Displays the License details as well as provides an update feature through which these
details can be modified.
Branding
Allows the user to customize the look and feel of the

user interface.
Devices
Provides a way to add and update MSx device information within the RSM system.
Partitions
Used to create, view, and update partitions. Partitioning is the method of creating virtual RSM and
iServer systems. Each partition is defined by a set of
realms, endpoints, and regions.
Users
Used to add a system user, assigning them to a partition and setting permissions. Also allows you to
view as well as update information for a user.
Access List
Used to add an access list as well as to view and

update information for a access list partition.
Archiver
Used to configure RSM Archiver services. This

allows the user to back up, delete, or archive CDRs
and Provisional data stored on the RSM server.
Audit Trail
The purpose of the audit trail is to identify each CDR

that comes from a system associating the CDRs to
the system alarms and reports you can filter onto
the iServer system. The audit process is used to
audit the trail of changes done to the system, i.e.,
any input data.
CDR Import/Export
Used to set up Import and Export CDR streams.

Import CDR streams are used to import third party
CDRs into the RSM system. Export CDR streams
are used to export CDRs stored in the RSM system
to an external system (such as a billing server).
CDR Errors
7.
The CDR Receptor module (CRM) that NexTone

RSM provides as a CDR receiving interface.
RSM System
Partitioning
Submenu
90
7/21/06
<<7. RSM System>>

Menus
Submenu
Function
Synchronization
Provides a means for the user to synchronize the

MSx to RSM database and vice versa, when inconsistencies are detected.
System Alarms
Used to add system alarms types of Audit, Bad Cdr

alarm, Cdr Alarm Failed to run on time, and Failed
alarm action. User can define the customized action
to be executed for triggering of the system alarms.
CONFIGURATION
The Configuration page is used for configuring RSM application parameters
for fine tuning the application performance as well as configuring the application properties, such as, mail configuration, enable/disable rating etc.
Accessing the Configuration Home Page

To access the Configuration home page, follow these steps:
1. Click System>Configuration.
2. The Configuration home page displays.
RSM System
7.
91
7/21/06
<<7. RSM System>>
Figure 40. Configuration Home Page
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.
RSM System
7.
92
7/21/06
<<7. RSM System>>
Field Descriptions
Field
Description
Enable Rating
This field allows you to select whether or not to rate

the call.
Table partition size (hrs)
The duration of CDR data that each CDR table will

contain, in hours. The default is 24 hours.
Normal call duration
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.
Error call duration
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.
Dial Code Type
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 list of dial code types.
CDRs contain three different dialed number fields,
as follows:
FRMSRC - The number as dialed by the originator
AFTERSRCCP - The number after applying the source
calling plan
ATDEST - The number as dialed to the terminator.
Note: 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 RSM
Regions table.
This controls if there is any automatic re-rating or

authentication of unrated entries in the table.
The default is FALSE.
Rerater Instances
The number of Rerater instances to use when rerating tables.
Default page length
The number of records displayed on a default page

unless the user specifies otherwise.
RSM System
Rerate Automatically
7.
93
7/21/06
<<7. RSM System>>
Field
Description
Max page length
The user cannot specify a page length longer than

this number.
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

mark the rows with medium threshold as configured
in User properties. For example, #FF9933.
Default low threshold color

mark the rows with low threshold as configured in
User properties. For example, #FF6633.
Session Timeout (in min)
This is used to configure the session timeout in

case of inactivity on the RSM Console. The user
session time out after the specified time in case of
inactivity.
Smtp Server
Identifies the SMTP Server.
Pop Server
Identifies the POP Server.
Email User
Identifies the email user.
Email Password
Identifies the email password.
Email From
Identifies the email sender.
Note: These e-mail settings are used

by the RSM to send our alarm
e-mails.
This field is the length used to compute a routes priority. This field is generated from the Routing LCR.
Purge Audit Records Days
The audit records older than the specified.
Auto Sync master
The default value of the DB Sync Master when a

new msw is added.
Auto Sync Period (minutes)
The time interval between DB Sync detections, i.e.,

DB Sync runs periodically with this interval.
7.
RSM System
Set Dial Code Length
94
7/21/06
<<7. RSM System>>
LOGGING
The RSM Logging feature provides the user with a means 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 Home Page

To access the Logging home page, follow these steps:
1. Click System>Logging.
2. The Logging home page displays.
RSM System
7.
95
7/21/06
<<7. RSM System>>
Figure 41. Logging Home Page
3. Make all necessary changes and press the Submit button.
RSM System
7.
96
7/21/06
<<7. RSM System>>
Field Descriptions
Field
Description
Logfile Path
Provides the logfile path, e.g., /var/log/bn.log
Number of logfiles
Identifies the number of logfiles, e.g., 1.
Max logfile size
Identifies the maximum logfile size, e.g., 10000000
All
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
Specifies the logging level for the reports module.
XMLMessaging
Specifies the logging level for the xml messaging

module.
Rating
Specifies the logging level for the rating module.
CDRSImportExport
Specifies the logging level for the CDR Import/

Export module.
Common
Specifies the logging level for the Common module.
DBSync
Specifies the logging level for the DBSync module.
ProvisionReport
Specifies the logging level for the ProvisionReport

module.
Routing
Specifies the logging level for the Routing module.
RatingImport
Specifies the logging level for the RatingImport

module.
WebServices
Specifies the logging level for the web services

module.
Alarms
Specifies the logging level for the alarms module.
Summarizer
Specifies the logging level for the Summarizer

module.
Archiver
Specifies the logging level for the Archiver module.
RSM System
7.
STATUS
97
7/21/06
<<7. RSM System>>
The Status page provides a diagnostic and debug feature which assists users
and technical support in analyzing server performance and debugging performance problems in the field.
Accessing the Status Page

To access the Status home page, follow these steps:
1. Click System>Status.
2. The Status page displays
3. Below is a sample of the Status home page.
Figure 42. Status Home Page Example
4. Use the < Prev and Next > buttons to navigate pages if the report doesn't all
fit on one screen.
5. When you click More Information you can view the full Status page.
98
7/21/06
RSM System
7.
<<7. RSM System>>
Figure 43. More Information Page Example
6. Clicking the Show button on any status element displays more details on
that element.
Note: Clicking the button on the Activity Log field will clear ALL activity log
information.
7. Click Close to exit out of the Status page.
Content Area Summary

Below is a summary for the Status page content area:
Data Summary - this sections provides details on the number of MSWs
and partitions on the system, number of endpoints configured, and there is
also a button showing the number of endpoints per MSW and partition.
Users - this section provides user details related to the number of users on
the system and the number of user logged in
RSM System
Versions - this section provides version number for the RSM, JVM,
Jboss, Tomcat, and Mysql software.
JVM Diagnostics - this section shows JVM related details, i.e., name,
uptime, free memory, max memory, and total memory.
Database Information - this section provides InnoDB free space and
connection pool detail to include the following:
JDBC Pool Size: Number of connections in the pool
7.
99
7/21/06
<<7. RSM System>>
Connections in Use: Number of connections that are currently being

used
Connections created: Total number of connections that have been created after the pool was instantiated
Connections destroyed: Total number of connections that have been
destroyed after the pool was instantiated
Note: There are two db connection pools in the RSM namely BN pool and
Rater pool. The status page will show details for both pools.
CDR Details - this section provides CDR details to include the number of
CDR tables, CDRs in the system, CDR range, oldest/latest CDR per
MSW, report optimization and partition up-to-date.
Jobs Cache - 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.
Number of CPU - this section 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%.
Disk Usage - this section provides the output of "df -h" on the UNIX console and reports on file system disk space usage. The following details
will be provided for each file system.
Name
7.
Size
Used
Use percentage
Mount point
Data Cache - shows the content of the hybernet cache. It includes bean
name, number of beans cached and the total size of occupied by each
bean.
100
7/21/06
RSM System
Available
<<7. RSM System>>
Viewing Status CDRs Content Page

The Status CDRs content page automatically appears when you click on Status>Users.
Below is a sample of the Status Users Content page.
Figure 44. Status Users Content Page Example
fit on one screen.
Field Descriptions
Field
Description
User
Identifies each user logged onto the system.
Partition
Identifies the partition assigned to each user.
Client IP
Identifies the IP address of the machine that each

user logged onto.
Login Time
Identifies the login date and time for each user.
Last Activity
Identifies the latest date and time of activity for

each user.
RSM System
7.
101
7/21/06
<<7. RSM System>>
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 hostid.
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 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, follow these steps:
1. Click System>License.
2. The License home page displays.
RSM System
7.
102
7/21/06
<<7. RSM System>>
Figure 45. License Home Page Example
Updating a License
To update a license, follow these steps:
1. From the License home page, click the Browse button to select the License
file to update.
2. Click the Update button.
3. The Update License page displays.
Field Descriptions
License file
Description
7.
Allows you to select the license file to update.
BRANDING
The Branding option allows the System Administrator to update the web interface so that every member of a partition has the same look and feel when
viewing their web interface.
103
7/21/06
RSM System
Field
<<7. RSM System>>
Accessing Branding
To access the Branding page, follow these steps:
1. Click System>Branding.
2. The Branding home page displays.
Figure 46. Branding Home Page Example
ADDING A BANNER
Only the System Administrator can add a banner via the Add Banner window.
1. Select a Banner file by clicking the Browse button.
2. Select the file, preferably a .gif file, containing your banner.
IMPORTANT !The banner should be no larger than 60 x 40.
4. The Branding page now displays with your banner next to the RSM logo
with the following message displayed:
7.
RSM System
Logo changed successfully.
104
7/21/06
<<7. RSM System>>
Figure 47. New Banner Example
UPDATING THE BANNER

To update the banner and replace it with a new banner, follow these steps:
1. Click the Browse and locate a new banner logo.
Logo changed successfully.
IMPORTANT !You must log out and log in to activate the new banner.
REMOVING A BANNER
To remove the banner, follow these steps:
1. Go to the Branding page.
7.
2. Click the Browse button and locate the logo you wish to delete.
3. Click the Remove button.
RSM System

Logo removed successfully.
DEVICES
The devices section provides a way to configure iServer system information
within the RSM system. There are two ways entries are created in this table:
105
7/21/06
<<7. RSM System>>
When an iServer streams CDRs to this RSM system

When a user manually creates an entry
Accessing the Devices Home Page

To access Devices, follow these steps:
1. Click System > Devices.
2. The Devices home page displays.
Figure 48. Devices Home Page Example
Note: The column Master actually represents the msw db status. For the
redundant system it displays the database Master/Slave status. For
the standalone system it always displays Master.
7.
RSM System
Adding a Device
To add a device, follow these steps:
1. From the Device home page, click the Add button.
2. The Add Device page displays.
106
7/21/06
<<7. RSM System>>
Figure 49. Add Device Home Page Example
3. Enter the appropriate values for the Cluster ID (unique for a given clustered iServer 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 iServer.
5. Enter an IP Address. This is the management IP address of the iServer.
6. Enter a Description.
7. Enter the MswUsername.
8. Enter the MswPassword.
Note: When the RSM detects a CDR stream from a iServer system, the corresponding entry in the devices table (system created or user created)
is marked as undeletable and the user will not be able to delete them.
However the user can edit all information other than the device name
on such a non-deletable entry. Also, for CDR streams coming from
devices other than the NexTone iServer systems, the IP address and
password fields have no meaning.
9. The entries in this table are used:

9.1
When an admin user launches the RSM console, all iServer entries
from this table will be auto-populated into the main screen.
107
7/21/06
RSM System
7.
<<7. RSM System>>
9.2
The user and partition configuration will display the devices from
this list, so the admin can assign one of the systems as the iServer to
which the partition/user belongs to.
9.3
When a user launches RSM console and makes any changes (endpoints, realms, etc.), the iServer from the user preference will be
used, and the corresponding IP and passwords from the devices
table will be used for the communication.
9.4
During LCR>Update Device operation, the iServer 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.
10. Enter the MswPort.
11. Enter the Msw Database IP
12. Select an Autosync Master from the list.
14. A message similar to the one below displays:
Device xxxx is added into the database
RSM System
7.
108
7/21/06
<<7. RSM System>>
Field Descriptions
Field
Description
Cluster ID
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.
Name
A logical name of the device. This can be either

configured or inferred from the CDR content.
Ip Address
Identifies the management IP address of the iServer.
Description
A user defined description of the Masks system

(optional).
MswUsername
Allows you to enter the Msw user.
MswPassword
Allows you to enter the password.
MswPort
Allows you to enter the Msw port.
Msw Database IP
Allows you to enter the Msw database ip.
Autosync Master
The default value of the DB Sync Master when a

new msw is added.
Updating a Device
To update a device, follow these steps:
1. Click on the device name to be updated.
2. The Update Device page displays.
RSM System
7.
109
7/21/06
<<7. RSM System>>
Figure 50. Update Device Home Page Example
3. Make all necessary updates and click the Submit button.

Device xxxx is updated into the database
Deleting a Cluster
To delete a Cluster, follow these steps:
1. From the Devices home page, click the trash can icon located next to the
cluster name you wish to delete.
7.
RSM System
Figure 51. Delete A Cluster Dialog Example
WARNING: Before you delete the selected cluster, remember that all
iServers in the cluster will be deleted and cannot be retrieved.
110
7/21/06
<<7. RSM System>>
3. Click the OK button to delete the cluster.

4. Click Cancel to exit out of the dialog.
PARTITIONING
A partition is defined by a set of realms, endpoints, and regions. Partitioning
is the functionality where the system appears to be multiple systems being
shared by different users and customers.
Partitioning starts with the Admin user creating a Partition (formerly referred
to as group). This is done by creating a partition and its respective endpoints
in the Add Partition window. The end result is that even though its one RSM
system, when different users log in they see data that only pertains to their
user profile. This functionality makes the system appear to be their own as
they dont see another users partitioned data.
This feature provides:
partitioning of the entire system
that each RSM group corresponds to one partition
multiple iServers supported per RSM system
license control on number of partitions, maximum 64
unlimited user per each partition
capabilities can be set per partition and further filtered per user
CAC enforced per group
CAC per group can be validated against iServer VPORT license
LCR routes generated are effective per partition
7.
Note: In RSM 4.0, the Group field was renamed to Partition.

Routing Functionality
iServer routes are generated based on the rate and route information
stored on the RSM, i.e., one partitions route is not affected by another partitions routes.
For example, if partitioned user A uploads a route to Mexico and partitioned user B also uploads routes to Mexico, when one partition calls
they will only be using their routes. In order for the iServer to differentiate between the two partition users, it has a feature called zone, that basi-
111
7/21/06
RSM System
<<7. RSM System>>
cally does what partitioning would do. If you put a certain number of
endpoints in one zone, they can only be routed within each other and not
outside of their zone. Partitioning is essentially the same. You want one
partition user to manage their own endpoints without interfering with
another partition users endpoints.
Therefore, when a partition user creates an endpoint the user is automatically associated with the zone. Every endpoint that is created by the user
is assigned a zone. RSM does not allow the user to overwrite this zone
information.
Creating a Partition
Partitioning starts with the admin user creating a partition where partition
users are created, there can be multiple users within a specific partition.
Note: Partitioning impacts every screen on the RSM Console. If you are running a RSM Console, you will see everything that is on the iServer. But
if you are running the RSM Console on RSM, you will only see the partitioned data, this is the biggest distinction.
There are features that are added when the admin creates a partition that
provide all the functionality a partitioned user is supposed to have. This
capabilities, e.g., business reports, alarms, etc., are now under the partition definition. So when the administrator creates a partition, a default set
is assigned to the user. Whenever a new user is created under the specified partition, they inherit the default. The administrator has the capability
to further restrict user access.
Creating Realms
The administrator is also responsible for creating realms. Realms is a concept that is closely associated with physical entities on the iServer, such
as the IP addresses, partitioned users are not allowed to create realms.
Upon the administrator logging into the RSM Console, they now have
more capabilities. For example, any of the system related parameters can
only be controlled by the administrator.
Once the administrator creates these realms and assigns them to a particular partition, they automatically become available to all the partitioned
users. The user can then create endpoints and assign from a list of realms
the administrator partitioned to them. They use the zone to automatically
assign other partitioned users into one single zone. The zone provides a
measure to stop the endpoint in a zone from routing a call to a endpoint
outside the scope of the zone. This functionality is therefore used to partition this information. On the iServer the routing database itself does not
have a partition. If you have a route to Mexico and another endpoint has a
112
7/21/06
7.
RSM System
<<7. RSM System>>
route to Mexico, the iServer looks at both of them when it is attempting to

route a call to Mexico. If they are different zones, the iServer does not
look at the endpoints at the same time.
Note: Realms created under the partition function are referred to as global
realms. These realms are available for all partitions. This option allows
a user to assign the same realm to different endpoints that belong to
different partitions.
Virtual Switches
With the virtual switches capability our customer can purchase one iServer and make it look like two different iServers for ten of their customers. For example, prior to RSM 3.2 a customer could purchase
10,000 vport licenses for their customer and sell 200 vport to ten customers, which is the equivalent of 2,000 vports. To ensure that a customer is only selling 200 calls and not more, when a partition is defined,
you enforce the vport by specifying what your vport limit is, i.e., if your
partition is 200 then your vport is also 200. This is implemented on the
iServer via the iEdge group feature.
The iEdge group is created, with a max call of 200 within the iEdge
group.
The iEdge group is then automatically assigned to every endpoint in
the partition.
The iEdge group at this point becomes non-editable to the partition
users and is automatically inherited when new users are added.
Our customer can now enforce CAC on every customer they sell to.
This is the Enforce Report on the group configuration pages.
113
7/21/06
7.
RSM System
The subscription process comes into play, when we choose to enforce

the vports. For example, the customer is assigning 200 vports times
10 customers, which is 2,000 vports and they only have 1,000 vport
licenses for the iServer. The license has a parameter called Over Subscription Parameter (OSP), this is a percentage parameter, and by
default it is 100%. Therefore, when creating partitions you would
want to create partitions at 100% of what is on iServer. So if you have
1,000 vport licenses on iServer, you can only create five 200 license
partitions. However, if NexTone chooses to license over subscription,
they can put 200 in that license and the customer can now sell 10 200
license partitions.
<<7. RSM System>>
ACCESSING THE PARTITIONS PAGE

To access the Partitions home page, follow these steps:
1. Click System>Partitioning>Partitions.
2. The Partitions home page displays.
RSM System
7.
114
7/21/06
<<7. RSM System>>
Figure 52. Partitions Home Page Example
Field Descriptions
Field
Description
partition. partition membership controls the endpoints and ports accessible to that user when
requesting reports
ID
This is a system generated number for each group.

The number is used in other ratingtables. Also,
operators need to know these numbers in order to
generate CVS files for rating table import. This
number is ranged from 1-64.
Stylesheet
This icon enables the System Administrator to

update the look and feel of a partition.
ASR
This field indicates whether Answer Seizure Ratio

(ASR) activity is enabled (yellow bulb) or disabled
(gray bulb).
Business
This field indicates whether Business Report is

enabled (yellow bulb) or disabled (gray bulb).
7.
RSM System
Partition
115
7/21/06
<<7. RSM System>>
Field
Description
Route Profit
This field indicates whether billing activity is

Custom
This field indicates whether the Custom Report is

Log
This field indicates whether Log activity is enabled

(yellow bulb) or disabled (gray bulb).
CDR
This field indicates whether CDR activity is enabled

(yellow bulb) or disabled (gray bulb).
Actions
This field indicates whether Actions activity is

Endpoints

is selected.
Routes
This field indicates whether routing activity is

Rates
This field indicates whether rating activity is

Maximum Total Calls
This field indicates the maximum total calls for the

listed partition.
Device
This field indicates the name of the configured

device.
Created
Identifies the date (yyyy-mm-dd) and time

(hh:mm:ss:msec) the partition was created.
Last Modified

(hh:mm:ss:msec) partition information was last
updated.
7.
ADDING A PARTITION
RSM System
To add a partition, follow these steps:

1. From the Partitions home page, click the Add button.
2. The Add Partition page displays.
116
7/21/06
<<7. RSM System>>
Figure 53. Add Partition Page Example
3. Make all necessary entries.

4. To make an endpoint an Authorized Endpoint(s), move the desired endpoint from the Available Endpoints column, by clicking the >> button or
the All >>.
7.
RSM System
5. To move an Authorized Endpoint(s) to the Available Endpoints column,

click the << or the << All button.
117
7/21/06
<<7. RSM System>>
6. When an endpoint is moved from the Available Endpoints column to the

Authorized Endpoints column or vice versa. The following dialog displays:
7. Click OK the to save file.

8. A message similar to the one below, displays:
Partition xxxx is added to the database
9. If you wish to return to the previous page, click the Back button.
RSM System
7.
118
7/21/06
<<7. RSM System>>
Field Descriptions
Field
Description
Partition

requesting reports
Available Endpoints
This column contains a master list of all endpoints

in the system.
Authorized Endpoints
This column contains a list of endpoints that make

up the partition, i.e., these are the endpoints that
are in the partition.
Maximum Total Calls
An optional limit on the maximum number of concurrent calls this endpoint can have.
Maximum Calls In
The maximum number of incoming calls the system

can process. The defaults are:
Limited
Unlimited
None
Maximum Calls Out
The maximum number of incoming calls the system

can process. The defaults are:
Limited
Unlimited
None
Maximum Bandwidth Total
An optional limit on the maximum bandwidth this

endpoint can have.
Maximum Bandwidth Out
The maximum bandwidth of outgoing calls the system can process. The defaults are:
7.
Limited
RSM System
Unlimited
None
Reports
This field gives you access to the ASR, Business

and Route Profit reports.
119
7/21/06
<<7. RSM System>>
Field
Alarms
Description
This field gives you read/writer 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:
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:
7.

ISDN Codes to Calculate

ARR
This field allows you to add ISDN codes to calculate ARR. You also have the option to Update or
Delete the ISDN codes.
120
7/21/06
RSM System
<<7. RSM System>>
Field
Description
iServers
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).
Created

(hh:mm:ss:msec) the partition was created.
Last Modified

(hh:mm:ss:msec) partition information was last
updated.
CAPABILITIES
RSM has both partition and user capabilities. User capabilities are a subset of
partition capabilities. Capabilities are used to control user access to specific
functionalities. Also, for the user to have access to Capabilities, both the Partition and User Capabilities must be enabled identically.
The capability type displayed on the 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 Updating the Group Based Stylesheet
UPDATING THE GROUP BASED STYLESHEET (SYSTEM ADMINISTRATOR

ONLY)
The System Administrator can change the look and feel of a partition through
the web interface.
7.
1. From the Partitions content page, click the Stylesheet icon corresponding
to a specific partition.
121
7/21/06
RSM System
To edit the stylesheet, follow these steps:
<<7. RSM System>>
Figure 54. Stylesheet Content Page Example
2. The Stylesheet page displays.
Figure 55. Stylesheet Page Example (Partial View)
7.
RSM System
3. Make all necessary changes to the stylesheet properties.

4. Click Submit to save your changes.
122
7/21/06
<<7. RSM System>>
UPDATING A PARTITION
To update a Partition, follow these steps:
1. From the Partition home page, under the Partition column click the Partition you wish to update.
2. The Update Partition page displays.
Figure 56. Update Partition Page Example
RSM System
7.
3. Make all applicable updates and click Submit.

Partition xxxx is updated
123
7/21/06
<<7. RSM System>>
Deleting a Partition
To delete a Partition, follow these steps:
1. From the Partitions home page, click the trash can icon located next to the
partition name you wish to delete.
3. Click the OK button to accept the deletion.

4. Click the Cancel button to exit out of the deletion dialog.
Adding an Endpoint
To add an Endpoint, follow these steps:
1. From the Update Partition page, click the Add Endpoint button.
2. The Add Endpoint page displays.
Figure 57. Add Endpoint Page Example
RSM System
7.
3. Enter the new Endpoint name.
124
7/21/06
<<7. RSM System>>
4. Select a Partition from the pull down list.

5. Enter a Port.
Endpoint xxxx is added to the database.
8. Click the Back button to return to the previous page.

9. When you are returned to the Update Partition, the newly added endpoint
displays in the Authorized Endpoints column.
Note: You can move endpoints from Available Endpoints to Authorized Endpoints and vice versa by clicking on any of the following buttons: >>,
All >>, << and <<All.
Deleting an Endpoint
To delete an endpoint, follow these steps:
1. From the Update Partition page, select the endpoint(s) you wish to delete.
2. Move the endpoint(s) to the Authorized Endpoints column by clicking >>
button.
3. Click the Delete Endpoint button.
7.
5. Click the OK button to select the deletion.
Users
This menu provides a listing of configured users under a partition. To access
users information, follow these steps:
1. Click System>Partitioning>Users.
2. The Users home page displays.
125
7/21/06
RSM System
6. Click the Cancel button to cancel out of the deletion process.
<<7. RSM System>>
Figure 58. Users Home Page Example
Field Descriptions
Field
Description
User
The name by which a user is known to the system.

Each individual user has one ID; two users should
not share one userid.
Partition

requesting reports.
SysAdmin
Grants access to view all system administrator

functionalities.
ASR
Grants access to view the ASR report (accessible

from the Engineering report page).
Business
Grants access to view the reports accessible from

the Business reports page.
Route Profit
Grants access to view the reports on the Route

Profit page.
Custom
Grants access to view the reports accessible from

the Custom reports page.
RSM System
7.
126
7/21/06
<<7. RSM System>>
Field
Description
Log
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).
CDR
Grants access to the CDR alarm list. Access can

be read-only (i.e., view existing 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).
Action
This field indicates whether Action is enabled (yellow bulb) or disabled (gray bulb).
Endpoints

is selected.
Routes
This field indicates whether Routes is enabled (yellow bulb) or disabled (gray bulb).
Rates
This field indicates whether Rates is enabled (yellow bulb) or disabled (gray bulb).
Created
The date and timestamp when user information

was created.
Last Modified
The date and timestamp when user information

was last modified.
SysAdmin User Capabilities

The SystemAdmin feature allows the system administrator to assign SysAdmin capabilities to admin and non-admin partition users. The criteria for this
feature are as follows:
Table 7. Admin and Non-Admin User Capabilities
Capability
root
SysAdmin
non-Admin partition
SysAdmin
can add, delete, and modify users in their partition
can access archiver, audit trail, and cdr import/export in
their partition.
RSM System
User
7.
127
7/21/06
<<7. RSM System>>
Table 7. Admin and Non-Admin User Capabilities

User
Capability
non-Admin partition
Regular User
can only view the user page with password, time zone
and ISDN modification information.
Admin partition
SysAdmin
can add, delete, and modify users
can add, delete, modify partitions, and access lists
can access all pages under the System menu
Admin partition
Regular User
can only view the user page for password, time zone,
and ISDN modification information.
ADDING A NEW USER ACCOUNT

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.
To add a new user account, follow these steps:

Note: Be sure sign in with an account name that has administrative privileges.
1. Click on the System>Partitioning>Users.

2. The User home page displays.
4. The Add User page displays.
RSM System
7.
128
7/21/06
<<7. RSM System>>
Figure 59. Add User Home Page Example (Partial

View)
5. Place the user in a partition by selecting a Partition from the list above the
User Name.
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.
129
7/21/06
7.
RSM System
6. Click in the User Name box, and type an account name for the new user.
<<7. RSM System>>
10. Select the iServer the user will have access to.
11. Enter the Default Time Zone.
12. Once your changes are all entered, click the Submit button.
13. A message similar to the one displays:
User xxxx is added to the database
14. Click the Back button to return to the previous page.
RSM System
7.
130
7/21/06
<<7. RSM System>>
Field Descriptions
Field
Description
Partition

requesting reports.
User Name

Each individual user has one ID; two users should
not share one userid.
New Password
The administrator uses this field to change the

users password to a new value.
Confirm New Password
Allows the administrator to re-enter the value in

New Password above to confirm that it was typed
correctly.
SysAdmin
Grants access to view all system administrator

functionalities.
Reports
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.
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:
RSM System
ARM - Block, Unblock, Endpoint Priority, Route

Priority
Custom Script - Execute Script
Generic - Log, Mail, SNMP Trap
7.
131
7/21/06
<<7. RSM System>>
Field
Routes and Rates
Description
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:
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:
This field allows you to add ISDN codes to calculate ARR. You also have the option to Modify or
Delete the ISDN codes.
iServers
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).
132
7/21/06
RSM System
7.
ISDN Codes to Calculate

ARR
<<7. RSM System>>
UPDATING A USER
To update a user, follow these steps:
1. From the Users page, click on the partition you wish to update.
2. The Update User page displays.
Figure 60. Update User Home Page Example (Partial

View)
RSM System
7.
3. Make all necessary updates and when finished click the Submit button.
User xxxx is updated
Note: The Update User page for Admin and Non-Admin users is different in
content. For example, the Admin user can update all user information.
133
7/21/06
<<7. RSM System>>
The Non-Admin user can only update their passwords, all other fields
are hidden.
5. To return to the User home page, click Back button.
DELETING A USER
To delete a user, do the following:
1. From the Users home page, click the next to the user you wish to delete.
2. The delete dialog displays.
3. Click the OK button to delete the selected user.

User xxxx is deleted from the database
5. Click the Cancel key to exit out of the dialog.
Access List
This option gives you access to those endpoints you do not own by allowing
you to view those endpoints.
To access the Access List, follow these steps:
1. Click System>Partitioning>Access List.
2. The Access List home page displays.
RSM System
7.
134
7/21/06
<<7. RSM System>>
Figure 61. Access List Home Page Example
ADDING A ACCESS LIST

To add a access list, follow these steps:
1. From the Access List page, click the Add button.
2. The Add Access List page displays.
RSM System
7.
3. From the Access List Partition list, select a partition.
4. From the Owner Partition list, select the partition owner.
5. From the Realm list, select a realm.
135
7/21/06
<<7. RSM System>>
6. From the Endpoint list, select an endpoint.

7. Enter a Region.
8. Click Submit to accept the entries.
Data is added to the database
Viewing Content Page Information

To view specific access list information on a partition, do the following:
1. From the Access List Partitions field, select the partition from the list.
Note: The wildcard is *(asterisk) and will display all partition variables.
2. Enter a Realm.
3. Enter an Endpoint.
4. Enter a Region.
Note: Remember, the more details you enter, the more refined your output
will be.
RSM System
7.
136
7/21/06
<<7. RSM System>>
Field Descriptions
Field
Description
Access List Partition
Provides a listing of all available partitions.
Owner Partition
Identifies the partition owner.
Realm
In an iServer-controlled network, a realm gives a

unique identity to a private network. This field supports a wildcard search using %.
Endpoint

is selected. Be careful not to enter the same end
point by regID or IP address. If you enter the same
end point by regID and IP address, you will have
duplicate events. Also, regID or IP address are
interchange-able and case sensitive. lookup - looks
up the end points as defined in the RSM system.
This field supports a wildcard search using %.
Port
The endpoints port number, if an endpoint is specified.
Region
This field describes a region, used to group one or

mode dial codes. This field supports a wildcard
search using %.
Created
Identifies the date (YYYY-MM-DD) and time

(HH:MM:SS:MSEC) the update was created.
Last Modified
Identifies the date (YYYY-MM-DD) and time

(HH:MM:SS:MSEC) carrier information was last
updated.
7.
Filters
RSM System
See Filters, on page 33.
DELETING A ACCESS LIST

To delete a access list, follow these steps:
1. From the Access List home page, select the access list you wish to delete.
137
7/21/06
<<7. RSM System>>
2. Click the trash can icon.

4. Click the OK button to accept the deletion.

Selected access list is deleted from the database
6. Click Cancel to exit out of the deletion process.
ARCHIVER
The Archiver page can be used for configuring the RSM Archiver services.
This allows the user to back up, delete or archive CDRs as well as Provisional
data stored on the RSM server.
Archiving CDRs and Provisional Data

To archive CDRs and Provisional data, follow these steps:
1. Click System>Archiver.
2. The Archiver home page displays.
RSM System
7.
138
7/21/06
<<7. RSM System>>
Figure 62. Archiver Home Page Example
Note: The Archiver feature archives the CDRs into a file, instead of saving
the CDRs in the database.
RSM System
7.
139
7/21/06
<<7. RSM System>>
Field Descriptions
Field
Description
Name
The prefix that will be assigned to the file name of

the output file. (Note: This name
becomes the prefix of the output file name.)
Type
Identifies the type of data to be archived: CDR or

Provisional
Action
Identifies the currently specified action for the listed

data, i.e., ARCHIVE, BACKUP,
or DELETE. (Note: The ARCHIVE option performs
a backup and then deletes the data.)
Dir
The complete path to the directory where the output

file will be created.
Created
Date (yyyy-mm-dd) and time (hh:mm:ss:msec) the

CDR was created.
Now
Indicates that you wish to view archive file output

now.
Sun through Sat
Identifies the days of the week, Sunday through

Saturday.
Adding an Archive
To add a Archive, follow these steps:
1. On the Archive home page, click the Add button.
2. The Add Archive page displays.
RSM System
7.
140
7/21/06
<<7. RSM System>>
Figure 63. Add Archive Home Page Example
Note: When backing up data on the RSM server, the mysql user name
should have write permission into that directory.
3. Enter the search criteria in the applicable areas and click the Submit button.
4. To exit out of the Add Archive page, click the Back button.
5. When you are returned to the Archiver home page, the job has been added
to the list of archives.
RSM System
7.
141
7/21/06
<<7. RSM System>>
Field Descriptions
Field
Job Name
Description
The prefix that will be assigned to the output file
name.
Note: This becomes the prefix of the

output file name.
Type
Identifies the type of date: CDR or Provisional.
Days
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 or 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 as
two-digit integers in the format HH:MM:SS:MSEC.
HH indicates the hour of day (in military time format with a value between 0-24, e.g., midnight
would be 00)
MM indicates the minute within the hour specified (range of values is 00-59, inclusive)
SS indicates the seconds within the minute
(range of values is 00-59, inclusive)
MSEC is the millisecond within the seconds
specified (range is 00-59, inclusive)
Identifies the CDR action, i.e., ARCHIVE,

BACKUP, or DELETE.
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.)
Filter
Indicates the information will be filter by Begin and

End dates.
Begin Date
Identifies the beginning date of action to be taken

on the data.
142
7/21/06
RSM System
7.
Type
<<7. RSM System>>
Field
Description
End Date
Identifies the ending date of action to be taken on

the data.
Directory
The complete path to the directory where the output

file will be created.
Deleting a Archive
To delete a Archive, follow these steps:
1. Click the trash can icon next to the archive you wish to delete.
2. A pop-up message displays:
Are you sure you want to delete Archive <name of archive>
3. Click Yes to complete the deletion.
RSM System
7.
143
7/21/06
<<7. RSM System>>
AUDIT TRAIL
The purpose of the audit trail is to identify each CDR that comes from a system associating the CDRs to the system alarms and reports you can filter onto
the iServer system. The audit process is a tracking mechanism used to audit
the trail of changes done to the system, i.e., login, status, key, client IP
address, action, and details. Example:
A rate update is incorrect, you must figure out when the incorrect rate was
entered, make the appropriate change to the rate to correct it. Also, you must
re-rate to make any rating process using incorrect rating corrected.
When you launched an RSM Console to do any changes; this is the iServer
you will use to make these changes in.
This feature provides:
A simple audit trail for all web based access
Contains the XML messages for troubleshooting
Per partition audit trail
Admin group can see all system audit trails.
Accessing the Audit Trail Page

To access the Audit Trail page, follow these steps:
1. Click System>Audit Trail.
2. The Audit Trail home page displays.
RSM System
7.
144
7/21/06
<<7. RSM System>>
Figure 64. Audit Trail Page Example (Partial View)
Field Descriptions
Field
Description
Each individual user has one ID;
two users should not share one userid.
Partition

requesting reports.
Client IP Address
Specifies a client endpoint IP address
7.
RSM System
User Name
145
7/21/06
<<7. RSM System>>
Field
Description
Action
Identifies the currently specified action for the listed

CDR, i.e., ARCHIVE, UPDATE,
BACKUP and DELETE
Key
The key shows which RSM module the particular

audit trail entry deals with.
Status
The status shows whether the operation failed or

was successful (ok).
Created
The date (yyyy-mm-dd) and time (hh:mm:ss:msec)

the archive was created.
Details
A link allowing you to see what alarms have been

added.
Clearing Audit Details

To clear all displayed audit details, follow these steps:
1. Click the Clear button.
WARNING: Clicking removes all output information from the page. The
cleared information cannot be retrieved.
Viewing Audit Details Content

The detail link on the Audit page allows you to see what alarms have been
added. The displayed page shows the actual message as it appears in the system.
RSM System
7.
146
7/21/06
<<7. RSM System>>
Figure 65. Audit Trail Details Page
Note: Root and admin are hard coded into the system.
To view the details of an audit trail, do the following:

1. Click the Details link on the line where the name of the audit trail you
want to view is listed.
2. The actual data that was used in the action is displayed. This process is
used as a technical support tool.
3. To return to the previous, click the Back button.
7.
The configuration of CDR Stream is done by configuring a collector agent, a

mapping component or a transformer and configuring a consumer.
Note: Before configuring any stream, at least one mapping should exist
within system.
147
7/21/06
RSM System
CALL DATA RECORD (CDR) IMPORT/EXPORT
<<7. RSM System>>
For the purpose of importing Call Data Records (to be referred to as CDRs), a
CDR Stream can be set up within the RSM system. Any 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 and the 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
7.
/home/nextone/CDRStream/test/ only for unit tests
The configuration of 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.
148
7/21/06
RSM System
Configuration of CDR Stream
<<7. RSM System>>
Adding a CDR Map

To add a CDR map, follow these steps:
1. Choose the System>CDR Import/Export.
2. The CDR Import/Export home page displays.
Figure 66. CDR Import/Export Home Page
Creating a Mapping
To create a mapping, follow these steps:
1. From the CDR Import/Export page, click the New Import Stream button.
2. The New Import Stream window displays.
RSM System
7.
149
7/21/06
<<7. RSM System>>
Figure 67. New Import Window Example

4. The following window displays.
RSM System
7.
150
7/21/06
<<7. RSM System>>
Figure 68. Create a New Mapping Example
Note: This window allows you to add, edit and modify mappings.
5. Enter the Mapping 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.
Note: If you click the Add New Field button first, the system tries to add the
same field twice.
12. The new mapping field information displays in the lower right hand box.
13. Click the Save Mapping button to save the new map.
14. The following message is displayed:
Mapping XML Saved
151
7/21/06
RSM System
7.
11. Click the Create New Field to add the new mapping field.
<<7. RSM System>>
Field Descriptions
Field
Description
Mapping Name
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.
Field Name
Allows you to enter the field to be mapped in the

incoming CDR.
Format
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.
Type
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 the constant or Variable transform described in it.
RSM System
7.
152
7/21/06
<<7. RSM System>>
Field
Transform
Description
Identifies the transforms by their defined Outname.
On selecting any one of these transforms, a section
describing the details of the transform appears in
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.
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.
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).
ipaddr - transforms the incoming ip address into
a outgoing ip address specified in a attribute format.
RSM System
7.
153
7/21/06
<<7. RSM System>>
Field
Transform (contd)
Description
variable - normally used as an additional field. A
current date/time value is added in the output
CDR in format given.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.
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.
constant - normally used as an additional field.
A fixed value defined in Value is added in the
output CDR.
expr - Perform a mathematical computation on
the value in this CDR field according to the
expression in the value= element for this transform. 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' describe 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
7.
To remove a mapping field, follow these steps:

1. Click the Remove Field button.
RSM System
2. The field is removed from the lower right hand box.
Modifying a Field
To modify a field, follow these steps:
1. Click the Modify Field button.
154
7/21/06
<<7. RSM System>>
2. Make all necessary modifications.

3. Click the Modify Field button 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.
7.
To create a CDR Stream List, follow these steps:
RSM System
155
7/21/06
<<7. RSM System>>
2. The CDR Stream List home page displays.
3. For this example, we clicked the New Import Stream button.

4. The New Import (CDR) Stream parameters window displays.
Figure 69. New Import Stream Window Example
RSM System
7.
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.
156
7/21/06
<<7. RSM System>>
5. 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.
7.
Delete after read - (should file be deleted, after all the CDRs have
been read from this file)
RSM System
Batch Size - default is 100.
157
7/21/06
<<7. RSM System>>
Field Descriptions
Field
Description
Stream Name
This field identifies the stream name.
Schedule
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
Identifies the transformer mapping to be used.
Data Source
Identifies a file type, i.e., DB, Delimited File, HTTP.
Start Automatically
Indicates whether the CDR Stream should re-start

automatically or manually by the Administrator.
JDBC Driver Name
To be provided.
Table Name
The table name from which CDRs are selected.
Database User ID
To be provided.
Primary key
To be provided.
Database Password
To be provided.
Start Value
To be provided.
URL
To be provided.
Where Clause
To be provided.
Batch Size
Number of rows to read in every database read.

Default is 100.
7.
RSM System
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:
3. Click the New Export Stream button.
158
7/21/06
<<7. RSM System>>
4. The New Export (CDR) Stream parameters window displays.
Figure 70. New Export Stream Window Example
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.
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:
159
7/21/06
7.
RSM System
ADVANCED CONFIGURATION
<<7. RSM System>>
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 the case of Export Stream, the collector agent is automatically
selected.
To set collector agent parameters, follow these steps:

System, on page 12.
4. Follow all preceding steps, until you come to the collector agent page.
5. If the collector agent is DB (external database), follow these steps:
Enter the JDBC Driver class (Required).
Enter the Table Name (Required).
7.
Enter the Database User Id (Required).

Enter the Primary key (Required).
RSM System
Enter the Database Password (Required).

Enter the Start Value. The Default is 1000.
Enter the URL (Required).
Enter the Primary Key column name (Required).
Enter a Where Clause (Optional).
160
7/21/06
<<7. RSM System>>
Enter the Batch Size. The Default is 0.

6. If the collector agent is a Delimited file type (the data source is a file), follow these steps:
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 Escape Sequence. This field is Optional
Enter the Field Delimiter. The default is tab (\t).
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.
CDR ERRORS
This section introduces the concepts of CDR Receptor module (CRM) that the
NexTone RSM will provide as a CDR receiving interface.
CDR RECEPTOR MODULE (CRM)
Note: The CRM cannot validate CDR's 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
161
7/21/06
7.
RSM System
CRM acts as a single point for inserting CDR's 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 CDR's which are filtered by CRM can be manually edited and then inserted into the RSM system
using the web interface.
<<7. RSM System>>
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 CDR's 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 CDR's identified instance of file logger is created
using the logging file name specified in bn.properties. If invalid CDR's 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 CDR's may be identified and logged
as bad CDR's in the log file. You can manually edit these CDR's and correct
the problematic CDR fields. Once the CDR's 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 CDR's will
not be attempted. The user is shown the line number in file which interrupted
the CDR insertion.
USER INPUT AND OUTPUT
User should specify the name of file which can be used to log the CDR's
not successfully inserted into the RSM database because of invalid characters or field data types.
Performing validation of CDR's can be quite resource intensive. Therefore, you can now enable or disable CDR validation from the system
properties file.
162
7/21/06
RSM System
7.
There are three criteria the user should address during the input and output
process, they are:
<<7. RSM System>>
During the import of manually edited CDR files, you must provide the
file name using the web interface.
ACCESSING THE RE-IMPORT CDRS

To access Re-Import CDRs, follow these steps:
1. Choose the System>CDR Errors.
2. The Re-Import CDRs home page displays.
Figure 71. Re-Import CDRs Example
3. Select the CDRs to be modified from the Available CDR Re-Import

Files.
7.
4. Click the >> button.
6. Specify the name of the file which can be used to log the CDR's 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.
7. Click the Import button.
163
7/21/06
RSM System
5. If you wish to modify all CDRs click the >> All button.
<<7. RSM System>>
SYNCHRONIZATION
Occasionally, the databases between MSX and RSM are out of sync for various reasons. Symptoms which can cause synchronizations issues 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
Others
The Synchronization features provides the following capabilities:
Synchronize database data from MSX to RSM (import)
Synchronize database data from RSM to MSX (export)
Detect out of sync between RSM and MSX databases
Audit and auto synchronize between MSW and RSM
Synchronization for 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.
Database Manual Synchronization

The synchronization processes provides you with two functionalities, they
are:
Synchronization of database data from RSM to MSX (export) which provides server and web user interface functionality allowing the user to
overwrite MSX database data with RSM database data.
Note: This function can be performed on one cluster at one time. You can
choose the table and synchronize process via the web interface. During the operation, the web page shows the progress as a status bar.
You can choose to stop the operation while it is in progress. If the
164
7/21/06
7.
RSM System
Synchronization of database data from MSX to RSM (import) which provides server and web user interface functionality allowing the user to
overwrite RSM database data with MSX database data.
<<7. RSM System>>
operation is completed or cancelled, a brief summary message displays.
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.
Like other services currently implemented in the system, a set of configurable
parameters are 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, we use 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
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.
165
7/21/06
7.
RSM System
The audit between MSW and RSM compares and automatically synchronizes
the databases based on the configuration elements. There are three options:
<<7. RSM System>>
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.
DB Schemas Synchronization between RSM and MSX

The following tables and their schemas will be synchronized between RSM
and MSX:
Endpoints
Callroutes
CallPlans
CallBindings
Realms
IEdgeGroups
Triggers
Vnets
CdcProfiles
Subnets
The order and name of the columns in each table follow those in RSM 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, the MSX will have to create and
maintain a groups table like RSM does.
Accessing Synchronization
7.
To access Re-Import CDRs, follow these steps:
RSM System
1. Choose the System>CDR Errors.

2. The Re-Import CDRs home page displays.
166
7/21/06
<<7. RSM System>>
Figure 72. Synchronization Home Page Example
This new user interface provides the following web pages enabling you to
perform DB synchronization related operations:
Difference page - lists all the differences that have been detected between
the MSX and RSM DB that have not been synchronized.
RSM System
7.
167
7/21/06
<<7. RSM System>>
Figure 73. Difference Page Example
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 on the entry allows the user to view entry specific details both
databases.
Each entry provide user with three options:
Sync to MSX - uses MSX value to override RSM value
Sync to RSM - uses RSM value to override MSX value
Dismiss - dismisses the entry without taking action
7.
RSM System
Manual synchronization page - User can select a cluster, and then select
the operation to perform for each of the tables:
168
7/21/06
<<7. RSM System>>
Figure 74. Manual Synchronization Page Example
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, it goes back to the manual synchronization page, and shows the summary at the bottom of the page.
RSMLite Specific Synchronization

Because RSMLite has a specific setup, the synchronization mechanism is different than the normal setup.
7.
there is no web interface, so a complete set of DB synchronization functionality cannot be provided.

RSMLite is meant to provide MSX centric configuration and provisioning
functionality, so normally MSX should be the database master.
169
7/21/06
RSM System
In RSMLite:
<<7. RSM System>>
in the RSMLite setup, the RSM and MSX databases sit in the same database engine. This provides the opportunity to do more efficient and tight
synchronization between the databases.
The RSMLite database synchronization is based on a rigger mechanism. Any
change on the MSX database is instantly reflected in the RSM database
through these database triggers. The triggers are installed during the RSMLite
installation. This operation is totally transparent, and guarantees instant synchronization between RSM and MSX databases.
SYSTEM ALARMS
The system alarm feature creates system alarms. System alarms are based on
either CDRs or other system resources.The system alarm trigger an action
when configured conditions are met. Multiple actions can be configured for a
single system alarm. One or more of the following four types of actions can be
triggered:
SNMP Trap
Email
Execute Script
Log
Note: Actions for system alarms can be created under Alarming > Log
Alarms or under System > System Alarms > Actions page under the
System tab which only shows the existing actions of type SNMP Trap,
Email, Execute Script, Log
This alarm is used to create System Alarms based on CDRs or other system
resources.
Accessing the System Alarms Home Page
RSM System
The CDR Receptor module (CRM) that NexTone RSM provides is a CDR
receiving interface.
To access the System Alarms home page, follow the steps below:
1. Click on the System tab.
2. Click System Alarms.
3. The System Alarms home page displays.
7.
170
7/21/06
<<7. RSM System>>
Figure 75. System Alarms Home Page
Note: There are four types of System Alarms. They are Audit, Bad CDR,
CDR Alarm Failed to Run on Time and Failed Alarm Action.
Events
System alarm events are displayed under the System Alarms submenu it displays only the events which were generated by the system alarms.
RSM System
7.
171
7/21/06
<<7. RSM System>>
Figure 76. Events Home Page Example
CLEARING ALARM EVENTS

To clear an alarm event, follow these steps:
4. Click the Clear button.
CAUTION! Clicking the Clear button on the system alarm events page
clears all the system alarm events from the database.
Creating Actions for System Alarms

Actions for system alarms are created from the System Alarms submenu or
actions under the Alarming tab.
ACCESSING ACTIONS
7.
1. Click System>System Alarms>Actions.
RSM System
2. The Actions home page displays.
172
7/21/06
<<7. RSM System>>
Figure 77. Actions Home Page Example
ADDING AN ACTION
To add a system action, follow the steps below.
1. From the Add Action page, click the Add button.
2. The Add Action page displays.
RSM System
7.
173
7/21/06
<<7. RSM System>>
Figure 78. Add Action Page Example
3. Select the alarm action from the Type list.

4. Provide an alarm Name for your action.
5. Enter an email address in the To field.
6. Enter a Cc or Bcc. This two fields are optional.
7. Enter a Subject.
Successfully added action xxxx.
UPDATING AN ACTION
To update a system action, follow the steps below.
1. From the Actions content page, click the Name of the email action you
wish to update.
7.
RSM System
2. The Update Action page displays.
174
7/21/06
<<7. RSM System>>
Figure 79. Update Action Page Example
3. Make updates to the necessary fields and click the Submit button to save
the updates.
Successfully updated action xxxx.
DELETING AN ACTION
IMPORTANT !Deleting an action from the System Alarm Actions pages
also deletes that particular action from Actions page under the Alarming tab or vice-versa.
To delete a system action, follow the steps below.
1. From the Actions content page, click the bucket next to the action Name
you wish to delete.
RSM System
2. The following dialog displays.
7.
175
7/21/06
<<7. RSM System>>
Figure 80. Delete Action Dialog Example
3. Click the OK button to accept the deletion. A message similar to the one
below displays:
Successfully deleted action xxxx.
RSM System
7.
176
7/21/06
8
RSM PROVISIONING
INTRODUCTION
RATING OVERVIEW
The rating function brings together many items of data from differing sources.
The basic data structure is that given in Figure 81. Note that the tables in the
diagram do not show all the data fields in the table, only those relevant to the
process of creating the necessary records for RSM rating function to work.
Full table structure details are available using MySQLs describe command.
Note: Use of that command is beyond the scope of this document.
177
7/21/06
6.
RSM Provisioning
This chapter describes how to use to the RSM systems CDR Provisioning
functions. The provisioning function provides a means for defining and managing endpoints, routes, calling plans and rates.
<<8. RSM Provisioning>>
Figure 81. Rating Data Table Relationships
RSM Provisioning
6.
Based on the relationship between the data tables, the high-level process of
setting it all up generally follows these steps:
1. Identify a carriers endpoint to be rated.
2. Identify the routes (i.e., dial codes) that this endpoint serves.
3. From the Carrier Plan link, create one entry for a buy plan (for the customer) and one entry for a sell plan (for the vendor or supplier), as
follows:
3.1
Create the buy entry for that endpoint, assigning the route group ID
of the applicable buy route you created using the Routes button, and
the Plan ID you created on the Rates button.
3.2
Repeat step 3.1 for the sell entry.
Note: Each endpoint/port for a carrier can have only one buy entry and one
sell entry.
4. Create regions for these dial codes using the Regions button (see Rates,
on page 203). Keep dial codes in the regions table as normalized as possible (i.e., without any prefixes), so that they can be re-used (e.g., 01144 is
normalized; 55#01144 is not). This will reduce your maintenance burden.
178
7/21/06
5. Create a route group comprising the regions that the endpoint serves,
using the Routes button (see Routes, on page 196). It usually works best
to have one route group for a set of routes that the endpoint terminates
traffic to, and another for the set of routes that it originates traffic for.
Provide a cost code for each route group you create. A sell route
group may contain some regions that are priced differently from
others. Create as many route groups as you need, with each containing the same route group ID, but different cost codes.
6. From the Rates button, create a plan name (PlanId), for each cost code, for
each route group that you created (see Periods, on page 214). Enter the
pricing information, such as price per minute, minimum duration, duration increment, etc. Enter any time-of-day rate plans (creating appropriate
entries in the times table, as required; see Periods, on page 214), or a
valid period for the rate.
7. From the Periods button, create a new period for each group.
Provisioning Tab
The partition member uses a unique combination of information, that is, carrier, region, service, and buysell to specify price related information, including rate, connection charge, effective dates, etc... The engineering group uses
the same information combination to specify endpoint related information,
including serialnumber, port, incoming prefix, outgoing prefix, etc... Upon
clicking on the Provisioning tab from the RSM system page, the Provisioning
tab window (example shown below) displays.
Figure 82. Provision Tab Example
179
7/21/06
6.
RSM Provisioning
5.1
8. The Provisioning tab contains the following menus and submenus. The
Rating>Rates Summary menu is active by default.
Table 8. Provisioning Tab Menus
Rating
Routing
Submenu
Function
Rates Summary
Displays rating details by Customer or Supplier.

Results are sorted by Carrier.
Regions Summary
Displays carrier plan information by Customer or

Supplier. Results are sorted by Region.
Rating Tables
-Rates and Routes
-Routes
-Rates
-Regions
-Periods
Used to add, modify, or delete information on carrier

plans, regions, route groups, rates, and rating periods.
Import
Used to import data from other sources, such as a

spreadsheet or any other type of application that
can produce a character delimited ASCII file2.
Rerate
Used to take CDRs that have already been rated,

and re-run the rating process against them.
Trace Rate
Provides carrier origination and termination details.
LCR
Used to view reports by Least Cost Routing (LCR)

and to update the LCR priority.
MPR
Used to view reports by Max Profit Margin (MPR).
Launch RSM Console
6.
Used to launch the RSM Console from within the

RSM application.
Note: Only the root user is authorized to access the rating function, found
under the Provisioning tab in RSM system release Release 4.0. For all
other users, the Rating function will not appear on the page.
RATING OPTION
As a VoIP session controller processes calls, it records many details about
each call. At a minimum, the data it collects includes items like the point at
which a call entered the network, and where it left, and the calls starting and
ending times1. All of this data, stored in Call Detail Records, or CDRs, can be
used for many purposes, among which is call rating, or determining the
180
7/21/06
RSM Provisioning
Menus
amount the customer is to be charged for the call transport services provided.
Connected with this is the ability to determine the profitability of a given
route, and if enabled, adaptive routing can dynamically change call routing to
maximize profitability.
Of course, all of this functionality requires data to be entered for rate plans for
routes served by each of a carriers endpoints. RSM rating function gives the
user the tools to enter, view, and maintain all of the data required for the system to rate CDRs.
6.
RSM Provisioning
Rates Summary Page

The Rates Summary provides rating details by Customer or Supplier.
To access the Rates Summary home page, follow these steps:
page 12.
2. Click Provisioning>Rating>Rates Summary.
3. The Rates Summary home page displays.
Figure 83. Rates Summary Home Page
fit on one screen.
1. There is much more data collected, like destination response codes, the callers
user id, the actual dialed number, etc. For detailed information on CDRs, see the
iServer Installation and Operations Guide chapter on Billing and CDR Processing.
181
7/21/06
Field Descriptions
Description
Report
This field allows you to select the report either by

Rates by Customer or Rates by Supplier.
Partition

and regions.
Carrier

associated.
Region
This field provides the region configuration from the

rating tables. For each region, order carriers are
listed in ascending order of the rate.
RATES SUMMARY CONTENT LEVEL

To access the content level of the Rates Summary page, follow these steps:
1. Select a Report, either Rates by Customer or Rates by Supplier.
2. Select a Partition.
3. Enter a Carrier (Optional).
4. Enter a Region (Optional).
Note: If you only select the Report and Partition element, you will get all
available data on these two entries. To further refine your selection,
enter three or four elements.
6. A page similar to the following graphic displays.
182
7/21/06
6.
RSM Provisioning
Field
Figure 84. Rates Summary Content Example
fit on one screen.
183
7/21/06
RSM Provisioning
6.
Field Descriptions
Description
Carrier

associated.
Region

Endpoint
A generic term describing an entity that sends calls

to or receives calls from the session controller
(iServer). An endpoint can be of various types - SIP
gateway, H.323 gateway, H.323 gatekeeper, SIP
proxy server, Softswitch, IP phone etc.
Priority
This is an arbitrary number assigned by the user.

The field can remain blank in which
case computes the priority based on price information. See NOTE below.
Rate
The units of currency billed for the call per minute of

billable time based on the other factors in the plan.
The rate can range from 0.0001 to 999.9999.
Rounds to 4 decimal places.
Minimum Duration
Based on a Plan Id and CostCode, the minimum

connection time, in seconds, for which the customer is billed, no matter how much shorter the call
is from that number.
Billing Increment
The time, or portion thereof, or call duration that

results in this many seconds being billed.
Connection Charge
A fixed charge that is added to the price of the call

for every billable call.
Start Date
This field indicates a date stamp from the selected

date forward or the date and time at which the rate
goes into effect.
184
7/21/06
6.
RSM Provisioning
Field
Field
Description
End Date
This field indicates a date stamp up to and including that date or the date and time at which the rate
ceases to be in effect.
Period
Represents the time of day in which the given rates

entry is valid. The period in the rates page points to
the period in the periods table.
6.
RSM Provisioning
Note: When a customer enters a LCR report, carriers for each regioncode
are ordered based on carrier "priority ", e.g., carriers with a higher priority appear first, followed by carriers with lower priority. By default, the
priority is computed using a formula like 10 * (1000000 rate * 10000),
such that the lower the price, the higher the priority. You can choose
to overwrite the computed default priority with specified priorities.
Once you set a specified the priority changing of the price wont affect
the priority.
Filters
REGIONS SUMMARY
Use these procedures to create, modify and delete carrier plans.
To access Regions, follow these steps:
1. Click Provisioning>Rating>Regions Summary.
2. The Regions Summary home page displays.
185
7/21/06
Figure 85. Regions Summary Home Page Example
RSM Provisioning
6.
186
7/21/06
Field Descriptions
Description
Report
This field allows you to select the report either by

Regions by Customer or Regions by Supplier.
Partition

and regions.
Region

listed in ascending order of the rate (Optional)
Carrier

partners of the owner of the VoIP network controlled by the session controller with which RSM is
associated (Optional).
Regions Summary Content Level

To access the content level of the Regions Summary page, follow these steps:
1. Select the Report, either Regions by Customer or Regions by Supplier.
2. Select the Partition.
3. Enter the Region Code (Optional).
4. Enter the Carrier (Optional).
Note: If you only select the Report and Partition element, you will get all
available data for the partitioned group. To refine your selection, enter
three or four elements.
6. Click the <Prev and Next> buttons if the report doesn't all fit on one
screen.
7. A page similar to the one below displays.
187
7/21/06
6.
RSM Provisioning
Field
Figure 86. Regions Summary Content Example
RSM Provisioning
6.
188
7/21/06
Field Descriptions
Description
Region

Carrier

partners of the owner of the VoIP network controlled by the session controller with which RSM is
associated.
Endpoint
A generic term describing an entity that sends calls

to or receives calls from the session controller
(iServer). An endpoint can be of various types - SIP
gateway, H.323 gateway, H.323 gatekeeper, SIP
proxy server, Softswitch, IP phone etc.
Filters
RATING TABLES
As a VoIP session controller processes calls, it records many details about
each call. At a minimum, the data collected includes items such as the point at
which a call entered and exited the network, the callers user ID, the actual
number dialed, and the calls starting and ending times. All of this data, stored
in Call Detail Records (or CDRs), can be used for many purposes, among
which is call rating, or determining the amount the customer is to be charged
for the call transport services provided. Connected with this is the ability to
determine the profitability of a given route, and, if enabled, adaptive routing
can dynamically change call routing to maximize profitability.
Of course, all of this functionality requires data to be entered for rate plans for
routes served by each of a carriers endpoints. RSM rating function gives the
user the tools to enter, view and maintain all of the data required for the system to rate CDRs.
Note: The root user and users who have root access privileges are authorized to access the rating function in RSM system release Release 4.2.
Otherwise, the rating function does not appear on the page.
189
7/21/06
6.
RSM Provisioning
Field
The rating function provides five categories of data maintenance functionality. These are described below:
Table 9. Rating Tables Data Maintenance

Description
Routes
Used to create, modify and delete a carrier plan. A

route is an aggregate of all regions an endpoint is
serving. CostCode allows specifying differing rates
for multiple carriers using a common set of routes.
Rates
Used to create, modify and delete routes. Based on

a Plan ID and Cost Code, rates establish how much
a call costs, based on minimum call duration, billing
increment and units of currency per unit of billing
time. Rates can also take into account call starting
and ending times, and connection chargesin
short, various calling terms that can be negotiated
are applied to the CDR to determine cost of a call.
Regions
Used to create, modify and delete a

region.These are the areas of service, often a
combination of geography and connection
method (like NOWHERELAND-CANSANDSTRING), and the digits required to get to
them, such as 011251 for a call to Ethiopia.
Periods
Used to view, create, modify and delete a

period.Rates can be based on many timerelated factors, such as hour of the day or day
of the week. From this button, you set up combinations of hour, minute, second, day of
week, day of month, etc. Each time has an
index number by which you refer to it in the
Rates page.
Accessing the Rating Tables

To access the Rating Tables, follow these steps:
1. Click Provisioning > Rating Tables.
2. The Rates and Routes home page displays by default.
190
7/21/06
6.
RSM Provisioning
Functionality
Figure 87. Rates and Routes Home Page
Rates and Routes

Rates and Routes page provide a summary of information on all carrier endpoints, the routes they serve, and the rates for those routes. Use the procedures
in this section to view, create, modify and delete a carrier plan. The Rates and
Routes option lists all currently defined carrier plans providing a summary of
information on all carrier endpoints, the routes they serve, and the rates for
those routes. The rates and routes table are created based on partition IDs,
e.g., each partition get its own set of tables. Use the procedures in this section
to view, create, modify and delete rates and routes.
ACCESSING THE RATES AND ROUTES

To access Rates and Routes, follow these steps:
1. Click Provisioning>Rating>Rating Tables>Rates and Routes.
2. The Rates and Routes home page displays.
191
7/21/06
RSM Provisioning
6.
Figure 88. Rates and Routes Page Example
RSM Provisioning
6.
192
7/21/06
Field Descriptions
Description
Partition
The name of the a partition of which the user is a member. Partitioning is the method of creating virtual RSM
and iServer systems. A partition is defined by a set of
Carrier
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.
Example: MegaTel
Region
This field provides the region configuration from the rating tables. For each region, order carriers are listed in
ascending order of the rate.
Service
This is an arbitrary string defined by the user to distinguish the carrier and region served by different
endpoints.
For example, you could have the following string:
Buy, Carrier1, Region1, EP1, premium
Buy, Carrier1, Region1, Silver
VIEWING RATES AND ROUTES CONTENT DETAILS

To view carrier plan details on a specific carrier, follow these steps:
1. Enter as many carrier elements as possible.
3. Output for the selected carrier displays.
4. Below is a sample of content based on the selection criteria we entered.
193
7/21/06
6.
RSM Provisioning
Field
Figure 89. Rates and Routes Content Example

(Partial View)
fit on one screen.
194
7/21/06
RSM Provisioning
6.
Field Descriptions
Description
Carrier
This is a summary of information on all carrier endpoints, the routes they serve, and the rates for
those routes.
Region

Service
endpoints.
Endpoint
The IP address or registration ID (RegId) as provisioned in the session controller of the endpoint to
which this plan applies. Appears in the CDR. Oneto-many relationship from carriers to endpoints.
Example: 10.0.0.1
Port
The port number provisioned for this endpoint in the

session controller. This number appears in the
CDR.
Priority
This is an arbitrary number assigned by the user.

The field can remain blank in which case RSM
computes the priority based on price information
Rate
The units of currency billed for the call per minute of

billable time based on the other factors in the plan.
Rounds to 4 decimal places.
ANI
Automatic Number Identification. A service that provides the receiver of a telephone call with the number of the calling phone.
Incoming Prefix
This prefix is appended to the phone numbers for

calls to the endpoint. For example, the incoming
number is 55#01152123456, with 55# being the
incoming prefix. This number is stripped off the
phone number, e.g., 55#01152123456 is stripped
to 0115213456, before it is matched to the routing
tables for rating.
195
7/21/06
6.
RSM Provisioning
Field
Description
Outgoing Prefix
This prefix will be appended to the phone numbers

for calls from the endpoint.
Rating Strip
The number of digits to be stripped from the dialcode.
Rating Addback
The quantity of leading digits to be removed

stripped) from the dialed number before matching
digits and aggregating results. These digits are
used to construct ingress routes on the endpoints.
6.
Minimum Duration
Based on a Plan ID and Cost Code, the minimum

connect time, in seconds, for which the customer is
billed, no matter how much shorter the call is from
that number.
Billing Increment
The time or portion thereof or call duration that

results in this many seconds being billed.
Country
Identifies the country associated with the plan.
Connection Charge
A fixed charge that is added to the price of the call

for every billable call.
Effective Date
The date on which the rate takes effect.
Period

Filters
Routes
A route is an aggregate of all regions an endpoint is serving. A Cost Code
allows specifying differing rates for multiple carriers using a common set of
routes.
Use the procedures in this section to create, modify and delete routes.
196
7/21/06
RSM Provisioning
Field
ACCESSING ROUTES
A route is an aggregate of all regions an endpoint is serving. The EndpointID
is referenced from the endpoints and the regioncode from regions table, ANI
from ANI table, CarrierID from carriers_<partitionID> table.
Accessing the Route Home Page
6.
To access Routes, follow these steps:
RSM Provisioning
1. Click Provisioning>Rating Tables>Routes.

2. The Routes home page displays.
Figure 90. Routes Home Page Example
197
7/21/06
Field Descriptions
Description
Partition
The name of the a partition of which the user is a member. Partitioning is the method of creating virtual RSM
and iServer systems. A partition is defined by a set of
Carrier
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.
Example: MegaTel
Region
This field provides the region configuration from the rating tables. For each region, order carriers are listed in
ascending order of the rate.
Service
endpoints.
VIEWING SPECIFIC ROUTE CONTENT

To show details for a specific route group, follow these steps:
1. Enter a Route Group.
3. Enter a Region Code (optional).
4. Enter a Cost Code (optional).
Note: The more selections you make, the more refined your output.

6. The page displays route group details based on your selection criteria.
For our example, we selected:
198
7/21/06
6.
RSM Provisioning
Field
Route Group = C2-Rg2

Partition = admin
Figure 91. Route Content Page Example (Partial

View)
RSM Provisioning
6.
fit on one screen.
Filters
ADDING A NEW ROUTE

To add a new route to the routes table, follow these steps:
1. Click Provisioning>Rating Tables>Routes.
2. The Routes home page displays.
4. The Add Route page displays.
199
7/21/06
Figure 92. Add Route Page Example
RSM Provisioning
6.
5. Select the Type of carrier, i.e., Customer or Supplier.

6. Click on the Partition list and select a partition from the list, or create a
new one.
7. Select a Carrier from the list.
8. Click on the Region Code list.
Note: The carrier must have at least one region code.
8.1
If the region code you want already exists in the list, click on its
name.
8.2
If the region code you want does not already exist, select --new-from the list. A pop-up window opens.
9. Enter Endpoint details, i.e., device, endpoints and ANI.

10. Enter Routing Information, i.e. incoming prefix, outgoing prefix, and use for rating.
200
7/21/06
11. Enter Rating Information, i.e., strip digits and addback string.
12. Once you have set all these parameters, click the Submit button to save
your work.
13. Click the Back button to return to the Routes home page.
UPDATING A ROUTE
To update a route, follow these steps:
1. From the Routes home page, click on the Route Group you wish to update.
RSM Provisioning
2. The Update Route page displays.
Figure 93. Update Route Page Example
3. Make all necessary updates, when finished click the Submit button.
A message similar to the one below displays:
Route xxxx is updated
DELETING A ROUTE
To delete a route, follow these steps:
1. Click the trash can icon, to the left of the Route name.
6.
201
7/21/06
Figure 94. Delete Route Dialog Example
6.
RSM Provisioning
3. Click OK to delete the route.

Route xxxx is deleted from the database
4. Click Cancel to cancel out of the dialog.
Automatic Number Identification (ANI)

The Automatic Number Identification (ANI) is a service that provides the
receiver of a telephone call with the number of the calling phone.
ADDING AN ANI PREFIX

To add a new ANI Prefix, follow these steps:
1. From the Routes Dialog, under the appropriate ANI column, click the New
link.
2. The Add ANI Prefix dialog displays.
Figure 95. Add ANI Dialog Example.
202
7/21/06
3. Enter the ANI name.

4. Enter the Call Number.
5. Enter the Prefix.
6. Click the Submit button to save your entries.
7. A message similar to one below displays:
ANI of nnnn is added to the database
Field
Description
ANI
Automatic Number Identification. A service that provides the receiver of a telephone call with the number of the calling phone.
Call Number
The E.164 number from which the call was placed.
Prefix
A number optionally prepended to the whole or part

of the calling phone number.
Rates
Rates are based on a Plan ID, rates establish how much a call costs, based on
minimum call duration, billing increment and units of currency per unit of
billing time. Rates can also take into account call starting and ending times,
and connection chargesin short, various calling terms that can be negotiated
are applied to the CDR to determine cost of a call. The rates table references
the PeriodID from the periods table, regioncode from the rates table, CarrierID from the carriers_<partitionID> table.
Use the procedures in this section to create, modify and delete rate plans.
ACCESSING RATES
To access Rates, follow these steps:
1. Click the Provisioning>Rating Tables>Rates.
2. The Rates home page displays.
203
7/21/06
RSM Provisioning
6.
Field Descriptions
Figure 96. Rates Home Page Example
RSM Provisioning
6.
VIEWING RATE CONTENT PAGE

To view rate details for a specific plan, follow these steps:
2. Enter Carrier, Region and Service details.
4. A page similar to the one illustrated displays.
204
7/21/06
Figure 97. Rates Content Page Example (Partial View)
RSM Provisioning
6.
fit on one screen.
Filters
ADDING A NEW RATE PLAN

To add a new rate plan to the RSM rating database, follow these steps:
1. Click Provisioning>Rating Tables>Rates.
2. The Rates home page displays.
205
7/21/06
3. To open the Add Rate page, click the Add button.

4. The Add Rate page displays.
Figure 98. Add Rate Window Example
RSM Provisioning
6.
5. Select a carrier Type, i.e., Customer or Supplier.

6. Select a Partition for this route. To choose an existing route, click-drag on
the Group list, dragging downward in the list until you see the group you
want; the list will scroll if you drag past the bottom of it. Release the
mouse button over the desired code.
7. Select a Carrier for this route from the carrier list.
8. Enter a Service.
9. Enter Rate details for the route.
A couple of tips:
9.1
To enter dates, click on the calendar icon to the right of the date
field, and then click on the date you want.
9.2
You can also specify a time for each date.
206
7/21/06
10. Once all the parameters are set, save your work by clicking Submit to save
your work.
UPDATING AN EXISTING RATE

To update a rate that already exists, follow these steps:
1. From the Rates home page, click on the Rate you wish to update.
2. The Update Rate page displays.
6.
RSM Provisioning
Figure 99. Update Rate Window Example
3. Once you have all necessary updates, click Submit to save your work.
Plan xxxx is updated
5. Or click the Back button to leave the page without saving your work.
DELETING AN EXISTING RATE PLAN

To delete an existing rate plan, follow these steps:
1. Click the trash can icon next to the plan to be deleted.
3. Click the OK button to delete the plan.
207
7/21/06

Plan xxxx is deleted from the database
5. Click the Cancel button to cancel out of the dialog.
Regions Page
Use these procedures to create, modify and delete carrier plans.Use the procedures in this section to create, modify and delete carrier plans.
ACCESSING THE REGIONS HOME PAGE

To access Regions, follow these steps:
1. Click Provisioning>Rating Tables>Regions.
2. The Regions home page displays.
Figure 100. Regions Home Page Example
208
7/21/06
6.
RSM Provisioning
These are the areas of service, often a combination of geography and connection method (e.g., NOWHERELAND-CANSANDSTRING), and the digits
required to get to them, such as 011251 for a call to Ethiopia.
VIEWING SPECIFIC REGION CONTENT

To view specific details on a particular region, follow these steps:
2. Enter a Region Code.
3. Enter a Dial Code.
If you do not know the dial code for a region, under the Region Codes:
column, click on the region you wish a dial code for. The dial code is displayed in the Dial Codes: column.
RSM Provisioning

5. The system displays details on the particular region.
Filters
ADDING A NEW CALLING REGION

To add a new calling region, follow these steps:
1. Click Provisioning>Rating Tables>Regions.
2. The Regions home page displays.
4. The Add Region page displays.
6.
209
7/21/06
Figure 101. Add Region Page Example
RSM Provisioning
6.
5. Enter the new Region Code you are creating. Remember that the code
name is limited to 32 characters. By convention, region codes are generally typed in all upper-case characters, with no embedded spaces.
Hyphens or underscores can be used to separate words.
7. Provide a brief text Description (up to 64 characters) to assist other users
in understanding this record.
8. 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 between each.
9. Click Add button. The dial code appears in Dial Codes column.
Note: 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 between each or you can enter one dial code
10. When you have entered all of your entries, click the Submit button.
210
7/21/06

Region xxxx is added to the database
12. Click Close to leave the dialog box without saving your work.
13. To go back to the previous page, click the Back button.
RSM Provisioning
6.
211
7/21/06
Field Descriptions
Description
Region Code
Describes a region, used to partitioned one or mode dial

codes. Specify one region code in this field. (This field
allows wildcards.). By convention, region codes are generally typed in all upper-case characters, with no embedded spaces. Hyphens or underscores can be used to
separate words.
Partition
The name of the a partition of which the user is a member.
Description
Enter a brief description of the dial code.
Dial Codes
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. CDRs contain three different dialed number fields, as follows:
FRMSRC - The number as dialed by

the originator
AFTERSRCCP - The number after
applying the source calling plan
ATDEST - The number as dialed to
the terminator.
Note: NOTE: 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
RSM Regions table.
Enter Dial Codes
This is a phone number prefix string used to match

the phone number for that region. Valid characters
are 0123456789+ ; *
Updating a Region
To update a region, do the following:
1. From the Regions page, click on the region to be updated.
212
7/21/06
6.
RSM Provisioning
Field

3. The Update Region page displays.
Figure 102. Update Region Page Example
RSM Provisioning
6.
4. Update the information on this window you wish to change, when finished click.
Region xxxx is updated
DELETING A DIAL CODE FOR AN EXISTING REGION

Dial codes are removed from the database as follows:
1. Locate the existing dial code you wish to remove, scrolling down if necessary. Single-click on that code.
2. Click the Delete button.
3. The Region deletion dialog displays.
4. Click the OK button to delete the region.
Region xxxx is deleted from the database
213
7/21/06
6. The dial code you deleted no longer shows in the list.
Periods
The Periods functionality allows you to create and name a period representing
a specific span of time. Use the procedures in this section to view, create,
modify and delete a period.
To access the Periods page, follow these steps:
6.
1. Click Provisioning>Rating>Rating Tables>Periods.
RSM Provisioning
2. The Periods home page displays.
Figure 103. Periods Page Example
214
7/21/06
Field Descriptions
Description
Partition
The name of the a partition of which the user is a

requesting reports.
Period.
This field is a name entered by the user to represent a specific period of time. For example, if the
period of time is from 9 a.m. to 5 p.m., you might
type Peak 9-5 in this field.
6.
RSM Provisioning
Field
Note: In RSM 4.X the field name Group has been changed to Partition.
VIEWING DETAILS FOR A SPECIFIC PERIOD

To show details for a specific period, follow these steps:
1. Enter a Period name.
4. The page displays route group details based on your selection criteria.
Figure 104. Periods Content Page Example
screen.
215
7/21/06
Field Descriptions
Description
Period
This field is a name entered by the user to represent a specific period of time. For example, if the
period of time is from 9 a.m. to 5 p.m., you might
enter the period name Peak 9-5 in this field.
Partition

requesting reports.
Zone
Identifies the time zone of the configured period.
Week Days
Indicates the start and end week day(s) of the

week: Monday-Sunday.
Time
Indicates the Start and End times set for the period.
The time is specified in the format hh:mm:ss.
Created
Indicates the date and time that the period was created. The date is specified in the format yyyy-mmdd. The time is specified in the format
hh:mm:ss.msec.
Last Modified
Indicates the date and time that the parameters for

the period were last modified.
The date is specified in the format yyyy-mm-dd.
The time is specified in the format
hh:mm:ss.msec.
6.
Filters
ADDING A NEW PERIOD

To add a new period to the rates table, follow these steps:
1. Click Provisioning>Rating Tables>Periods.
2. The home page displays.
3. From the Periods home page, click the Add button.
4. The Add Period page displays.
216
7/21/06
RSM Provisioning
Field
Figure 105. Add Period Page Example
5. In the Period field, type the name that represents a specific period of time.
For example, if the period of time is from 9 a.m. to 5 p.m., you might type
Peak 9-5 in this field.
There are two types of periods that can be configured, they are:
Range Period - where you select only one day in the Start Weekdays and
End Weekdays.
Example:
Start Week Days = Monday
End Week Days = Friday
Start Time = 6:00 a.m.
Therefore, the valid interval of this period is:
Start from 6:00 a.m., Monday
End at 6:00 p.m., Friday
217
7/21/06
RSM Provisioning
6.
Figure 106. Range Period Example
RSM Provisioning
6.
Specific day period: where you can select multiple start weekdays and
end weekdays, and start weekdays are same as end weekdays
For example:
Start Week Days = Monday, Tuesday, and Friday
End Week Days = Monday, Tuesday, and Friday
Start time = 6:00am
End time = 6:00pm
Therefore, the valid time interval for this period is:
Start from 6:00am of Monday, end at 6:00pm of Monday
Start from 6:00am of Tuesday, end at 6:00pm of Tuesday
Start from 6:00am of Friday, end at 6:00pm of Friday
218
7/21/06
Figure 107. Specific Period Example
6. In the Partition field, from the pull down list, select the partition for this
period.
7. When all entries have been made, click Submit to save your work.
Period xxxx is added to the database
219
7/21/06
RSM Provisioning
6.
Field Descriptions
Field
Description
Period

Partition

requesting reports.
RSM Provisioning
6.
Time Zone
Specifies the time zone the report is going to use,

i.e., if GMT is selected, then
the Start and End date are in GMT and, all date
time (first call, last call, etc.)
are displayed in GMT, except in the CDR detail
view.
Start Week Days
Indicates the start day(s) of the week: MondaySunday.
End Week Days
Indicates the end week day(s) of the week: Monday-Sunday.
Start Time
The time to start counting/looking for alarms. For a

description of how start time
applies to Gateway Minutes alarms, see Gateway
Minutes Alarms.
End Time
The time the system stops counting/looking for

alarms.
UPDATING PERIODS
To update a period, follow these steps
1. From the Periods home page, click on the Period you wish to update.
2. The Update Period page displays.
3. Make all necessary updates and click the Submit button to save your
work.
Period xxxx is updated
5. Click Back to return to the previous window.
220
7/21/06
DELETING A PERIOD
To delete a Period, follow these steps:
1. Click the trash can icon to delete the period.
2. The Delete Period dialog displays.
3. Click OK to delete the rate plan.
5. Click Cancel to cancel out of the dialog.
Import
The Rating function allows you to import data from other sources, such as
spreadsheets or any other application that you can use to produce a character
delimited ASCII file2. The Import File dialog for each sub-function shows the
record format required for that type of data; that is, the import function for
carrier plans has one record format, rates data has another, and so forth.
To access the Import window, follow these steps:
1. Click Provisioning>Rating>Import.
2. The Import window displays.
Figure 108. Import Page Example
221
7/21/06
RSM Provisioning
6.
Period xxxx is deleted from the database
3. In the Action field,

click on Add/Replace to add the contents of the import file to the
data already in the RSM database, or Replace to clear the existing
database contents before importing the data from the import file.
click on Remove All and Add to remove all contents of the import
file or to add contents to the import file.
5. From the Device list, click the device you wish to import.
6. From the Import Table list, click the table (i.e., Customer Rates, Supplier
Rates, etc., to be imported).
Note: For each of the import type selections, you should see the required format right at the bottom of the window.
7. In Select the file enter the full path to the file that contains the records to
be imported, or locate it with the Browse button.
Note: If you have a file that contains content in the shown format. When you
choose the Select File, you can browse your local machine and
choose the file.
8. Specify a Delimiter character. A semicolon (;) is frequently used, but any

character will work, as long as that character doesnt appear in any of the
actual data being imported.
9. Click Import to process the file you specified.
222
7/21/06
6.
RSM Provisioning
4. From the Partition list, click the partition entry which you are importing
data.
Field Descriptions
Field
Description
Action
This field allows you to Add/Replace the contents of

the import file to the data already in the RSM database, or Remove All and Add to clear the existing
database contents before importing the data from
the import file.
Partition
The name of the a group of which the user is a

group. Group membership controls the endpoints
and ports accessible to that user when requesting
reports.
Device
This field indicates the name of the configured

device.
Import Table
Allows you to select a table name from a list to

import.
Select the file
Allows you to enter a full path name to the file that

contains the records to be imported.
Delimiter

RSM Provisioning
6.
IMPORT FORMAT HELP

1. To receive more details on the import format for the selected table, click
on the following prompt:
Click Here for Import Format Help on Selected Table
2. A page similar to the one illustrated displays:
223
7/21/06
Figure 109. Import Format Help Page
RSM Provisioning
6.
Rerate
The RSM system rates CDRs to determine the amount a customer is billed for
services provided in carrying the call that the CDR describes. At times it may
be appropriate to take CDRs that have already been rated, and re-run the rating process against them, such as when the calling plan information has
changed. RSM' Re-rate function does this.
Note: The re-rate process can take a very long time to run.
To mark CDRs to be re-rated, follow these steps:

1. Click Provisioning>Rerate.
2. The Rerate home window displays.
224
7/21/06
Figure 110. Rerate Home Page Example
3. Enter the Begin Date and then the End Date by clicking the Calendar button.
4. The Calendar dialog displays.
5. Select the beginning and ending dates.
6. Enter the Time Zone by clicking on the list.
8. Enter a Endpoint Reg ID.
9. Enter a Port value.
10. Select from the following:
Orig Endpoint
Term Endpoint
Update user authentication bit only
Rate unrated CDRs only
12. The following message displays:
CDRS marked to be rerated
225
7/21/06
RSM Provisioning
6.
Field Descriptions
Description
Begin Date
This field indicates a date stamp from the selected

date forward.
End Date
This field indicates a date stamp up to and including that date.
Time Zone
Allows you to select either a Local or GMT time

zone.
Partition
This field provides a drop-down list of all partitioned

groups. A partition is defined by a set of realms,
endpoints and regions.
Endpoint Reg ID
A unique ID used internally by the iServer to identify an endpoint.
Port
Entering the port's value in this field, allows you to

specify a single port on that gateway.
Orig Endpoint
If this box is checked, originating endpoint from

which calls will be accepted by a particular receiving endpoint.
Term Endpoint
If this box is checked, terminating endpoint from

which calls will be accepted by a particular terminating endpoint.
Update user authentication bit

only
If this box is checked, user authorization to be recalculated automatically for the historically cdrs.
Rate unrated CDRs only
If this box is checked, only unrated CDRs will be

rated.
6.
Trace Rate
The Trace Rate option is a debugging tool that displays rated information, e.g.,
carrier, region, price, etc., based on a input CDR string. The Trace Rate feature simulates a CDR.
ACCESSING TRACE RATE

To access Trace Rate, follow these steps:
1. Click Provisioning>Trace Rate.
226
7/21/06
RSM Provisioning
Field
2. The Trace Rate home window displays.
Figure 111. Trace Rate Home Page Example
RSM Provisioning
6.
3. Enter all necessary fields and click the Show button.

4. After the rating process is completed the rated information is shown in the
table below the Trace Rate home page (see Figure 69 above).
Note: The information in this table provides the user with a toll to verify
whether there provisioning configuration information is correct.
ROUTING
This feature provides the following:
LCR and MPR Reports
One-click update of iServer with LCR generated routes
Supports sticky routes
Manual override of LCR generated routes
227
7/21/06
Download XML database of LCR routes

ANI number manipulation
DNIS number manipulation
Outgoing Tech prefix
The LCR functionality includes an easy to use report that displays the routes
prioritized by the order of least cost, and an export function that exports the
LCR table into an XML database that can be imported directly into a NexTone iServer.
The first column of the report is the region configuration from the rating
tables. The row corresponding to each region lists the carriers that supply the
route to that region, in ascending order of the cost. Each priority cell contains
the carrier name, the price per minute and the time-of-day constraint for the
rate, if any. The number of priority columns listed is dynamic and depend on
the maximum number of carriers that server any particular route.
The LCR report is computed as follows:
Iterate through all the regions in the regions table
For each region, choose the carriers with Buy rates from the carrier plans
table (suppliers/vendors)
For each of the carriers chosen, retrieve the rate and time-of-day constraint from the plans table
The default LCR priority order can further be overridden by the user.
Similar to the LCR report, another report called MPR (Most Profit Report).
has been added. This will be analogous to the LCR report, but works on the
customer side. The MPR report lists the carriers to whom the routes are being
sold to, and lists them in the order of decreasing price per minute (PPM), i.e.,
the priority is based on the highest profit margin as determined by PPM.
Accessing LCR
The Least Cost Routing (LCR) reports show the priority in which calls are
routed to carrier partners. The LCR functionality includes an easy to use
report that displays the routes prioritized by the order of least cost. iServer
228
7/21/06
6.
RSM Provisioning
Use the procedures in this section to view reports by Least Cost Routing
(LCR) Priorities, Max Profit Margin (MPR) Order, Customer and Supplier
Rates, and Customer and Supplier Regions.
Routes generation is a function that exports the RSM rating table into an
XML database which is then imported automatically into the NexTone iServer. To access the LCR feature, follow these steps:
1. Click Provisioning>Routing>LCR.
2. The LCR home window displays.
Figure 112. LCR Home Page Example
RSM Provisioning
6.
229
7/21/06
Field Descriptions
Description
Partition

requesting reports.
Send All Routes
When this box is checked, routes will be generated

based on all the data configured for the selected
partition and device.
If the box is not checked, then routes will be generated based on only modified rates, routes, ANI,
regions, etc., since last time of server update
Use Sticky Routes
A route with this option checked is a sticky route.

Typically used with call hunting, this means that
either a call completes with this route, or the call
fails.
An iServer call route can be tagged as sticky. This
means that once that route is reached, the call
either completes with that route, or the call doesnt
complete. More specifically, sticky routing is the
ability of the iServer to force call hunting to cease at
a point before reaching the end of all routes that
could potentially route a particular call. Once a
sticky route is encountered, the call either completes with that route3, or the call is rejected.
VIEWING SPECIFIC LCR CONTENT

To show details for a specific LCR, follow these steps:
1. Select a partition from the list.
2. For our example, we selected:
Partition = admin
4. The window displays LCR details based on your selection criteria.
230
7/21/06
6.
RSM Provisioning
Field
Figure 113. LCR Details Page
RSM Provisioning
6.
5. Use the < Prev and Next > buttons to navigate windows if the report
doesn't all fit on one screen.
Field Descriptions
Field
Description
Regions

Carriers
These fields provide a list of carriers that supply the

route to the region, in ascending order of the cost.
This information is computed from the 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.
Filters
231
7/21/06
UPDATING THE LCR PRIORITY

To update the LCR Priority assigned to a carrier, do the following:
1. From the Regions column, click the region you wish to update.
2. The Update LCR Priority dialog displays:
Figure 114. Update LCR Priority
RSM Provisioning
6.
3. To change the priority, you can either move the region name up or down.
4. Enter the new priority, and click OK.
5. In the Update LCR Priority window, click Submit to save your changes.
6. To close the Priority window, click > Close Window.
UPDATING A DEVICE
To update a device, follow these steps:
1. Make sure that you are on the window where you can view LCR specific
details.
2. Click on the Update Device button.
232
7/21/06
5. Or click the Cancel button if you do not wish to save the updates.
Most Profit Routing (MPR)

The Most Profit Routing (MPR) reports help you track which traffic routes generate the highest revenues.
ACCESSING MPR
The Most Profit Routing (MPR) reports help you track which traffic routes
generate the highest revenues.
To access the MPR page, follow these steps:
1. Click Provisioning>Routing>MPR.
2. The MPR home page displays.
233
7/21/06
RSM Provisioning
6.
4. Click the OK button to accept the updates.
Figure 115. MPR Home Page Example
RSM Provisioning
6.
screen.
234
7/21/06
Field Descriptions
Field
Partition
Description
requesting reports.
6.
RSM Provisioning
VIEWING CONTENT FOR A SPECIFIC MPR

To view details for a specific MPR, follow these steps:
1. Select a partition from the list.
For our example, we selected:
Partition = admin
3. The page displays MPR details based on your selection criteria.
Figure 116. MPR Content Page Example
235
7/21/06
screen.
Field Descriptions
Description
Regions

Carriers
These fields provide 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.
Filters
LAUNCHING 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 the following:
Configuring iServer system parameters, including Call Admission Control (CAC)
Add, Delete, and Update. Only the RSM and iServer databases are supported
Import and Export databases to and from iServer
Provide a map view of the iServers on the local and remote networks
The RSM Console is launched by clicking on the RSM Console link at the top
of the window (see figure below) or by clicking on the RSM Console link
under the Provisioning tab.
RSM Console Features

This RSM console feature allows for the following:
RSM Console to be launched from the browser
236
7/21/06
6.
RSM Provisioning
Field
Admin group users having unrestricted data access

Partitioned users having restricted access, i.e.,
Data authorization
Functional authorization
Partitioned users using this for:
Endpoint provisioning
To launch RSM Console, follow these steps:

1. Click Provisioning>Launch RSM Console or the RSM Console link at
the top of the window.
2. The following splash screens display:, in the order illustrated.
Figure 117. Java Splash Screen
IMPORTANT !Due to a difference in the certificate hostname (RSM.nextone.com) and the actual hostname when you attempt the
RSM Console login the following dialog displays.
237
7/21/06
RSM Provisioning
6.
Troubleshooting
Figure 118. Warning Dialog
6.
RSM Provisioning
WARNING MESSAGE WORKAROUND

Following is the workaround to suppress this warning message.
Workaround for Multiple Hostname Mismatch Warnings while downloading RSMConsole

C:\>javaws
edit->preferences->advanced->security
uncheck the following
'warn if site certificate does not match hostname'
click 'ok'
IMPORTANT ! This workaround will have a global system-wide
impact. This means, this hostname mismatch warning
will be suppressed for any applications installed over
the web.
238
7/21/06
Figure 119. Java Web Start Dialog
RSM Provisioning
6.
Figure 120. Loading iView
3. When RSM Console is successfully launched, the following window displays.
Figure 121. RSM Console Main Page
239
7/21/06
Setting Session Limits on Calls by Endpoints

Through a process known as call admission control (CAC), which provides
specific session limits, the iServer gives its administrator fine control over the
number of calls that a given endpoint will support. The maximum call limit of
an endpoint defines its capacity for routing calls in the network, enhancing its
usefulness for overall system load balancing and routing purposes.
Maximum Total Calls The overall number of calls the gateway will support, both ingress and egress.
Maximum Ingress Calls The maximum calls that may be placed from
that endpoint/gateway to the iServer.
Maximum Egress Calls The maximum number of calls that may be
placed to that endpoint/gateway by the iServer.
One method used is to assign an endpoint/uport to a concurrent call group
limit, known as an iEdge Group (IGRP), to which multiple uports subscribe
and collectively contribute. This system of collective limits can be administered from within RSM Console.
In addition, at the subnet level (see Subnet CAC), the iServer now has the
capability to limit the following:
Maximum Total Bandwidth The overall bandwidth the subnet will support, both ingress and egress.
Maximum Ingress Bandwidth The maximum bandwidth that may be
placed from that subnet to the iServer.
Maximum Egress Bandwidth The maximum bandwidth that the iServer
may place to that subnet.
iEdge Group (IGRP) Limits

iEdge Groups (IGRP) is a method used to collectively set limits of calls to an
endpoint by assigning an endpoint/uport to a concurrent call group limit
(known as an IGRP) to which multiple uports subscribe and collectively contribute. This limit also is broken down by incoming, outgoing and total concurrent calls. The RSM Console provides a utility for managing iEdge groups,
allowing you to add, change, or delete iEdge groups. You can also monitor the
current operating status of existing groups.
240
7/21/06
6.
RSM Provisioning
The iServer allows you to set independent session limits for three parameters
at the gateway level:
ACCESSING THE IEDGE GROUP UTILITY

To access the iEdge Group utility, do the following:
1. In the RSM Console window, double-click on the iServer you want to
configure.
RSM Provisioning
6.
2. The iServer main window displays.
241
7/21/06
Figure 122. iServer Main Page Example
RSM Provisioning
6.
3. Select Utilities>iEdge Group.
242
7/21/06
Figure 123. Utilities List Page
RSM Provisioning
6.
4. The iEdge Groups page displays. A list of any existing IGRPs is displayed in the columns below.
243
7/21/06
Figure 124. iEdge Group Page Example
RSM Provisioning
6.
MENU OPTIONS
The available menus are as follows:
File
Close Closes the iEdge Group page.
Edit
Add Used to add an iEdge Group.
Delete Used to delete an iEdge Group.
Review
Refresh Used to refresh the iEdge Group page.
244
7/21/06
Field Descriptions
Field
Description
Partition
Identifies the partition name. (This field allows

Administrators to add/edit iEdge Groups from different partitions.)
Name
The user-assigned name for the iEdge group.
Max Calls In
The maximum calls that may be placed from that

endpoint/gateway to the iServer.
Max Calls Out
The maximum number of calls that may be placed

to that endpoint/gateway by the iServer.
Max Calls Total
The overall number of calls the gateway will support, both ingress and egress.
Max Bandwidth In
The limits on bandwidth, in bits-per-second (bps),

that a subnet can consume, along with block
(None) and no limit (Unlimited) checkboxes.
Max Bandwidth Out
The limits on bandwidth, in bps, that a subnet can

consume, along with block (None) and no limit
(Unlimited) checkboxes.
Max Bandwidth Total

IMR
The policy set for Within IGRP Media Routing.
EMR
The policy set for Between IGRP Media Routing.
Max Calls Out Time
The last time one or more calls were turned away

because the limit was reached.
RSM Provisioning
6.
ADDING AN IEDGE GROUP

To add an iEdge Group, do the following:
1. From the iEdge Group page, select Edit>Add.
2. The Add iEdge Group dialog displays.
245
7/21/06
Figure 125. Add iEdge Group Page Example
RSM Provisioning
6.
3. Select the Partition from the list.

4. Enter a Name for the iEdge Group.
5. Enter the Max Calls In Legs, Max Calls OutLegs, and Max Calls Total
Legs parameters.
6. Enter the Max Bandwidth In, Max Bandwidth Out, and Max Bandwidth Total parameters.
7. Enter a Timeout period.
8. Set the policy for the kinds of realm-based media rating allowed in the
Between iEdge Media Routing and Within iEdge Media Routing
fields.
9. Enter the Max Calls Out Time.
10. Click the Add button to accept the additions.
11. Your additions re displayed in the iEdge Groups page.
246
7/21/06
Field Descriptions
Field
Description
Partition
Identifies the partition name. (This field allows

Administrators to add/edit iEdge Groups from different partitions.)
Name
The user-assigned name for the iEdge group.
Max Calls In Legs
The maximum calls that may be placed from that

endpoint/gateway to the iServer.
Max Calls Out Legs
The maximum number of calls that may be placed

to that endpoint/gateway by the iServer.
Max Calls Total Legs
The overall number of calls the gateway will support, both ingress and egress.
Max Bandwidth In
The limits on bandwidth, in bits-per-second (bps),

that a subnet can consume, along with block
(None) and no limit (Unlimited) checkboxes.
Max Bandwidth Out

Max Bandwidth Total

Timeout
Specifies the number of timeout seconds for a call.
Between iEdge Groups Media

Routing
Sets the policy on the kinds of realm-based media

routing allowed. Options are Ignore, Don't Care,
On, Always Off, and Always On.
Within iEdge Groups Media

Routing
Sets the policy on the kinds of realm-based media

routing allowed. Options are Ignore, Don't Care,
On, Always Off, and Always On.
Max Calls Out Time
Identifies the last time one or more calls were

turned away because the limit was reached. It is initialized to the creation date of the IGRP.
RSM Provisioning
6.
MODIFYING AN IEDGE GROUP

To modify an iEdge Group, do the following:
1. Double-click the group or click on the iEdge Group, right-click your
mouse and select Modify.
247
7/21/06
2. The Modify iEdge Group dialog displays.
Figure 126. Modify iEdge Group Page Example
RSM Provisioning
6.
3. Make all necessary changes and click the Modify button.

4. To close this dialog, click the Cancel button.
DELETING AN IEDGE GROUP

To delete an iEdge Group, do the following:
1. Click on the iEdge Group you wish to delete.
2. Select Edit>Delete.
3. The Delete? dialog displays.
4. Click the OK button to delete the selected iEdge Group.
5. If you do not wish to delete a iEdge Group, click the Cancel button.
CLOSING THE IEDGE GROUPS

To close the iEdge File window, do the following:
1. From the iEdge Groups window, select File>Close.
2. The iEdge Groups window closes.
248
7/21/06
Subnet CAC
Subnet-based Call Admission Control (CAC) is the ability to control call
admission and media routing policy based on the subnet a call setup comes in
from. This feature is useful in Tier 1 environments where a carrier doesn't
want to maintain a static list of individual endpoints that may register with its
iServer.
A special type of named iEdge entity, the policy, supports subnet-level CAC.
Assigning such control through a named set of parameters relieves the transport provider of the burden of manually maintaining a static database of all
their customers endpoints. As with statically-provisioned endpoints in previous releases, the aggregate number of calls (or bandwidth demand, for subnets) that the iServer will allow is controlled for ingress, egress, and total, or
that subnet. An iEdge Group (igrp) object (already existing in previous
releases) is bound to the subnet policy, to control call admission and media
routing.
Note: The new iEdge policy object is maintainable via CLI commands only.
CREATING A NEW IEDGE POLICY

To create and implement a new iEdge policy, follow these steps:
1. Identify or create an iedge group to use for this policy object.
2. Set the iedge group's policy parameters, if not already set.
Note: There are really three classes of iServer network element. a.) Static:
those manually provisioned, including their IP address, b.) Dynamic
(permanent): those provisioned without an IP address, with policy tied
to registration ID, and c.) Dynamic (transient): those not in the iServer's database at all. This feature applies policy to this third class,
those not in the iServer's database, when the iServer is operating in
OBP or mirror proxy mode.
3. Create a new, named iedge policy object.

4. Designate the object as type = policy.
5. Designate the policy type are policy-key = subnet.
6. Specify the subnet (IP address and subnet mask) to which the policy will
apply.
249
7/21/06
6.
RSM Provisioning
NEW ENTITY
7. Designate the realm to which this policy applies.

8. Designate the iedge group you identified or created in step 1 as the source
of CAC policy parameters for this policy object.
CLI COMMANDS
To accomplish the above procedure using CLI commands, follow these steps:
1. Create a new iEdge group (skip this step if it already exists):
6.
cli iedge add igrp iedgegroupname
RSM Provisioning
2. Set the iEdge group's policy parameters (if they don't already exist):
cli igrp edit iedgegroupname parametername parametervalue
3. Valid parameter name values:

Parameter Name
Description
maxcallsin
ingress calls limit
maxcallsout
egress calls limit
maxcallstotal
total [ingress & egress] calls limit
maxbwin
ingress bandwidth limit; parametervalue is in bps
maxbwout
egress bandwidth limit; parametervalue is in bps
maxbwtotal
total [ingress & egress] bandwidth; parametervalue

is in bps
emr
between iEdge groups routing [valid settings: xxx,

alwayson, alwaysoff, on
imr
within iEdge groups routing [valid settings: xxx,

alwayson, alwaysoff, on
Example:
cli igrp edit T1-igroup maxbwin 1544000
4. Create a new iedge policy object (the trailing zero indicates uport 0,
which is always required for policy objects):
cli iedge add policyname 0
5. Set the type to policy:
250
7/21/06
Note: See the Internal and External Media Routing Settings on page 248 for
descriptions and use of these settings.
cli iedge edit policyname 0 type policy
6. Set the key to subnet:

cli iedge edit policyname 0 policy-key subnet
7. Set the IP address for this policy:

cli iedge edit policyname 0 subnetip subnetIPaddress
6.
8. Set the subnet mask for this policy:
RSM Provisioning
cli iedge edit policyname 0 subnetmask subnetmask
9. Set the realm for this policy:

cli iedge edit policyname 0 realm realmname
10. Subscribe to the iEdge group for this policy:

cli iedge edit policyname 0 igrp iedgegroupname
Creating Subnet Based CAC

A new utility has been added to RSM's Console's iServer window for creating
and maintaining policy objects, to implement subnet-based CAC.
1. To access the utility, double-click the iServer's name in RSM's Console's
map window.
2. When the iServer window displays, choose Utilities>Policy.
251
7/21/06
Figure 127. Utilities Policy List Example
RSM Provisioning
6.
The Subnets window appears. Below is a partial example of the Subnet window.
Figure 128. Subnet Page Example (Partial View)
Note: Subnet is currently the only type of policy supported.
ADDING A NEW POLICY OBJECT

Before creating a new policy object, ensure that the iEdge group and realm to
which the new policy object will subscribe have already been created. If not,
create them, then return here.
252
7/21/06
To create a new policy object, follow these steps:

1. From the Subnets window, choose Edit>Add.
2. The Add Policy window appears.
Figure 129. Add Policy Page Example
RSM Provisioning
6.
3. Select the Partition from the list.

4. Enter the Policy Name (max. 31 chars.), IP Address of the subnetwork to
which this policy will apply, and the subnet Mask for that subnetwork.
5. Select a predefined realm name to which endpoints on this subnetwork
will belong, from the n Realm list.
6. Select a predefined iEdge group name defining the policy to be applied,
from the iEdge Group list.
7. Click the Modify button to create the new policy, or the Cancel button to
discard your work, and close the window.
MODIFYING A POLICY OBJECT

To modify an existing policy object, from the Subnets window:
1. Locate and double-click the policy you wish to change.
2. The Modify Policy window appears, showing the currently-defined
parameters for that policy.
253
7/21/06
IMPORTANT ! Note that you cannot change the Policy Name. You must
delete and recreate a policy to change its name. Doing so will break existing references to the policy.
3. As required, change IP Address of the subnetwork to which this policy
will apply, and the subnet Mask for that subnetwork.
4. As required, change the predefined realm name to which endpoints on
this subnetwork will belong, from the Realm list.
6. Click Modify to put your changes into effect, or Cancel to discard your
changes, and close the window.
IEDGE
GROUP PARAMETERS
To accommodate the additional policies now supported, the Add iEdge

Group and Modify iEdge Group windows have been changed (refer to the
RSM's Console Online Help for further details.).
254
7/21/06
6.
RSM Provisioning
5. As required, change the predefined iEdge group name defining the policy
to be applied, from the Edge Group list.
9
RSM STREAMING
INTRODUCTION
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.
Transform types and related elements are listed and defined in Table 10 and
Table 11.
Note: Only DBMS is supported in MySQL.
Editing the nars.lastseen File

1. To start the editing process,
2. 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:
/home/nextone/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.
255
7/21/06
10.
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.
<<9. RSM Streaming>>
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.
10.
3. Create the xml file for that stream.
RSM Streaming
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:

F S UID PID PPID C PRI NI
ADDR
8 S
0 27394
1 1 41 20 e6eb67e8
perl
F S UID PID PPID C PRI NI
ADDR
CMD
8 S
0 27402
1 0 40 20 e819d0c0
perl
SZ
WCHAN TTY
3940 e6d19336 ?
SZ
TIME CMD
23:36
WCHAN TTY
2049 e93bfe8a ?
TIME
0:01
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.
256
7/21/06
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
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 /home/nextone/cdrs/D20041001.CDR:1 -e /home/nextone/cdrs/D20041001.CDR:1000 > /tmp/cdrcatchup.log
2. Run the cdrcatchup.pl script. You run cdrcatchup.pl by running the

runcdrcatchup, enter:
./runcdrcatchup &
"&" 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
mysqldump
mysqldump
mysqldump
mysqldump
mysqldump
mysqldump
mysqldump
-ect
-ect
-ect
-ect
-ect
-ect
-ect
-ect
bn
bn
bn
bn
bn
bn
bn
bn
actions
alarms
carrierplans
endpoints
events
groups
license
periods
>
>
>
>
>
>
>
>
actions.sql
alarms .sql
carrierplans
endpoints
events .sql
groups .sql
license.sql
periods.sql
sql
sql
257
7/21/06
10.
RSM Streaming
nohup is used to prevent the cdrcatchup from abort when the SSH session expires
mysqldump
mysqldump
mysqldump
mysqldump
-ect
-ect
-ect
-ect
bn
bn
bn
bn
plans
regions
routes
users
>
>
>
>
plans .sql
regions.sql
routes .sql
users .sql
The above assumes that the MySQL root password is empty. If not, use the
following syntax:
> actions.sql
10.
Note: The software installation procedure consists of two parts, the server
and the agent.
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">
<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">
258
7/21/06
RSM Streaming
mysqldump -ect -u root -pPASSWORDbn actions
<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"/>
<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>
<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"/>
RSM Streaming
10.
259
7/21/06
<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>
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 10 on page 261.
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
<field
<field
<field
<field
<field
no="1" name="MswId"/>
no="2" name="Empty"/>
no="3" name="ANI"/>
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>
A description of each of these fields is found in Table 10, under the subheading, Output Block Elements.
260
7/21/06
RSM Streaming
10.
</stream>
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
RSM Streaming
10.
XML Elements
Table 10 lists the XML definition elements of the above example, and
explains the RSM streaming functions support of each.
Table 10. Streaming XML Elements

Element Name
Description
Destination Database Elements
(applies only to database streams)
dbtype
Always mysql, this is the type of the destination database
dbname
The name of the destination database
dbtable
The name of the table in the dbname database to which the streamed
data is sent
dbhost
The IP address of the machine to which the stream is sent
replace
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.
dbuser
The username used to log into the streaming destination database
dbpass
The password for the user account named in dbuser
261
7/21/06
Table 10. Streaming XML Elements (Contd)

Element Name
Description
Destination File Elements
(applies only to flat-file streams)
The complete path to the directory where the file will be created.
separator
The field-separator character that will be used in the created file, such as
a colon or semicolon
prefix
(optional) One or more characters prepended to the name of the CDR

file being processed, to obtain the destination file name.
suffix
(optional) One or more characters appended to the destination file name

to indicate its file type.
Output Block Elements

field no
A number you assign that determines the order of the fields appearing in
the output file. Normally its just a sequential number, starting at 1. Gaps
in the numbering are permitted.
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.
subfield
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.
separator
The character NARS inserts between the subfields comprising the

higher-level field.
Field Elements
(applies to all streams)
field no
The number of the field within the source CDR according to the session
controllers CDR definition.
name
The CDR field name according to the session controllers CDR definition.
outname
The column name for this field in the remote database or flat file.
262
7/21/06
10.
RSM Streaming
dir
Table 10. Streaming XML Elements (Contd)

Element Name
fmt
Description
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 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.
transform type
The type of data transformation being performed; see Transform Types,

on page 263 for details.
format
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
This column is a unique key in the destination database.
/field
This element by itself ends the field definition for a field with a
transform nested within it.
field type=
constant
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.
field type=
variable
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
Transform Types
RSM streaming provides a data transformation function that allows a field to
be altered before being sent to the streaming database or file. Table 11 lists
263
7/21/06
10.
RSM Streaming
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.
the valid values for transform type, and details each, including the elements
which are available within each type.
Table 11. Streaming Transform Types and Elements

Description
keep
Type. The content of this field is kept, although other aspects of it may be
altered, such as changing the fields destination column name with the
outname attribute
date
Type. Transform the date in this CDR field into the format specified in this
transforms format= element
time
Type. Transform the time in this CDR field into the format specified in this
transforms format= element
zone
Element used with the time transform, any valid value for a Unix time
zonea, literally expressed, in quotation marks.
expr
Type. Perform a mathematical computation on the value in this CDR field

according to the expression in the value= element for this transform
matchkey
Element of the expr type. To perform a computation on a CDR field

value using the expr type, the value must be assigned to a variable. This
element names the variable
value
Element used as follows:

With the time transform, forces the time to be expressed in units as
follows:
value=sec, express the time in seconds
value=min, express the time in minutes and fractional minutes
value=hours, express the time in hours and fractional hours
With an expr transform, specifies the computation to be performed
With a constant element, specifies the contents of the field
condition
Type. Examines the state of the CDR field, and performs the operation
specified in the element that follows it.
(For NARS Release 4.2, this type is only valid with the ifempty element.)
ifempty
Element. Specifies the field number to use in place of this CDR field if
this CDR field is not populated
a. See Selecting Time Zones, on page 20 for more information.
The general process for transforming data is:

1. Specify the CDR field in the MSW/MSC CDR file.
264
7/21/06
10.
RSM Streaming
Type/Element
2. Specify the transformations on the field selections and give a output

name.
3. Map the output names to a specific destination field order (optionally concatenate together one or more output names).
RSM Streaming
10.
265
7/21/06
A
SELECTED DATABASE OPERATIONS
INTRODUCTION
This appendix presents a few select database administration functions for the
NARS DBA to use when necessary for disaster prevention or recovery. They
include:
In order to perform this procedure, you must be logged into the RSM server
via Telnet or SSH and not from the Web.
Backing up an entire database
Backing up and restoring one or more tables within a database
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. Links to the on-line manuals are
provided with each command below.
Note: Backup data is dumped to a flat file, which the user must have OSlevel permission to write.
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:
1. Log onto the RSM server using the root account, or another account with
administrative privileges.
2. Decide on a destination location for the backup. Create a new directory if
necessary.
A-1
7/21/06
A.
Selected Database
Operations
A utility for dumping the contents of a database in a format that includes

SQL statements for re-creating the database
<<A. Selected Database Operations>>
Note: The flat file resulting flat file can be very large, so be sure to provide
enough space in your partition for it!
3. At the system prompt, enter:

mysqldump -A -a -x -F [-u=username [-p[=passwd]] ] RSM > backup_file_path
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.
INDIVIDUAL TABLE BACK-UP

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 at http://www.mysql.com/doc/en/BACKUP_TABLE.html.
INDIVIDUAL TABLE RESTORE
A-2
7/21/06
A.
Selected Database
Operations
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. Selected Database Operations>>
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 at http://www.mysql.com/doc/en/RESTORE_TABLE.html.
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]
A.
Selected Database
Operations
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.
A-3
7/21/06
B
CLI COMMANDS
INTRODUCTION
Appendix B provides details on CLI commands and how to apply them to
the following elements:
User Account
Realms
ipphone
iServer
Adding an User Account

To add an user account, enter the following CLI commands:
add XXXXUserAcct 0
phones XXXXUserAcct 0 1234
edit XXXXUserAcct 0 type user
edit XXXXUserAcct 0 h323 disable
edit XXXXUserAcct 0 cdpntype pass
edit XXXXUserAcct 0 bcaplayer1 default
edit XXXXUserAcct 0 sip disable
edit XXXXUserAcct 0 xcalls 100
edit XXXXUserAcct 0 xincalls 0
edit XXXXUserAcct 0 xoutcalls 0
edit XXXXUserAcct 0 gateway disable
edit XXXXUserAcct 0 grq disable
edit XXXXUserAcct 0 rai disable
edit XXXXUserAcct 0 priority 0
edit XXXXUserAcct 0 rasport 1719
edit XXXXUserAcct 0 q931port 1720
edit XXXXUserAcct 0 tpg disable
edit XXXXUserAcct 0 vendor Cisco
B.
CLI Commands
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
B-1
7/21/06
<<B. CLI Commands>>
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
iedge
edit
edit
edit
edit
edit
edit
edit
edit
edit
edit
edit
edit
edit
edit
edit
edit
edit
edit
edit
XXXXUserAcct
XXXXUserAcct
XXXXUserAcct
XXXXUserAcct
XXXXUserAcct
XXXXUserAcct
XXXXUserAcct
XXXXUserAcct
XXXXUserAcct
XXXXUserAcct
XXXXUserAcct
XXXXUserAcct
XXXXUserAcct
XXXXUserAcct
XXXXUserAcct
XXXXUserAcct
XXXXUserAcct
XXXXUserAcct
XXXXUserAcct
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
mediarouting disable
nmr disable
hideaddresschange disable
maxhunts 0
h323display disable
mapalias disable
forceh245 disable
connh245addr disable
infotranscap default
deltcs2833 default
deltcst38 default
2833capable unknown
removetg disable
setdesttg disable
realm Realm1
pionfaststart disable
natdetect disable
natip
natport 0
iedge edit XXXXUserAcct 0 privacy both

iedge edit XXXXUserAcct 0
mapcc disable
cidblock disable
cgpntype pass
Adding a Realm
To add a Realm, follow these steps:
1. In this example, we will setup a Realm for XXXX using the RSA
209.125.86.91 already defined in the pools configuration.
2. The network will be a private network and SIP authentication will be used
for every message. There is no defined Sip Proxy so Mirror Proxy is not
configured.
3. For the media of the realm us pool 2 for the RMA and allow routing of the
media between realms but not within the realm.
4. cli realm add XXXXRLM - creates the Realm named XXXXRLM.
B-2
7/21/06
CLI Commands
B.
1. The mask for the RSA must be set as the network mask, in this case
255.255.255.224.
<<B. CLI Commands>>
5. cli realm edit XXXXRLM ifname e1000g0 - defines the interface the
realm is configured to use.
6. cli realm edit XXXXRLM mask 255.255.255.224 - defines the network
mask for this realm.
7. cli realm edit XXXXRLM rsa 209.125.86.91 - defines the actual
address(es) the devices using this realm will send signaling packets to as
opposed to any other address.
8. cli realm edit XXXXRLM addr private - sets this realm as looking toward
the "private" network.
9. cli realm edit XXXXRLM sigpool 1 - sets the pool ID for the signaling.
10. cli realm edit XXXXRLM medpool 2 - defines the pool ID for the media.
11. cli realm edit XXXXRLM imr always off - sets the Route Media
WITHIN the realm to off.
12. cli realm edit XXXXRLM emr always on - sets the Route Media
BETWEEN realms to on, capitalization for emphasis only and is not to be
expected anywhere else.
13. cli realm edit XXXXRLM admin enable - enables administration, of
course.
14. cli realm edit XXXXRLM sipauth all - all SIP requests will be authenticated and beaten severely if they fail to pass.
15. cli realm edit XXXXRLM cidblock - Caller ID info stuff.
16. cli realm edit XXXXRLM cidunblock - see above for a full description.
18. cli realm edit XXXXRLM proxy_uport -1 - this is the uport of that endpoint pertinent to this realm.
19. At this point you can view your results on RSM Console.
Adding an IP Phone
To setup an IP phone, follow these steps:
1. cli iedge add XXXXCLItest 0 - creates the device and the uport used for
this specific device and the routing as necessary.
B-3
7/21/06
B.
CLI Commands
17. cli realm edit XXXXRLM proxy_regid - the regid of the SIP Proxy, if one
is to be used as a Mirror Proxy. Only a true SIP Proxy can be used, not a
SIP gateway or any other mamby-pamby device, only a SIP Proxy.
<<B. CLI Commands>>
2. cli iedge phones XXXXCLItest 0 7879 - defines the extension for this
user's device.
3. cli iedge zone XXXXCLItest 0 Matt - defines the Zone for routing consideration for this device.
4. cli iedge email XXXXCLItest 0 tlast@testxyz.com - defines the email
address for contacting this user about its device.
5. cli iedge edit XXXXCLItest 0 fname Tester1 - defines the first name of
this devices specified user.
6. cli iedge edit XXXXCLItest 0 lname Last - defines the last name of the
user which can be seen in the database main view.
7. cli iedge edit XXXXCLItest 0 type ipphone - defines the device type as an
IP Phone
8. cli iedge edit XXXXCLItest 0 h323 disable - turns off H323, obviously
this device will have to use SIP
9. cli iedge edit XXXXCLItest 0 cdpntype pass
10. cli iedge edit XXXXCLItest 0 bcaplayer1 default
11. cli iedge edit XXXXCLItest 0 sip enable - turns on SIP to be the protocol
for signaling
12. cli iedge edit XXXXCLItest 0 xcalls 0 - sets the Total max calls to unlimited
13. cli iedge edit XXXXCLItest 0 xincalls 2 - sets the max calls Ingress to 2
14. cli iedge edit XXXXCLItest 0 xoutcalls -1 - sets the max calls egress to
none
16. cli iedge edit XXXXCLItest 0 grq disable - as this device does not use
H323 Gateway Request is not a usable option
17. cli iedge edit XXXXCLItest 0 rai disable - as this device does not use
H323
18. cli iedge edit XXXXCLItest 0 priority 0 - as this device does not use
H323
19. cli iedge edit XXXXCLItest 0 rasport 1719 - as this device does not use
H323
B-4
7/21/06
B.
CLI Commands
15. cli iedge edit XXXXCLItest 0 gateway disable - as this device is a single
user it is not a gateway
<<B. CLI Commands>>
20. cli iedge edit XXXXCLItest 0 q931port 1720 - as this device does not use
H323 this option is not important but is set to 1720 anyway, just make a
note, ok?
21. cli iedge edit XXXXCLItest 0 tpg disable - Tech Prefix Plan
22. cli iedge edit XXXXCLItest 0 vendor Generic - specifies that this device
is not a specific vendor and will not be treated special in any way whatsoever
23. cli iedge edit XXXXCLItest 0 subnetip 10.1.1.0 - defines the IP network
that the device must be a member of as far as IP or else it will not be
allowed to pass Go, or collect $200
24. cli iedge edit XXXXCLItest 0 subnetmask 255.255.255.224 - defines the
subnet mask that will be used with the IP subnet address above as mentioned previously, especially the Monoploy reference
25. cli iedge edit XXXXCLItest 0 mediarouting enable - this device will pass
the media it creates through the MSC
26. cli iedge edit XXXXCLItest 0 nmr disable - as the above was enabled
never route media is
27. cli iedge edit XXXXCLItest 0 hideaddresschange enable
28. cli iedge edit XXXXCLItest 0 maxhunts 5 - this device has a maximum of
5 hunt attempts when kit tries to establish calls
29. cli iedge edit XXXXCLItest 0 h323display disable - as this device does
not use H323
30. cli iedge edit XXXXCLItest 0 mapalias disable - interpret/support mapAlias for H.323
32. cli iedge edit XXXXCLItest 0 connh245addr disable - as this device does
not use H323 there is no "Connect" message to put the h.245 address in
33. cli iedge edit XXXXCLItest 0 infotranscap default - defines the type of
traffic to be "codec'd" <speech | unrestricted | restricted | audio | unrestrictedtones | video | pass> - Q931/ISDN information transfer capability
34. cli iedge edit XXXXCLItest 0 deltcs2833 default
35. cli iedge edit XXXXCLItest 0 deltcst38 default
B-5
7/21/06
B.
CLI Commands
31. cli iedge edit XXXXCLItest 0 forceh245 disable - as this device does not
use H323 forcing H245 upon it would be cruel and unusual punishment
<<B. CLI Commands>>
36. cli iedge edit XXXXCLItest 0 2833capable unknown

37. cli iedge edit XXXXCLItest 0 removetg disable
38. cli iedge edit XXXXCLItest 0 setdesttg disable
39. cli iedge edit XXXXCLItest 0 realm Realm1 - defines the realm this
device will use for signaling and media
40. cli iedge edit XXXXCLItest 0 pionfaststart disable - progress indicator
on if enabled
41. cli iedge edit XXXXCLItest 0 natdetect enable - NAT will be automatically discovered for this device
42. cli iedge edit XXXXCLItest 0 natip - if the NAT device IP is know then
define it here to prevent spoofing as much
43. cli iedge edit XXXXCLItest 0 natport 0 - if the NAT device is also mapping a specific port for the signaling this device will do define it here, others may use the same NAT and so they may use the same port, I was just,
you know
44. cli iedge edit XXXXCLItest 0 privacy both
45. cli iedge edit XXXXCLItest 0 mapcc disable - is there is a specific ISDN
Cause Code to be mapped to for this device then define which one it will
be
46. cli iedge edit XXXXCLItest 0 cidblock disable - is Caller ID blocked or
not? In this case it is not
47. cli iedge edit XXXXCLItest 0 cgpntype pass
Adding an iServer in CLI
B.
To add an iServer using CLI commands, type the following:
iedge edit XXXXiServ 0
type iserver
static 10.20.30.41
h323 enable
cdpntype pass
bcaplayer1 default
sip enable
xcalls 100
CLI Commands
iedge add XXXXiServ 0
B-6
7/21/06
<<B. CLI Commands>>
xincalls 0
xoutcalls 0
unlimited
unlimited
iedge edit XXXXiServ 0 gateway enable to be assigned a call plan and call
limits
grq disable
rai disable
priority 0
rasport 1719
q931port 1720
tpg disable
vendor Generic
mediarouting disable
nmr disable
hideaddresschange disable
maxhunts 0
h323display disable
mapalias disable
forceh245 disable
connh245addr disable
infotranscap default
deltcs2833 default
deltcst38 default
2833capable unknown
removetg disable
setdesttg disable
realm Realm1
pionfaststart disable
natdetect disable
natip
natport 0
privacy both
mapcc disable
cidblock disable
cgpntype pass
B.
CLI Commands
B-7
7/21/06
<<B. CLI Commands>>
CLI Commands
B.
B-8
7/21/06
C
CLI SCRIPTS
SCRIPTS INTRODUCTION
This chapter provides details on the following scripts:
Switch Version (SV) Script
Core Script
Logtrim Script
Switch Version (SV) Script

The Switch Version script is used for switching between versions of MSW
software. This procedure assumes the old software version was not removed
when the upgrade/install was performed.
CAUTION:Running this script stop the MSW! Make sure you
understand the functionality of this script BEFORE running it.
!/bin/sh -x
Switch Version (file name = sv)
FTPing the Switch Version (SV) Script

Note: This script is used for switching versions of SW to the MSW in the /
usr/local directory. This is applicabe to both downgrades and
upgrades.
To ftp the sv Script, do the following:

1. Type ls at the command line.
This command lists the number of installed releases. For example, a
directory titled nextone-4.0t7 shows that MSW version 4.0t7 is installed.
2. Type chmod +x sv. This makes the script executable.
C-1
7/21/06
CLI Scripts
C.
<<C. CLI Scripts>>
3. Type sv <version #>. This launches the script and creates a NexTone softlink to the appropriate build.
Note: Where version # = everything after the nextone-.
4. Change to the /usr/local/nextone/bin directory.

5. Type ./iserver all start
if [ ! -d "/usr/local/nextone-$1" ];
then echo "/usr/local/nextone-$1 does not exist. Not Switching version"
exit 1
if
/usr/local/nextone/bin/iserver all stop
rm /usr/local/nextone
rm /databases
rm /locks
ln -s /usr/local/nextone-$1/databases /databases
ln -s /usr/local/nextone-$1/locks /locks
ln -s /usr/local/nextone-$1 /usr/local/nextone
# end
Core Script
The core script modifies the coreadm.conf so that when core files exist, they
have distinguishable names rather than just "core". Also, each successive core
will not overwrite the former core, e.g., core.gis.11234, core.gis.67890, etc...
The %f includes the file that caused the core and the %p includes the process
ID.
This script saves the core files to the /home/cores directory if the first two lines
are uncommented. You can use the coreadm <process_ID> command to find out
where cores for that process are stored.
To initiate the core script, type the following:
coreadm -i /home/cores/core.%f.%p
coreadm -g /home/cores/core.%f.%p
# coreadm -i core.%f.%p
coreadm -e process
# coreadm -e proc-setid
# coreadm -e global
C-2
7/21/06
CLI Scripts
C.
<<C. CLI Scripts>>
C.
/etc/init.d/coreadm start
Logtrim Script
To schedule the LOGTRIM program it needs to be running using a cron configuration as shown at the bottom of the Release Notes. Otherwise, each time
you manually run Logtrim from a command line, it only performs the file
copying ONCE (if and only if) the specified file size has been reached.
Whn scheduling the logtrim program keep in mind is that the:
the file size (-l option) is calculated in block size, not bytes or kilobytes.
one block is equal to 512 bytes, so every time the operating system allocates space for a file, it does it in complete blocks therefore, if a file is
only 2 bytes, it still creates a 512 byte block.
file size reaches 513 bytes, then it takes up 2 blocks, etc. Essentially, 1
block = 512 bytes.
Logtrim Release Notes

Logtrim is a program intended to be run under cron, to trim logfiles, etc.. It
can also be run from the command line at any time.
The three command line arguments are:
Table 12. Command Line Arguments
-f <logfile>
Specifies the log file to be monitored.
-s <sequence>
Number of files to sequence through. If set to say 4,

then log will maintain 5 files -- log, log.1, log.2,
log.3, and log.4.
-l <limit>
Specifies the size limit of the logfile in blocks. If the

logfile comes close to <limit>, then logtrim automatically starts the copy chain.
If no options are specified, then logtrim defaults to the following:

logfile => /var/log/iserver.log
C-3
7/21/06
CLI Scripts
/etc/init.d/coreadm stop
<<C. CLI Scripts>>
C.
sequence => 7
CLI Scripts
limit (in blocks) => 1024 (small, but a good start).
Note: logtrim is available in the iServer Core package install (/usr/local/

nextone/bin).
A typical usage of logtrim is as follows:

ksh$: crontab -l
## Checks /var/log/iserver.log every 30 minutes (using default settings)
0,30 * * * *
/usr/local/nextone/bin/logtrim
## Checks iserverh323.log once every hour (on the half-hour)

30 * * * * /usr/local/nextone/bin/logtrim -f /var/log/iserverh323.log -s 3
-l 2048
A crontab file consists of six field lines. The fields are separated by spaces or
tabs. The first five fields are integer patterns that specify the following:
minute (0-59),
hour (0-23),
day of the month (1-31),
month of the year (1-12),
day of the week (0-6 with 0=Sunday),what is the sixth field?
A common list of Logtrim cronjobs used in MSW environments is listed
below.
1. To edit a copy of the current user's crontab file and add the list below, use
crontab -e.
Note: After writing and quitting the file the change takes place immediately.
Note: If only a number is displayed when typing "crontab -e", type Ctrl-d.
It's because no default EDITOR (like VI) is setup. This can be resolved
by typing:
export EDITOR="/bin/vi"
The line above can also be added to the .bashrc or .profile startup
script as well so it will initialize next time bash is launched.
2. The VI editor opens and these lines can be pasted into the file:
C-4
7/21/06
<<C. CLI Scripts>>
C.
## reach ~ 10MB
30 * * * * /usr/local/nextone/bin/logtrim -f /export/home/nextone/iserver.log -s 3 -l 20480
30 * * * * /usr/local/nextone/bin/logtrim -f /var/log/iserverh323.log -s 3
-l 20480
30 * * * * /usr/local/nextone/bin/logtrim -f /var/log/iservererr.log -s 3 l 20480
30 * * * * /usr/local/nextone/bin/logtrim -f /var/log/iserverout.log -s 3
C-5
7/21/06
CLI Scripts
## Checks NexTone MSW log files once every hour (on the half-hour) and trims
them if they
D
RSM ADMINISTRATION
INTRODUCTION
Normal operations are defined as those which expected or scheduled to

happen during the course of regular system use.
Abnormal are those operations performed as a result of a failure of a component or system required for normal operations to continue.
The category of work covered here is broadly known as Operations, Administration and Maintenance, or OA&M.
NORMAL OA&M PROCEDURES

System Startup
There is one normal case to manually start the server, enter:
/etc/init.d/tomcat start
/etc/init.d/mysql stop/start
Normally, during a system startup, the processes that comprise the RSM system will be started, as programmed in the startup files for those products, such
as mysql and tomcat.
System Shutdown
To stop the server before shutting down the platform on which the server is
running, enter:
/etc/init.d/tomcat stop
System Backup
D-1
7/21/06
D.
RSM
Administration
This chapter provides procedures for system administrators to use during normal and abnormal operations.
<<D. RSM Administration>>
In order to do a system backup, you must stop tomcat 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 window lists the installed system components with the
version number for each. Below is an example of an installed system components listing.
RSM
Administration
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
User Account Administration

The RSM system administrator is responsible for creating, modifying and
deleting user accounts and their user group associations. The procedures in
this section show the sysadmin how to perform these tasks.
When you first bring up the User page of the Admin function, the RSM system
lists all users currently defined, along with the users UserId, GroupId, and
access permissions.
Each user of RSM has an identification unique to the system, called the
UserId, and an associated set of privileges. Each user also belongs to a group
of users, based on a common GroupId. Associated with each group is one or
more endpoints and endpoint ports to which that user has access by virtue of
belonging to that group. The system administrator is responsible for establishing and maintaining users, groups, and group memberships.
PERMISSION INDICATORS
User permission fields have indicators on the main page. The indicator for
each permission appears as a light bulb icon, either bright yellow (enabled) or
dark gray (disabled). Permissions are set using the Add User and Update User
dialog windows described below.
D.
D-2
7/21/06
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
D.
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 iServer Installation and
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:
D-3
7/21/06
RSM
Administration
See Contacting NexTone Support, on page 3 for specific directions.
-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.
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

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.
cdrdel
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.
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;
D-4
7/21/06
D.
RSM
Administration
-s start_file[:line]
The above parameters break down as follows:

= 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
= the minimum number of seconds for the script to sleep before

attempting to run again.
mintime
= 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.
factor
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
D-5
7/21/06
D.
RSM
Administration
old
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.
Note: This tool runs from this directory on the iServer switch.
Synopsis:
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 13.
Table 13. Some Common RSM Database Fields

Field
Name
Description
Formata
Supported
Relationships
date_time
The date and time stamp on a CDR
'2004-01-11 00:00:00'
>, <, =
orig_gw
The regid of the originating gateway
alphanumeric, up to 24 chars.
=, like
term_gw
The regid of the terminating gateway
alphanumeric, up to 24 chars.
=, like
orig_ip
The IP address of the originating

gateway
nnn.nnn.nnn.nnn
=, like
term_ip
The IP address of the terminating

gateway
nnn.nnn.nnn.nnn
=, like
D-6
7/21/06
RSM
Administration
D.
rateone.pl [-r recordnum] [-s SQL_statement]
Table 13. Some Common RSM Database Fields (Continued)

Field
Name
Formata
Description
Supported
Relationships
orig_port
A port number on the originating gateway
integer
>, <, =
term_port
A port number on the terminating

gateway
integer
>, <, =
D.
a. Be sure to surround values with single quotes (where indicated), since those values contain nonalpha characters.
RSM
Administration
Note that the SQL wildcard character, %, is also supported. For example,
orig_gw like Mexico-%
would match (and therefore rate) all regids beginning with Mexico-.
D-7
7/21/06
E
GENCP
HOW TO RUN "GEN_CP"
GEN_CP can be found at the following URL:
Format of input file is:
city, area_code, start_number, end_number, new_area_code, calling_plan,
priority {, calling_plan, priority }
Note: Note:
"city" - Used for the first few characters of the Route Name.
"area_code" - The first part of the route's Called Party #/
DNIS.
"start_number" - The beginning of the number range. *
"end_number" - The end of the number range. *
"new_area_code" - The first part of the DNIS Prefix. This is
where the area code can be manipulated. If no change is
required then should be = "area_code".
http://209.219.79.14:8080
GEN_CP is a conversion tool that allows you to convert a flat CSV (comma
separated value) file to the NexTone XML Calling Plan/Route format.
Instructions are as follows:
E-1
7/21/06
E.
GenCP
a) the start_number and end_number do not include the area code

b) if no end_number is given, then the number range is assumed to
the form nnnn*
where * is determined from the number length
c) the new_area_code is optional
d) the calling_plan/priority may be followed by additional
calling_plans/priorities
e) a reject route can be created by prefixing a - to the area_code
<<E. GenCP>>
"calling_plan" - The Calling Plan to which the route will be bound.

"priority" - The binding priority for the newly created route.
* If there is no range, then the start and end #'s will be the same.
Note: :
(a) You can also specify more than one calling plan and its associated priority if desired for the route.
(b) When creating routes it will append a "-d" for destination
(egress) plans & routes and "-s" for source (ingress) plans & routes.
If a Calling Plan already exists in the MSW make sure and take that
into account by removing the "-d" or "-s".
Here are a couple sample lines of a csv file:
# test.in.csv
MEXICO-CITY,01152,5456000,5456999,52,TEST_CPA,1,TEST_CPB,2
CUBA,53,5455000,5455999,01153,TEST_CP1,0,TEST_CP2,4
Here is the generated XML file from the above CSV file:
E.
# test.out.xml
# Start Calling Plans (# = 4)
<CP>
<CP_NAME> "TEST_CP1-d" </CP_NAME>
GenCP
<VPN_GROUP> "" </VPN_GROUP>

<MTIME> "1035314063" </MTIME>
</CP>
<CP>
<MTIME> "1035314063" </MTIME>
</CP>
<CP>
<CP_NAME> "TEST_CPA-d" </CP_NAME>
<MTIME> "1035314063" </MTIME>
</CP>
<CP>
E-2
7/21/06
<<E. GenCP>>
<CP_NAME> "TEST_CPB-d" </CP_NAME>

<MTIME> "1035314063" </MTIME>
</CP>
# Start Routes (# = 2)
<CR>
<CR_NAME> "CUBA-535455xxxd" </CR_NAME>
<CR_SRC> "" </CR_SRC>
<CR_SRCLEN> "0" </CR_SRCLEN>
<CR_SRCPREFIX> "" </CR_SRCPREFIX>
<CR_DEST> "535455" </CR_DEST>
<CR_DESTLEN> "0" </CR_DESTLEN>
<CR_PREFIX> "011535455" </CR_PREFIX>
<CR_FLAGS> "32" </CR_FLAGS>
<MTIME> "1035314063" </MTIME>
</CR>
E.
<CR>
<CR_NAME> "MEXICO-CIT-011525456xxxd" </CR_NAME>
<CR_SRC> "" </CR_SRC>
<CR_SRCLEN> "0" </CR_SRCLEN>
GenCP
<CR_SRCPREFIX> "" </CR_SRCPREFIX>

<CR_DEST> "011525456" </CR_DEST>
<CR_DESTLEN> "0" </CR_DESTLEN>
<CR_PREFIX> "525456" </CR_PREFIX>
<MTIME> "1035314063" </MTIME>
</CR>
# Start Calling Plan Bindings (# = 4)
<CPB>
<CR_STIME> "-1/-1/-1/-1/-1/-1/-1/-1" </CR_STIME>
<CR_FTIME> "-1/-1/-1/-1/-1/-1/-1/-1" </CR_FTIME>
E-3
7/21/06
<<E. GenCP>>
<PRIO> "0" </PRIO>

<MTIME> "1035314063" </MTIME>
</CPB>
<CPB>
<CR_STIME> "-1/-1/-1/-1/-1/-1/-1/-1" </CR_STIME>
<CR_FTIME> "-1/-1/-1/-1/-1/-1/-1/-1" </CR_FTIME>
<PRIO> "4" </PRIO>
<MTIME> "1035314063" </MTIME>
</CPB>
<CPB>
<CP_NAME> "TEST_CPA-d" </CP_NAME>
E.
<CR_STIME> "-1/-1/-1/-1/-1/-1/-1/-1" </CR_STIME>

<CR_FTIME> "-1/-1/-1/-1/-1/-1/-1/-1" </CR_FTIME>
<PRIO> "1" </PRIO>
<MTIME> "1035314063" </MTIME>
GenCP
</CPB>
<CPB>
<CP_NAME> "TEST_CPB-d" </CP_NAME>
<CR_STIME> "-1/-1/-1/-1/-1/-1/-1/-1" </CR_STIME>
<CR_FTIME> "-1/-1/-1/-1/-1/-1/-1/-1" </CR_FTIME>
<PRIO> "2" </PRIO>
<MTIME> "1035314063" </MTIME>
</CPB>
E-4
7/21/06
F
CDR TRIM INFORMATION
WARNING: IF THE CDR PARTITION BECOMES FULL, NO CDR'S
ARE ABLE TO BE WRITTEN. THE CDR'S WILL BE LOST IF THIS
HAPPENS!!!
To avoid this from happening, NexTone produced a Perl script that can be
used for trimming the CDR partition. The script can do several things.
Other than the script called "cdrtrim", there are two config files called
"cdrtrim.cfg" and "mail.pl". The Perl libraries must also be installed that
come with the NexTone admin package in order for it to successfully run.
The notion is that there are four actions:
compress
move
remove
mail
2. "#cdrpart = <path>" is where you can manually specify the partition

where the CDR's are stored. If this line is commented out (with a #), the
script will dynamically determine what the appropriate partition is based
on the "cdrdir = <path>" value.
F.
3. If the action is configured as "action = mail compress move remove", then

the script will first notify the user(s) by mail, then compress, then move,
but if move fails because the destination directory is full, then it will
begin to remove CDR's. It will perform the actions until the partition
space is brought back the configured threshold.
CDR Trim
Information
1. The actions are configured in the "cdrtrim.cfg" file. In the "cdrtrim.cfg"

file you can specify the threshold which indicates when to begin the
action. It is a value of "dd or dd:hh or dd:hh:mm or xx%" where it can be
configured as days old (dd), days+hours old (dd:hh), days+hours+mins
old (dd:hh:mm), or a percentage of partition space filled (xx%). The
default checks for 80% of the partition space to be filled before it performs the specified actions.
F-1
7/21/06
<<F. CDR Trim Information>>
4. "Remove" will not be enabled on customer machines by default. It is best

to run two instances of "cdrtrim" one in the primary CDR partition and
one in the backup partition to where the CDR's are actually being moved.
The latter partition is where "action = move remove" should be configured. Since move uses the scp command, it can actually be used to move
the CDR's to a completely separate machine. The oldest files would then
get removed once that remote device fills up.
5. The mail.pl script uses sendmail (which must be setup) and should be
configured to contain the appropriate To:, CC:, and BCC: addresses.
Search for the line called "$MailFrom = 'sridhar@nextone.com';" and
configure your own company's "From" email address. It must be a valid
email address.
6. This script needs to be setup as a cronjob, just like the "logtrim" script. If
you are not familiar with setting up cron jobs, see the file called "Logtrim
Release Notes".
CDR Trim
Information
F.
F-2
7/21/06
G
GENEP INFORMATION
GenEP is used for generating large numbers of uports for carriers with
several calling plans. As each uport can be assigned a single calling
plan some carriers need hundreds of uports per end point, up to 255,
obviously. GenEP is a utility that does that, generates uports for endpoints.
Below is a sample of GenEP output:
# ./genep -h
genep, v0.2a.ahc, 01/16/2003
Usage:
genep -f <file> [-o <outfile>] [-r <regid>] [-p <cpname>] [-x <maxcalls>]
Options are:
-f <file>
- use IP addresses from <file>. No defaults.
-o <outfile>
- output XML in <outfile>. Defaults to "xmlout".
-r <regid>
- use <regid> as the regid. Defaults to "TempRegid".
-p <cpname>
- use <cpname> as the calling plan. Defaults to "".
-x <maxcalls>
- set max calls to <maxcalls>. Defaults to 0.
-h
- prints this
-v
- prints out version
-V
- be verbose
# cat gen_tst.in
12.37.128.9
134.222.199.247
148.122.48.100
148.122.48.101
148.122.48.102
148.122.48.105
# ./genep -f gen_tst.in -o gen_tst.out -r CustomerA -p CustA_CP -x 48
RMS Operations Guide
G-1
7/21/06
GenEP
Information
G.
<<G. GenEP Information>>
G.
GenEP
Information
# cat gen_tst.out
<?xml version='1.0' standalone='yes'?>
<DB>
<E>
<XCALLS>"48"</XCALLS>
<PRIO>"0"</PRIO>
<SUBNETIP>"12.37.128.9"</SUBNETIP>
<ET>"xgateway"</ET>
<SFLAGS>"4"</SFLAGS>
<SIGPORT>"1720"</SIGPORT>
<ECAPS1>"17"</ECAPS1>
<SRNO>"CustomerA"</SRNO>
<RASPORT>"1719"</RASPORT>
<CAP2>"260"</CAP2>
<UPORT>"0"</UPORT>
<CP_NAME>"CustA_CP"</CP_NAME>
<BCAP>"33"</BCAP>
<CDPNTYPE>"1"</CDPNTYPE>
<SUBNETMASK>"255.255.255.255"</SUBNETMASK>
<VENDOR>"0"</VENDOR>
</E>
<E>
<PRIO>"0"</PRIO>
<ET>"xgateway"</ET>
<CAP2>"260"</CAP2>
<UPORT>"1"</UPORT>
G-2
7/21/06
G.
GenEP
Information
<BCAP>"33"</BCAP>
</E>
<E>
<PRIO>"0"</PRIO>
<ET>"xgateway"</ET>
<CAP2>"260"</CAP2>
<UPORT>"2"</UPORT>
<BCAP>"33"</BCAP>
</E>
<E>
<PRIO>"0"</PRIO>
<ET>"xgateway"</ET>
G-3
7/21/06
G.
<CAP2>"260"</CAP2>
GenEP
Information
<UPORT>"3"</UPORT>
<BCAP>"33"</BCAP>
</E>
<E>
<PRIO>"0"</PRIO>
<ET>"xgateway"</ET>
<CAP2>"260"</CAP2>
<UPORT>"4"</UPORT>
<BCAP>"33"</BCAP>
</E>
<E>
<PRIO>"0"</PRIO>
<ET>"xgateway"</ET>
G-4
7/21/06
G.
GenEP
Information
<CAP2>"260"</CAP2>
<UPORT>"5"</UPORT>
<BCAP>"33"</BCAP>
</E>
</DB>
G-5
7/21/06
H
GLOSSARY
This appendix provides a basic glossary for some of the terms, acronyms, and
abbreviations used in this book.
H.
Definition
ACL
Access Control List. In the VoIP context, an ACL is a table listing

originating endpoints from which calls will be accepted by a particular receiving endpoint, or which a firewall will allow to pass into the
private network it protects.
AFR
Adaptive Fax Routing. A means of remembering a fax destination,

and changing to fax mode before sending the call to the egress
endpoint. See Special Case: Adaptive Fax Routing, on page 85, for
details.
A-Law
The 16-to-8 bit loss-less audio compression algorithm used outside

of North America. See also -Law.
ANI
Automatic Number Identification. A service that provides the

receiver of a telephone call with the number of the calling phone.
ASCII
American Standard Code for Information Interchange. A seven-bit

binary encoding of printable and non-printable (control) characters.
Most modern computer systems use this code to communicate
with each other and the outside world. It is also the character set
used from the command line.
ASR
Answer Seizure Ratio. Ratio of the number of successful calls over

the total number of outgoing calls from a carriers network.
CAC
Call Admission Control. A graceful approach to handling the situation where adding a new VoIP call would exceed the IP networks
available capacity.
Calling Plan
A set of routes logically grouped under one name.
Carrier
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.
CDR
Call Detail Record. Contains details of a processed call.
Release 4.2,, Issue 1
H-1
7/21/06
Glossary
Term
<<H. Glossary>>
Term
Definition
Classless Inter-Domain Routing. Early IP subnetting techniques
were grouped in 8-bit increments, known as Class A (8 bits), Class
B (16 bits), etc. CIDR allows 1-bit incremental subnetting just by
specifying the number of 1 bits in the subnet mask. (Under this
notation, a network address in a block of 4 Class C networks, for
example, would be written, 192.168.20.3/22, for example.)
Cisco IOS
IOS is Ciscos network management software suite.
Command Line
Interface (CLI)
The CLI is a point of interface into low-level communication with a

computer system. Opening a terminal session on a iVMS computer
results in the system providing a prompt on one line into which a
user types commands.
Control LAN
The local area network over which heartbeat packets are sent
between an active processor and its peer(s).
CP
Calling Plan
CSC
Core Session Controller. Another term for an iServer, which is

placed at the core of a network, and which provides call routing
services through it.
CSV
Comma-separated value. A file format used for transferring ASCII

data between systems whose native file formats are incompatible.
Data in the file takes the form field1,field2,... Note that the field separator character does not have to be a comma. It can be any ASCII
character that doesnt occur in the data itself, such as a semicolon,
tilde, etc.
.CTT
A CDR file for non-traditional CDRs (ingress leg start-call, and

egress leg start- and end-call.
Database
An ordered collection of information designed for rapid access. The

iServer database contains its endpoint registration and configuration information.
Default Route
A route used when the destination host or network is not in the

routing table.
Dialog box
A browser or application window used to enter and/or modify data,

consisting of a combination of text boxes, lists, etc.
DNIS
Dialed Number Identification Service. A telephone service that

identifies for the receiver of a call the number that the caller actually dialed. Its a common feature of 800 and 900 lines. If you have
multiple 800 or 900 numbers to the same destination, DNIS tells
which number was called. DNIS works by passing the DTMF digits
to the destination.
H.
Glossary
CIDR
H-2
7/21/06
<<H. Glossary>>
Definition
DNS
A service that converts a FQDN to an IP address.
Egress-leg
The call that gets routed by the iServer to an termination endpoint.
Endpoint
A generic term describing an entity that sends calls to or receives

calls from the session controller (iServer). An endpoint can be of
various types - SIP gateway, H.323 gateway, H.323 gatekeeper,
SIP proxy server, Softswitch, IP phone etc.
ENUM
The Internet Telephone Numbering System. The technology that

bridges the public switched telephone network and the Internet.
ENUM works as a kind of DNS for IP telephony.
ESC
Edge Session Controller. Another term for an MSC, which is placed

at the edge of a network, and which controls access to it.
Failover
A standby CPU taking processing duties from an active CPU.
FCE
Firewall Control Entity. Software used to configure firewall functions. Combines with NSF to implement media routing.
FQDN
Fully-Qualified Domain Name. The complete alphabetic address,

as stored in your DNS, of a server, such as www.nextone.com.
Gatekeeper
An H.323 entity responsible for managing and authorizing calls to

one or more H.323 gateways under its control. Gatekeepers are
optional nodes that manage endpoints in an H.323 network. The
endpoints communicate with the gatekeeper using the RAS protocol.
Gateway
An endpoint on the LAN that provides real-time communications

between H.323 terminals on the LAN and other ITU terminals on a
WAN or to other H.323 gateways. Gateways allow H.323 terminals
to communicate with devices that are running other protocols. They
provide protocol conversion between the devices that are running
different types of protocols.
gis/gis process
The iServer process responsible for call processing.
Glare
A race condition typically induced during call processing where

both ends of the call send similar capabilities at the same time.
H.225
An ITU standard that governs H.225.0 session establishment and

packetization. H.225.0 actually describes several different protocols: RAS, use of Q.931, and use of RTP.
H.235
H.235 provides security for the RAS signaling between H.323 endpoints and gatekeepers so that only duly authenticated and authorized endpoints are able to use Gatekeeper resources.
H.
H-3
7/21/06
Glossary
Term
<<H. Glossary>>
Definition
H.245
The call signaling protocol and media stream packetization standard for packet-based multimedia communication systems. Used
with the H.323 family of protocols. H.245 Tunneling reduces
callsetup time and ensures a more efficient use of network
resources. H.245 Tunneling can be used only when both endpoints
have this capability. When this is not the case, H.245 negotiation is
performed via separate TCP connections.
H.323
The globally accepted standard for packet-switched audio/video/

data communication. It specifically describes how multimedia communications occur between user terminals, network equipment,
and assorted services on local and wide-area IP networks. The
H.323 standard uses other standard protocols such as H.245,
H.225.
H.323 proxy
Special types of gateways that relay H.323 calls to another H.323

endpoint. They can be used to isolate sections of an H.323 network for security purposes, to manage quality of service (QoS), or
to perform special application-specific routing tasks. An H.323
gatekeeper is required if H.323 proxies are used.
Hairpin
Calls that have the same source and destination gateways.
Hunting
Call hunting is forwarding a call to one or more numbers, in

sequence, if the original dialed number (a) doesnt pick up within a
specified time limit, or (b) is busy or otherwise unavailable.
IETF
The Internet Engineering Task Force.
Ingress-leg
From the perspective of the iServer, this is an incoming call.
ipfilter
A Unix-level software package providing network address translation (NAT) and/or firewall services through a loadable kernel module or by incorporation into the UNIX kernel. (Replaced by NSF as
of R2.)
iServer
The NexTone Multi protocol Signaling Switch (iServer). A VoIP session controller, comprising a SIP/ H.323 interworking element and
Firewall Control Entity (FCE) on a single platform deployed at the
network edge.
IWF
The Interworking Function. The iServers bridge between the

H.323 and SIP signaling protocols.
LRQ
Location Request. Information sent by a H.323 gatekeeper such as

the iServer to another peer H.323 gatekeeper requesting the location of a certain endpoint.
MCU
Multipoint Control Unit. An endpoint on the network that allows

three or more endpoints to participate in a multipoint conference.
H-4
7/21/06
H.
Glossary
Term
<<H. Glossary>>
Definition
Media
Content, whether voice, fax, video, or other forms of communication transmitted between endpoints; as opposed to the other component of VoIP, signaling.
Media Routing
The ability to route media through a central network element so

that the endpoints involved in the media flow send their media only
to this central network element. Media routing enables forced routing through a network common point, and hides the endpoints
addresses and therefore identities from one another.
MFCP
Media Firewall Control Protocol. This protocol is used internally to

control NSF, and also allows an iServer to control a third-party firewall. Currently supports the Snowshore/Brooktrout Media Firewall.
MGCP
Media Gateway Control Protocol. The Media Gateway Control Protocol is a control and signal standard competing with the older
H.323 standard for the conversion of audio signals carried on telephone circuits (PSTN) to data packets carried over the Internet or
other packet networks.
MGCP is meant to simplify standards for VoIP by eliminating the
need for complex, processor-intense IP telephony devices, thus
simplifying and lowering the cost of these terminals.
-Law
The 16-to-8 bit audio compression algorithm used in North America. See also A-Law.
MPLS
MultiProtocol Label Switching. A short fixed-length label represents

an IP packet's full header. Subsequent routing decisions are based
on the MPLS label and not the original IP address. Supports more
complex services and QoS.
MSC
Multi-protocol Session Controller. The iServer integrated with the

NSF, which enables media routing.
MSW
The NexTone Multi protocol Signaling Switch (generically known as

an iServer). A VoIP session controller, comprising a SIP/H.323
interworking element and Firewall Control Entity (FCE) on a single
platform deployed at the network edge.
Node
Generically, any network endpoint, which may include an iServer,

LAN router, gateway, etc.
A point of iServer service. In the case of a single machine system,this is the the iServer box; in a redundant system, both
machines together are known as one service node.
NSF
NexTone Session Filter. A packet filter that provides isolation

between the two legs of a call, and hides the topology of the networks connecting to that common point. The iServer integrated
with the NSF performs the functions of the media router.
H-5
7/21/06
H.
Glossary
Term
<<H. Glossary>>
Definition
OS
Operating System. For the iServer, this is Sun Microsystems

Solaris for x86.
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.
A value of 0 means that Over Subscription is turned off, i.e, no
Over Subscription factor will be enforced when adding partitions.
PDD
Post dial delay. 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 or not. This information is also captured in the iServer
CDRs.
Peering Partner
A third-party company that works with the owner of the VoIP network to complete the transport in to and/or out of it.
Proxy Server
An intermediate system that processes SIP messages from SIP

endpoints. Proxy servers can be stateless or stateful.
Pool
In realm-based routing, a pool is a named set of realm media firewall resources (addresses and ports).
Q.931
A layer 3 call signaling and setup protocol, originally for ISDN, now
generalized for VoIP call setup and breakdown. It is roughly comparable to TCP in the Internet protocol stack.
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: In order to utilize the QOS functions in RSM in a meaningful manner, the MSx system sending CDRs to the RSM system
should also be QOS enabled.
RADIUS
Remote Authentication Dial-In User Service. A widely-used protocol for centralized authentication and accounting. iServer includes
a RADIUS client to facilitate delivery of accounting information to
third-party servers in XA3PLUS format, and for authentication of
user credentials for certain SIP message types.
H-6
7/21/06
H.
Glossary
Term
<<H. Glossary>>
Definition
RAS
Registration and Admission Status. The call setup protocol in the

H.323 standard.
RBR
Realm-Based Routing.
Realm
In an iServer-controlled network, a realm gives a unique identity to

a private network.
reg ID
Registration Identification. A credential for an endpoint in the iServer database. This entity is generated by the Network Administrator, and must be unique to an iServer database. Each reg ID can
be split into sub-entities called uports.
Reject Route
A type of sub-route defining an exception to a higher-level route. An

example would be a route covering all exchanges within an area,
with an associated reject route for one exchange within that area
requiring different routing from the rest of that areas exchanges.
RMA
Realm Media Address. The IP address through which a realm

sends and receives its media traffic. Each realm has its own
unique RMA.
RRQ
Registration Request. Information sent by a dynamic endpoint to

the H.323 iServer. Comes in two flavors: normal, and lightweight.
The endpoint periodically sends lightweight RRQs to the iServer to
say that it is still active. Normal (i.e., full) RRQs actually register
an endpoint with the iServer.
RSA
Realm Signaling Address. The IP address to which signaling messages are sent, so the iServer knows realm in which the traffic
originated. Each realm has its own unique RSA.
RTP
Real-Time Protocol. Standard defined by the IETF for the transmission of media (such as voice, video and fax) over a packet network.
Sample Period
The alarm query interval. While normally 1/10 of the duration setting for an alarm, sample period is limited to not less than 60 seconds, nor more than 300 seconds (i.e., between 1 and 5 minutes).
Session
A session is defined by the IETF as an exchange of data between

an association of participants. Practically, in the context of iServer,
a session is an activity to set up, conduct or tear down a telephone
call, or to facilitate doing so, such as with device registrations or
contact list exchanges.
Session Controller
A system that keeps track of VoIP connections and traffic flow, and
produces call detail records describing the activity. iServer are session controllers.
H-7
7/21/06
H.
Glossary
Term
<<H. Glossary>>
Definition
Session Limit
The ability of the iServer to limit the number of calls either originating from or terminating to an endpoint.
Signaling
That part of the network traffic that sets up sessions or connections

over which media travel.
SIP
Session Initiation Protocol. A signaling protocol for Internet conferencing, telephony, presence, events notification and instant messaging.
SIP Privacy
A feature that affects caller identification information content and

display.
SIP Proxy Server
An intermediate system that processes SIP messages from SIP

endpoints. Proxy servers can be stateless or stateful.
Stateful
A stateful device is one that tracks the condition, or status, of

something, such as a proceeding telephone call, with start and
end. A stateful iServer, for example, is able to generate CDRs
because it knows when a call began and ended, and therefore
can provide a call duration value. A stateless iServer cannot do
this, because it does not know the status of the connection once it
is made.
Stateless
A stateless device is one that does not track the status of something, such as a proceeding telephone call. See Stateful.
Streams
Streams provide a mechanism to channel traffic from one source to

a specified set of destinations. (These are slated for support in a
near-term future release of iServer.)
Switchover
Movement of call processing duties from a primary processor to

its designated standby.
TCS
Terminal Capability Set. During H.245 call set-up, the TCS contains a list of capabilities that the terminal supports, to facilitate the
negotiation process between terminals.
Template Route
A route used to create other routes. Adaptive Fax Routing (AFR)

utilizes template routes. Currently, iServer only supports dynamic
route creation based on template routes, as with AFR. Setting the
template bit directs the iServer not to route calls with this route,
because its only intended as a starting point for true routes.
Terminal
H.323 Terminals are the client endpoints on the LAN that provide
realtime, two-way communications. They can be realized either as
SW-Clients running on a PC or workstation, or as dedicated HW
devices such as IP phones. All terminals must support voice communications; video and data are optional.
H-8
7/21/06
H.
Glossary
Term
<<H. Glossary>>
Definition
Trunk
A logical grouping of multiple call-carrying circuits, commonly used

as a transmission channel between two network nodes or switching centers. Standard trunks carry 24 (SONET) or 30 (SDH) DS0
calls, but they can be sub-divided.
unary
An action, such as a command, that has no arguments. An example would be in programming where a keyword inverts the bits in a
variable.
Uport
A uport is a mechanism in the iServer to allow common properties

to be created and managed on an endpoint specified by a reg ID.
Uports are virtual, in that they do not exist on the physical device
they represent.
URI
Uniform Resource Identifier. A short string that identifies resources

in the web: documents, images, downloadable files, services, electronic mailboxes, and other resources. They make resources available under a variety of naming schemes and access methods such
as HTTP, FTP, and Internet mail addressable in the same simple
way. Also known as a URL (L for Locator).
URL
See URI.
VIP
Virtual IP address. A logical IP address managed jointly by two or

more iServer systems in a redundant cluster.The VIP is mapped to
a physical network interface on the active iServer server. When a
switchover occurs and backup system transitions to primary, the
backup system assumes control of the VIP and begins providing
service.
VLAN
Virtual LAN. A group of devices on one or more LANs that are configured (using management software) so that they can communicate as if they were attached to the same wire, when in fact they
are located on a number of different local or remote LAN segments.
White Space
The ASCII code set (see ASCII,), provides a number of characters

that are visible only by the effect they have on the characters to
which they are adjacent, such as spaces and tab characters. Certain other invisible characters may also be considered white space,
such as those produced by holding down the <Ctrl> key and striking another character. A safe rule is that any keystroke not producing a normal, printing character should be considered white space.
H-9
7/21/06
H.
Glossary
Term

RSM 4.2-1 Og

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

RSM 4.2-1 Og

Uploaded by

Copyright:

Available Formats

BN-RSM-4.

Real-time Session Manager (RSM)

101 Orchard Ridge Drive, Suite 300

Copyright 2002-2006 NexTone Communications

Release 4.2, Beta

Incorporated Release 4.2 features.

Incorporated Release 4.2 features.

2006 and NexTone Communications, Inc. Proprietary

CHAPTER 2: NEW FEATURES . . . . . . . . . . . . . . . . . . . . . . . . . 1

Audit Trail Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

RSM Operations Guide

Release 4.1, Issue 2

2006 and NexTone Communications, Inc. Proprietary

<< Table of Contents >>

System Alarms Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

RSM Operations Guide

Release 4.1, Issue 2

2006 and NexTone Communications, Inc. Proprietary

<< Table of Contents >>

Multiple Items in a List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

CHAPTER 4: RSM PLATFORM DESCRIPTION . . . . . . . . . . . . . 22

CHAPTER 5: RSM REPORTING . . . . . . . . . . . . . . . . . . . . . . . 25

RSM Operations Guide

Release 4.1, Issue 2

2006 and NexTone Communications, Inc. Proprietary

<< Table of Contents >>

Obtaining Engineering Report Details . . . . . . . . . . . . . . . . . . . . . . . . 31

Types of Business Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

ROUTE PROFITABILITY REPORTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Obtaining Custom Report Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

RSM Operations Guide

Release 4.1, Issue 2

2006 and NexTone Communications, Inc. Proprietary

<< Table of Contents >>

The Unrated CDRs Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

CHAPTER 6: RSM ALARMING . . . . . . . . . . . . . . . . . . . . . . . . 56

ADMINISTERING RSM ALARMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

RSM Operations Guide

Release 4.1, Issue 2

2006 and NexTone Communications, Inc. Proprietary

<< Table of Contents >>

CHAPTER 7: RSM SYSTEM . . . . . . . . . . . . . . . . . . . . . . . . . . 88

RSM Operations Guide

Release 4.1, Issue 2

2006 and NexTone Communications, Inc. Proprietary

<< Table of Contents >>

ACCESSING THE PARTITIONS PAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Access List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

Viewing Content Page Information . . . . . . . . . . . . . . . . . . . . . . . . . . 136

AUDIT TRAIL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

CALL DATA RECORD (CDR) IMPORT/EXPORT . . . . . . . . . . . . . . . . . . . 147

Configuration of CDR Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

RSM Operations Guide

Release 4.1, Issue 2

2006 and NexTone Communications, Inc. Proprietary

<< Table of Contents >>

Adding a CDR Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

Setting Collector Agent Parameters . . . . . . . . . . . . . . . . . . . . . . . . . 160

CDR ERRORS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

SYSTEM ALARMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

RSM Operations Guide

Release 4.1, Issue 2

2006 and NexTone Communications, Inc. Proprietary