Académique Documents
Professionnel Documents
Culture Documents
2-1-OG-1
7/21/06
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
06/09/2006
Release 4.2, 1
07/21/2006
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
7/21/06
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
REQUIRED SOFTWARE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
RSM Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
RSM System Agent Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Client Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
7/21/06
Report Dates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Search Wildcards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Reports Available . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Customizable Chromocode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Requesting Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
ENGINEERING REPORTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
FIELD DESCRIPTIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
BUSINESS REPORTS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Accessing the Business Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
CLEARING THE BUSINESS REPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
CUSTOM REPORTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
CLEARING THE CUSTOM REPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
7/21/06
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
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
Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
SysAdmin User Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
ADDING A NEW USER ACCOUNT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
UPDATING A USER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
DELETING A USER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
ARCHIVER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Archiving CDRs and Provisional Data . . . . . . . . . . . . . . . . . . . . . . . 138
Adding an Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Deleting a Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
7/21/06
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
7/21/06
Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
CLEARING ALARM EVENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
7/21/06
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
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
RSM Operations Guide
10
7/21/06
ROUTING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Accessing LCR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
VIEWING SPECIFIC LCR CONTENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
UPDATING THE LCR PRIORITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
UPDATING A DEVICE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
11
7/21/06
12
7/21/06
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
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
7/21/06
7/21/06
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
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
7/21/06
<<1. Preface>>
1.
Conventions
Preface
Table 1. Conventions
Convention
Example
mkdir directory_name
Press <Ctrl>+S
[tsm|ua|bridge|iwf]
cd /usr/local
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
2
NEW FEATURES
WHATS IN THIS CHAPTER
2.
New Features
Alarm Feature
In RSM Release 4.2, there is one new feature in the alarms functionality, as
follows:
7/21/06
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.
7/21/06
2.
New Features
7/21/06
2.
New Features
Logger Feature
This feature allows for the debugging and general troubleshooting of RSM
4.2. via the Logger option under the System Tab.
7/21/06
New Features
2.
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.
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
7/21/06
3.
Introduction
<<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>>
3.
7/21/06
Introduction
<<3. Introduction>>
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.
7/21/06
Introduction
3.
<<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.
3.
Introduction
11
7/21/06
<<3. Introduction>>
3.
Introduction
12
7/21/06
<<3. Introduction>>
Introduction
3.
13
7/21/06
<<3. Introduction>>
3.
7. The system takes you to the main RSM system page, which happens to be
the Engineering reports page.
14
7/21/06
Introduction
<<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.
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.
15
7/21/06
Introduction
Administrator
<<3. Introduction>>
WINDOW STRUCTURE
Upon successfully logging into RSM, the main system page of the RSM system displays.
Note: Upon logging onto RSM, the Reporting tab is displayed, by default.
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>>
3.
Introduction
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.
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
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.
3.
18
7/21/06
<<3. Introduction>>
3.
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
<<3. Introduction>>
pop-up window where you specify the date by clicking on a calendar graphic
like the one shown in Figure 5.
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.
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.
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
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
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.
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.
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
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.
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.
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.
Host
Begin Date
End Date
Time Zone
Orig Reg ID
Orig Port
Dest Reg ID
Allows the user to specify the endpoints destination registration ID. (Search Wildcards, on page 26,
can be used.)
Dest Port
30
7/21/06
5.
Description
Partition
Page Number
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
RSM Reporting
Field
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
Remember that, at any time, you can return to any previous page by using
your browsers Back button.
Description
ASR by Source IP
ASR by Destination IP
32
7/21/06
5.
Description
ASR by Region
ASR by Supplier
ASR 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
ASR by Min
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
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.
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.
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.
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.
6. Select the Time Zone from the list.
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.
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.
Description
Region by Calls
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
38
7/21/06
ASR Report
Description
This report is sorted by region, with the highest billable minutes displaying first.
This report is sorted by region, with the highest revenue displaying first.
This report is sorted by region, with the highest revenue displaying first.
Supplier by Calls
Supplier by Minutes
Supplier by Revenue
Supplier by Profit
Customer by Calls
Customer by Minutes
Customer by Revenue
Customer by Profit
39
7/21/06
RSM Reporting
5.
ASR Report
Description
This report is sorted by supplier plan, with the highest number of calls displaying first.
This report is sorted by supplier plan, with the highest billable minutes displaying first.
This report is sorted by supplier plan, with the highest revenue displaying first.
This report is sorted by supplier plan, with the highest profit margin displaying first.
This report is sorted by Orig REGID, with the highest number of calls displaying first.
This report is sorted by Orig REGID, with the highest billable minutes displaying first.
This report is sorted by Orig REGID, with the highest revenue displaying first.
This report is sorted by Orig REGID, with the highest profit margin displaying first.
Orig IP by Calls
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 Term REGID, with the highest number of calls displaying first.
This report is sorted by Term REGID, with the highest billable minutes displaying first.
This report is sorted by Term REGID with the highest revenue displaying first.
40
7/21/06
RSM Reporting
5.
5.
Description
Term IP by Calls
Term IP by Minutes
Term IP by Revenue
Term IP by Profit
RSM Reporting
ASR Report
Filters
Refer to Filters, on page 33.
41
7/21/06
5.
RSM Reporting
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.
7. Select a Partition 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
11. Select your desired Refresh Interval from the list, or accept the default.
12. Click Show.
13. After some processing time, your report displays.
14. Use the Prev and Next buttons pages to navigate through the report if it
doesnt all fit on one screen.
43
7/21/06
5.
Field
RSM Reporting
Field Descriptions
Description
Report
Carrier
Host
Partition
Begin Date
End Date
Time Zone
Page Number
Page Length
This field indicates the number of entries to be displayed. The default is 100 lines of displayed information.
Refresh Interval
44
7/21/06
5.
RSM Reporting
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.
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:
1. Begin by logging onto the system as described in Logging into the RSM
System, on page 12.
2. Click Reporting>Custom.
3. The Custom home page displays
46
7/21/06
RSM Reporting
5.
5.
RSM Reporting
47
7/21/06
5.
RSM Reporting
Note: When entering a grouping value, remember to click the check box that
enables that field.
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
Duration
ISDN Code
49
7/21/06
5.
Description
IP Address
Regid
RSM Reporting
Field
Error Description
Customer
Supplier
ASR
ARR
Average PDD
Total Calls
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
Partition
Strip
Display
Group Order
Display Order
Host
Begin Date
End Date
Time Zone
Page Number
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
RSM Reporting
Field
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
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.
53
7/21/06
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.
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.
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.
The remaining columns on the listing summarize the parameters that define
the 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.
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.
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.
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
6.
Function
Alarms Events
CDR Alarms
Log Alarms
Actions
RSM Alarming
Menus
Alarm Types
The Alarm Types are as follows:
Description
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
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 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.
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
Description
This alarm is based on the Packets Lost and Packets Received values in the CDRs.
6.
RSM Alarming
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.
62
7/21/06
Dollar Amount
Gateway Minutes
Profit/Loss
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
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
Location
Description
Details
64
7/21/06
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.
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.
1. Sign into the RSM system as described in Logging into the RSM System,
on page 12.
2. Click the Alarming tab.
RSM Alarming
Note: The CDR Alarm page shows a list of currently-specified log alarms.
6.
66
7/21/06
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
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.
Field Descriptions
Description
Alarm Type
Partition
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
On Trigger Action
When this set of conditions is met, it triggers a certain action to be triggered on.
6.
Description
Key
69
7/21/06
RSM Alarming
Field
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)
Value (sec)
70
7/21/06
RSM Alarming
6.
= (equal to)
Field
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.
6.
RSM Alarming
Duration (min)
Description
71
7/21/06
Field
Description
Selected Endpoint
Endpoints
Regions
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
Customer
Start Date
End Date
72
7/21/06
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
System Load
RSM Alarming
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
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
74
7/21/06
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.
3. A dialog similar to the one below displays.
75
7/21/06
6.
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
is taken. Actions can take several forms, as described in ESM: the Events and
Statistics Module (optional), on page 8.
1. Sign into the RSM system as described in Logging into the RSM System,
on page 12.
2. Click on Alarming > Log Alarms.
3. The Log Alarms home page displays.
Note: The Log Alarm page shows a list of currently specified log alarms.
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.
Field Descriptions
Description
Status
Partition Name
Host
Description
Action
This field identifies one or more actions to be performed when the conditions for a log alarm are met.
6.
78
7/21/06
RSM Alarming
Field
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.
RSM Operations Guide
79
7/21/06
10. Your new alarm is saved, and the dialog box closes, and you are returned
to the Alarm page.
11. A message similar to the following displays:
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
Name
Action
This field identifies one or more actions to be performed when the conditions for a log alarm are met.
Host
Description
RSM Alarming
Event Type
80
7/21/06
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
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.
ACTION TYPES
The following is the list of new actions that were added in release 4.X.
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
Executive Script
Log
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
This action modifies the route priority by the specified value (the existing priority
will be changed by this amount).
SNMP Trap
6.
RSM Alarming
Action
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.
1. Log into the RSM system as described in Logging into the RSM System,
on page 12.
84
7/21/06
RSM Alarming
6.
85
7/21/06
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.
RSM Alarming
6.
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.
86
7/21/06
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
7.
RSM System
1. Log onto the system as described in Logging into the RSM System, on
page 12.
2. Click the tab labeled System.
3. The System home page displays.
88
7/21/06
The System tab contains the following menus and submenus. The Configuration menu is active by default.
Configuration
Logging
Status
Function
7.
Used for debugging and general troubleshooting base on logical parts (modules) RSM.
CDRs
Users
RSM System
Menus
89
7/21/06
Function
License
Displays the License details as well as provides an update feature through which these
details can be modified.
Branding
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
Archiver
Audit Trail
CDR Import/Export
CDR Errors
7.
RSM System
Partitioning
Submenu
90
7/21/06
Submenu
Function
Synchronization
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.
RSM System
7.
91
7/21/06
Note: The main objective of the Rater is to determine the buying cost and the
selling price of the call in each CDR.
RSM System
7.
92
7/21/06
Field Descriptions
Field
Description
Enable Rating
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.
Rerater Instances
RSM System
Rerate Automatically
7.
93
7/21/06
Field
Description
Smtp Server
Pop Server
Email User
Email Password
Email From
This field is the length used to compute a routes priority. This field is generated from the Routing LCR.
7.
RSM System
94
7/21/06
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
RSM System
7.
95
7/21/06
RSM System
7.
96
7/21/06
Field Descriptions
Field
Description
Logfile Path
Number of logfiles
All
Reports
XMLMessaging
Rating
CDRSImportExport
Common
DBSync
ProvisionReport
Routing
RatingImport
WebServices
Alarms
Summarizer
Archiver
RSM System
7.
STATUS
97
7/21/06
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.
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.
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.
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
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
1. Use the < Prev and Next > buttons to navigate pages if the report doesn't all
fit on one screen.
Field Descriptions
Field
Description
User
Partition
Client IP
Login Time
Last Activity
RSM System
7.
101
7/21/06
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.
RSM System
7.
102
7/21/06
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.
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
Accessing Branding
To access the Branding page, follow these steps:
1. Click System>Branding.
2. The Branding home page displays.
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.
3. Click the Add button.
4. The Branding page now displays with your banner next to the RSM logo
with the following message displayed:
7.
RSM System
104
7/21/06
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
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
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
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.
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.
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
RSM System
7.
108
7/21/06
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
Ip Address
Description
MswUsername
MswPassword
MswPort
Msw Database IP
Autosync Master
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
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.
2. A dialog similar to the one below displays.
7.
RSM System
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
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.
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
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
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
RSM System
7.
114
7/21/06
Field Descriptions
Field
Description
The name of the partition of which the user is a
member. Every user must be a member of some
partition. partition membership controls the endpoints and ports accessible to that user when
requesting reports
ID
Stylesheet
ASR
Business
7.
RSM System
Partition
115
7/21/06
Field
Description
Route Profit
Custom
Log
CDR
Actions
Endpoints
Routes
Rates
Device
Created
Last Modified
7.
ADDING A PARTITION
RSM System
116
7/21/06
7.
RSM System
117
7/21/06
9. If you wish to return to the previous page, click the Back button.
RSM System
7.
118
7/21/06
Field Descriptions
Field
Description
Partition
Available Endpoints
Authorized Endpoints
An optional limit on the maximum number of concurrent calls this endpoint can have.
Maximum Calls In
The maximum bandwidth of outgoing calls the system can process. The defaults are:
7.
Limited
RSM System
Unlimited
None
Reports
119
7/21/06
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
7.
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
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).
Created
Last Modified
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
7.
1. From the Partitions content page, click the Stylesheet icon corresponding
to a specific partition.
121
7/21/06
RSM System
7.
RSM System
122
7/21/06
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.
RSM System
7.
123
7/21/06
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.
2. A dialog similar to the one below displays.
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.
RSM System
7.
124
7/21/06
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.
4. A dialog similar to the one below displays.
7.
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
Field Descriptions
Field
Description
User
Partition
SysAdmin
ASR
Business
Route Profit
Custom
RSM System
7.
126
7/21/06
Field
Description
Log
CDR
Action
This field indicates whether Action is enabled (yellow bulb) or disabled (gray bulb).
Endpoints
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
Last Modified
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
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.
RSM System
7.
128
7/21/06
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.
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
RSM System
7.
130
7/21/06
Field Descriptions
Field
Description
Partition
User Name
New Password
SysAdmin
Reports
Alarms
RSM System
7.
131
7/21/06
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:
the Add button is disabled from the listing page
the Name link is not clickable (no update)
you cannot Import those tables to the database.
If the Dial Plans Only is checked, write access is
limited to "regions" only.
If Rates is checked, it gives you read/write permission of carrier plans and periods. If you do not have
write access:
the Add button is disabled from the listing page
the Name link is not clickable (no update)
you cannot Import those tables to the database.
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).
132
7/21/06
RSM System
7.
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.
RSM System
7.
3. Make all necessary updates and when finished click the Submit button.
4. A message similar to the one below displays:
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
The Non-Admin user can only update their passwords, all other fields
are hidden.
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.
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
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
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
Field Descriptions
Field
Description
Owner Partition
Realm
Endpoint
Port
Region
Created
Last Modified
7.
Filters
RSM System
137
7/21/06
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.
RSM System
7.
138
7/21/06
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
Field Descriptions
Field
Description
Name
Type
Action
Dir
Created
Now
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
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
Field Descriptions
Field
Job Name
Description
The prefix that will be assigned to the output file
name.
Days
Data
Filter
Begin Date
142
7/21/06
RSM System
7.
Type
Field
Description
End Date
Directory
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>
RSM System
7.
143
7/21/06
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.
RSM System
7.
144
7/21/06
Field Descriptions
Field
Description
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
Client IP Address
7.
RSM System
User Name
145
7/21/06
Field
Description
Action
Key
Status
Created
Details
RSM System
7.
146
7/21/06
Note: Root and admin are hard coded into the system.
7.
147
7/21/06
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.
148
7/21/06
RSM System
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
RSM System
7.
150
7/21/06
Note: This window allows you to add, edit and modify mappings.
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.
Field Descriptions
Field
Description
Mapping Name
Field Name
Format
Type
RSM System
7.
152
7/21/06
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
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
Removing a Field
7.
RSM System
Modifying a Field
To modify a field, follow these steps:
1. Click the Modify Field button.
154
7/21/06
7.
RSM System
155
7/21/06
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
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.
7.
Delete after read - (should file be deleted, after all the CDRs have
been read from this file)
RSM System
157
7/21/06
Field Descriptions
Field
Description
Stream Name
Schedule
Data Source
Start Automatically
To be provided.
Table Name
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
7.
RSM System
158
7/21/06
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
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.
7.
RSM System
160
7/21/06
CDR ERRORS
This section introduces the concepts of CDR Receptor module (CRM) that the
NexTone RSM will provide as a CDR receiving interface.
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.
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 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:
During the import of manually edited CDR files, you must provide the
file name using the web interface.
7.
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.
163
7/21/06
RSM System
5. If you wish to modify all CDRs click the >> All button.
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.
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.
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:
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.
Accessing Synchronization
7.
RSM System
166
7/21/06
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
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.
169
7/21/06
RSM System
In RSMLite:
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.
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
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
ACCESSING ACTIONS
7.
RSM System
172
7/21/06
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
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
174
7/21/06
3. Make updates to the necessary fields and click the Submit button to save
the updates.
4. A message similar to the one below displays.
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
7.
175
7/21/06
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.
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
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.
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.
Rating
Routing
Submenu
Function
Rates Summary
Regions Summary
Rating Tables
-Rates and Routes
-Routes
-Rates
-Regions
-Periods
Import
Rerate
Trace Rate
LCR
MPR
6.
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
RSM Operations Guide
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
4. Use the < Prev and Next > buttons to navigate pages if the report doesn't all
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
Partition
Carrier
Region
182
7/21/06
6.
RSM Provisioning
Field
7. Use the < Prev and Next > buttons to navigate pages if the report doesn't all
fit on one screen.
183
7/21/06
RSM Provisioning
6.
Field Descriptions
Description
Carrier
Region
Endpoint
Priority
Rate
Minimum Duration
Billing Increment
Connection Charge
Start Date
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
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
See Filters, on page 33.
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
RSM Provisioning
6.
186
7/21/06
Field Descriptions
Description
Report
Partition
Region
Carrier
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
RSM Provisioning
6.
188
7/21/06
Field Descriptions
Description
Region
Carrier
Endpoint
Filters
See Filters, on page 33.
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:
Routes
Rates
Regions
Periods
190
7/21/06
6.
RSM Provisioning
Functionality
191
7/21/06
RSM Provisioning
6.
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
realms, endpoints, and regions.
Carrier
Region
This field provides the region configuration from the rating tables. For each region, order carriers are listed in
ascending order of the rate.
Example: BHUTAN-SATTELITE
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
193
7/21/06
6.
RSM Provisioning
Field
5. Use the < Prev and Next > buttons to navigate pages if the report doesn't all
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
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
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
Priority
Rate
ANI
Automatic Number Identification. A service that provides the receiver of a telephone call with the number of the calling phone.
Incoming Prefix
195
7/21/06
6.
RSM Provisioning
Field
Description
Outgoing Prefix
Rating Strip
Rating Addback
6.
Minimum Duration
Billing Increment
Country
Connection Charge
Effective Date
Period
Filters
See Filters, on page 33.
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.
6.
RSM Provisioning
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
realms, endpoints, and regions.
Carrier
Region
This field provides the region configuration from the rating tables. For each region, order carriers are listed in
ascending order of the rate.
Example: BHUTAN-SATTELITE
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
198
7/21/06
6.
RSM Provisioning
Field
RSM Provisioning
6.
Note: The more selections you make, the more refined your output.
7. Use the < Prev and Next > buttons to navigate pages if the report doesn't all
fit on one screen.
Filters
See Filters, on page 33.
199
7/21/06
RSM Provisioning
6.
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.
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
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.
2. The following dialog displays.
6.
201
7/21/06
6.
RSM Provisioning
202
7/21/06
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
Prefix
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
RSM Provisioning
6.
204
7/21/06
RSM Provisioning
6.
Note: The more selections you make, the more refined your output.
5. Use the < Prev and Next > buttons to navigate pages if the report doesn't all
fit on one screen.
Filters
See Filters, on page 33.
205
7/21/06
RSM Provisioning
6.
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
206
7/21/06
10. Once all the parameters are set, save your work by clicking Submit to save
your work.
6.
RSM Provisioning
3. Once you have all necessary updates, click Submit to save your work.
4. A message similar to the one below displays:
Plan xxxx is updated
5. Or click the Back button to leave the page without saving your work.
207
7/21/06
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.
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.
RSM Provisioning
Filters
See Filters, on page 33.
6.
209
7/21/06
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.
6. Select a Partition from the pull down list.
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
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
Partition
Description
Dial Codes
Updating a Region
To update a region, do the following:
1. From the Regions page, click on the region to be updated.
RSM Operations Guide
212
7/21/06
6.
RSM Provisioning
Field
RSM Provisioning
6.
4. Update the information on this window you wish to change, when finished click.
5. A message similar to the one below displays:
Region xxxx is updated
213
7/21/06
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.
RSM Provisioning
214
7/21/06
Field Descriptions
Description
Partition
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.
Note: The more selections you make, the more refined your output.
5. Click the <Prev and Next> buttons if the report doesn't all fit on one
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
Zone
Week Days
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
6.
Filters
See Filters, on page 45.
216
7/21/06
RSM Provisioning
Field
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.
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
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.
A message similar to the one below displays:
Period xxxx is added to the database
219
7/21/06
RSM Provisioning
6.
Field Descriptions
Field
Description
Period
Partition
RSM Provisioning
6.
Time Zone
Start Time
End Time
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.
4. A message similar to the one below displays:
Period xxxx is updated
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.
4. A message similar to the one below displays:
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.
221
7/21/06
RSM Provisioning
6.
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.
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
Partition
Device
Import Table
Delimiter
RSM Provisioning
6.
223
7/21/06
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.
224
7/21/06
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.
7. Select a Partition.
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
11. Click the Submit button.
12. The following message displays:
CDRS marked to be rerated
225
7/21/06
RSM Provisioning
6.
Field Descriptions
Description
Begin Date
End Date
Time Zone
Partition
Endpoint Reg ID
Port
Orig Endpoint
Term Endpoint
If this box is checked, user authorization to be recalculated automatically for the historically cdrs.
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.
226
7/21/06
RSM Provisioning
Field
RSM Provisioning
6.
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
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.
RSM Provisioning
6.
229
7/21/06
Field Descriptions
Description
Partition
230
7/21/06
6.
RSM Provisioning
Field
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
Filters
See Filters, on page 45.
231
7/21/06
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.
3. A dialog similar to the one below displays.
232
7/21/06
5. Or click the Cancel button if you do not wish to save the updates.
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.
RSM Provisioning
6.
3. Click the <Prev and Next> buttons if the report doesn't all fit on one
screen.
234
7/21/06
Field Descriptions
Field
Partition
Description
The name of the partition of which the user is a
member. Every user must be a member of some
partition. partition membership controls the endpoints and ports accessible to that user when
requesting reports.
6.
RSM Provisioning
235
7/21/06
4. Click the <Prev and Next> buttons if the report doesn't all fit on one
screen.
Field Descriptions
Description
Regions
Carriers
Filters
See Filters, on page 33.
236
7/21/06
6.
RSM Provisioning
Field
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
6.
RSM Provisioning
238
7/21/06
RSM Provisioning
6.
Figure 120. Loading iView
239
7/21/06
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.
240
7/21/06
6.
RSM Provisioning
The iServer allows you to set independent session limits for three parameters
at the gateway level:
RSM Provisioning
6.
241
7/21/06
RSM Provisioning
6.
242
7/21/06
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
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
Name
Max Calls In
The overall number of calls the gateway will support, both ingress and egress.
Max Bandwidth In
IMR
EMR
RSM Provisioning
6.
245
7/21/06
RSM Provisioning
6.
246
7/21/06
Field Descriptions
Field
Description
Partition
Name
The overall number of calls the gateway will support, both ingress and egress.
Max Bandwidth In
Timeout
RSM Provisioning
6.
247
7/21/06
RSM Provisioning
6.
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.
249
7/21/06
6.
RSM Provisioning
NEW ENTITY
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.
RSM Provisioning
2. Set the iEdge group's policy parameters (if they don't already exist):
cli igrp edit iedgegroupname parametername parametervalue
Description
maxcallsin
maxcallsout
maxcallstotal
maxbwin
maxbwout
maxbwtotal
emr
imr
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
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.
RSM Provisioning
251
7/21/06
RSM Provisioning
6.
The Subnets window appears. Below is a partial example of the Subnet window.
252
7/21/06
RSM Provisioning
6.
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
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.
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.
10.
RSM Streaming
2.
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.
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
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
-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.
258
7/21/06
RSM Streaming
RSM Streaming
10.
259
7/21/06
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="4" name="Empty"/>
no="5" name="Empty"/>
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>
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.
Description
Destination Database Elements
(applies only to database streams)
dbtype
dbname
dbtable
The name of the table in the dbname database to which the streamed
data is sent
dbhost
replace
dbuser
dbpass
261
7/21/06
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
suffix
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
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
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
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
/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.
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
matchkey
value
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
264
7/21/06
10.
RSM Streaming
Type/Element
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.
A-1
7/21/06
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!
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.
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.
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.
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
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
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
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.
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.
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
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.
type iserver
static 10.20.30.41
h323 enable
cdpntype pass
bcaplayer1 default
sip enable
xcalls 100
CLI Commands
B-6
7/21/06
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
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
!/bin/sh -x
Switch Version (file name = sv)
C-1
7/21/06
CLI Scripts
C.
3. Type sv <version #>. This launches the script and creates a NexTone softlink to the appropriate build.
Note: Where version # = everything after the nextone-.
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.
/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.
-f <logfile>
-s <sequence>
-l <limit>
C-3
7/21/06
CLI Scripts
/etc/init.d/coreadm stop
C.
sequence => 7
CLI Scripts
/usr/local/nextone/bin/logtrim
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.
## 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
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.
In order to do a system backup, you must stop tomcat just as in the system
shutdown above.
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
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
D.
Options:
D-3
7/21/06
RSM
Administration
-c config_file
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]
limit
host
user
pass
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.
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
Description
Formata
Supported
Relationships
date_time
'2004-01-11 00:00:00'
>, <, =
orig_gw
alphanumeric, up to 24 chars.
=, like
term_gw
alphanumeric, up to 24 chars.
=, like
orig_ip
nnn.nnn.nnn.nnn
=, like
term_ip
nnn.nnn.nnn.nnn
=, like
D-6
7/21/06
RSM
Administration
D.
Formata
Description
Supported
Relationships
orig_port
integer
>, <, =
term_port
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
<<E. GenCP>>
(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
E-2
7/21/06
<<E. GenCP>>
E.
<CR>
<CR_NAME> "MEXICO-CIT-011525456xxxd" </CR_NAME>
<CR_SRC> "" </CR_SRC>
<CR_SRCLEN> "0" </CR_SRCLEN>
GenCP
E-3
7/21/06
<<E. GenCP>>
E.
GenCP
</CPB>
<CPB>
<CP_NAME> "TEST_CPB-d" </CP_NAME>
<CR_NAME> "MEXICO-CIT-011525456xxxd" </CR_NAME>
<CR_FLAGS> "0" </CR_FLAGS>
<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
F.
CDR Trim
Information
F-1
7/21/06
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>
-o <outfile>
-r <regid>
-p <cpname>
-x <maxcalls>
-h
- prints this
-v
-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
G-1
7/21/06
GenEP
Information
G.
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>
<XCALLS>"48"</XCALLS>
<PRIO>"0"</PRIO>
<SUBNETIP>"134.222.199.247"</SUBNETIP>
<ET>"xgateway"</ET>
<SFLAGS>"4"</SFLAGS>
<SIGPORT>"1720"</SIGPORT>
<ECAPS1>"17"</ECAPS1>
<SRNO>"CustomerA"</SRNO>
<RASPORT>"1719"</RASPORT>
<CAP2>"260"</CAP2>
<UPORT>"1"</UPORT>
G-2
7/21/06
G.
<CP_NAME>"CustA_CP"</CP_NAME>
GenEP
Information
<BCAP>"33"</BCAP>
<CDPNTYPE>"1"</CDPNTYPE>
<SUBNETMASK>"255.255.255.255"</SUBNETMASK>
<VENDOR>"0"</VENDOR>
</E>
<E>
<XCALLS>"48"</XCALLS>
<PRIO>"0"</PRIO>
<SUBNETIP>"148.122.48.100"</SUBNETIP>
<ET>"xgateway"</ET>
<SFLAGS>"4"</SFLAGS>
<SIGPORT>"1720"</SIGPORT>
<ECAPS1>"17"</ECAPS1>
<SRNO>"CustomerA"</SRNO>
<RASPORT>"1719"</RASPORT>
<CAP2>"260"</CAP2>
<UPORT>"2"</UPORT>
<CP_NAME>"CustA_CP"</CP_NAME>
<BCAP>"33"</BCAP>
<CDPNTYPE>"1"</CDPNTYPE>
<SUBNETMASK>"255.255.255.255"</SUBNETMASK>
<VENDOR>"0"</VENDOR>
</E>
<E>
<XCALLS>"48"</XCALLS>
<PRIO>"0"</PRIO>
<SUBNETIP>"148.122.48.101"</SUBNETIP>
<ET>"xgateway"</ET>
<SFLAGS>"4"</SFLAGS>
<SIGPORT>"1720"</SIGPORT>
<ECAPS1>"17"</ECAPS1>
<SRNO>"CustomerA"</SRNO>
<RASPORT>"1719"</RASPORT>
G-3
7/21/06
G.
<CAP2>"260"</CAP2>
GenEP
Information
<UPORT>"3"</UPORT>
<CP_NAME>"CustA_CP"</CP_NAME>
<BCAP>"33"</BCAP>
<CDPNTYPE>"1"</CDPNTYPE>
<SUBNETMASK>"255.255.255.255"</SUBNETMASK>
<VENDOR>"0"</VENDOR>
</E>
<E>
<XCALLS>"48"</XCALLS>
<PRIO>"0"</PRIO>
<SUBNETIP>"148.122.48.102"</SUBNETIP>
<ET>"xgateway"</ET>
<SFLAGS>"4"</SFLAGS>
<SIGPORT>"1720"</SIGPORT>
<ECAPS1>"17"</ECAPS1>
<SRNO>"CustomerA"</SRNO>
<RASPORT>"1719"</RASPORT>
<CAP2>"260"</CAP2>
<UPORT>"4"</UPORT>
<CP_NAME>"CustA_CP"</CP_NAME>
<BCAP>"33"</BCAP>
<CDPNTYPE>"1"</CDPNTYPE>
<SUBNETMASK>"255.255.255.255"</SUBNETMASK>
<VENDOR>"0"</VENDOR>
</E>
<E>
<XCALLS>"48"</XCALLS>
<PRIO>"0"</PRIO>
<SUBNETIP>"148.122.48.105"</SUBNETIP>
<ET>"xgateway"</ET>
<SFLAGS>"4"</SFLAGS>
<SIGPORT>"1720"</SIGPORT>
<ECAPS1>"17"</ECAPS1>
G-4
7/21/06
G.
<SRNO>"CustomerA"</SRNO>
GenEP
Information
<RASPORT>"1719"</RASPORT>
<CAP2>"260"</CAP2>
<UPORT>"5"</UPORT>
<CP_NAME>"CustA_CP"</CP_NAME>
<BCAP>"33"</BCAP>
<CDPNTYPE>"1"</CDPNTYPE>
<SUBNETMASK>"255.255.255.255"</SUBNETMASK>
<VENDOR>"0"</VENDOR>
</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
AFR
A-Law
ANI
ASCII
ASR
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
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
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
Command Line
Interface (CLI)
Control LAN
The local area network over which heartbeat packets are sent
between an active processor and its peer(s).
CP
Calling Plan
CSC
CSV
.CTT
Database
Default Route
Dialog box
DNIS
H.
Glossary
CIDR
H-2
7/21/06
<<H. Glossary>>
Definition
DNS
Egress-leg
Endpoint
ENUM
ESC
Failover
FCE
Firewall Control Entity. Software used to configure firewall functions. Combines with NSF to implement media routing.
FQDN
Gatekeeper
Gateway
gis/gis process
Glare
H.225
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
H.323 proxy
Hairpin
Hunting
IETF
Ingress-leg
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
LRQ
MCU
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
MFCP
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
MSC
MSW
Node
NSF
H-5
7/21/06
H.
Glossary
Term
<<H. Glossary>>
Definition
OS
OSP
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
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
RBR
Realm-Based Routing.
Realm
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
RMA
RRQ
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
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
SIP
Session Initiation Protocol. A signaling protocol for Internet conferencing, telephony, presence, events notification and instant messaging.
SIP Privacy
Stateful
Stateless
A stateless device is one that does not track the status of something, such as a proceeding telephone call. See Stateful.
Streams
Switchover
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
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
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
URI
URL
See URI.
VIP
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
H-9
7/21/06
H.
Glossary
Term