mvts management system

© MERA Systems 2005

MVTS Management System

User Guide

History of changes

2

MVTS Management System

Windows Graphical User Interface for MVTS

Document №: 1

Document type: User Guide

Document status: Version 1.0.0

Date of issue: 05.06.2005

Responsible employee: O. Zabytina

Copyr ight © 2005 MERA Systems. Al l r ights reserved. MERA Systems reserves the r ight to change any informat ion contained in th is document wi thout pr ior not ice.

COPYRIGHT INFORMATION The informat ion contained in th is document is the property of MERA Systems. No part of th is publ icat ion may be reproduced or copied in any form or by any means - graphic, e lectronic or mechanical including photocopying, recording, taping, or any other informat ion storage and retr ieval system - wi thout wr i t ten consent of MERA Systems. No th ird party, organizat ion or individual, is author ized to grant such permission.

History of changes

3

History of changes

Date Version Author and description of changes

02.10.2005 Release azharkov: document updated and edited

Introduction

Table of Contents

1 INTRODUCTION ........................................................................................................ 11 1.1 DOCUMENT PROFILE.................................................................................................. 11 1.2 AUDIENCE ................................................................................................................. 11 1.3 NOTATIONAL CONVENTIONS ..................................................................................... 11 1.4 DOCUMENT STRUCTURE ............................................................................................ 11

2 PRODUCT OVERVIEW............................................................................................. 13 2.1 GENERAL INFORMATION............................................................................................ 13 2.2 THE MVTS MS STRUCTURE ..................................................................................... 13

3 INSTALLATION.......................................................................................................... 15 3.1 HARDWARE AND SOFTWARE REQUIREMENTS ........................................................... 15 3.2 INSTALLING THE MVTS MS ..................................................................................... 15

4 MVTS GUI .................................................................................................................... 17 4.1 STARTING THE MVTS GUI ....................................................................................... 17 4.2 THE MVTS GUI MAIN WINDOW .............................................................................. 20

4.2.1 The MVTS GUI Menu ........................................................................................ 20 4.2.1.1 File Menu..................................................................................................... 21

4.2.1.2 Edit Menu .................................................................................................... 23

4.2.1.3 Session Menu............................................................................................... 25

4.2.1.4 Object Menu ................................................................................................ 29

4.2.1.5 Graph Menu................................................................................................. 33

4.2.1.6 View Menu .................................................................................................. 38

4.2.1.7 Window Menu ............................................................................................. 39

4.2.1.8 Help Menu ................................................................................................... 41

4.2.2 MVTS GUI Toolbars .......................................................................................... 42 4.2.2.1 File Toolbar ................................................................................................. 42

4.2.2.2 Session Toolbar ........................................................................................... 43

4.2.3 MVTS GUI Main Status Bar .............................................................................. 43 4.3 MVTS SERVER AGENT WINDOW......................................................................... 43

4.3.1 Object Toolbar ................................................................................................... 44 4.3.2 Server Status Bar ............................................................................................... 44 4.3.3 Object View........................................................................................................ 45 4.3.4 MVTS Console.................................................................................................... 46 4.3.5 Activity Monitor ................................................................................................. 47 4.3.6 Object Tree......................................................................................................... 48

4.3.6.1 User Accounts.............................................................................................. 50

4.3.6.2 Configuration............................................................................................... 50

4.3.6.3 Server Statistics ........................................................................................... 50

4

Introduction

4.3.6.4 Runtime Information ................................................................................... 51

4.4 MVTS GUI DIALOG BOXES ...................................................................................... 57 4.4.1 Toolbar Customization dialog box..................................................................... 57 4.4.2 Item Properties dialog box................................................................................. 59

4.4.2.1 Value/Range List Editor .............................................................................. 62

4.4.2.2 Value Set Editor........................................................................................... 63

4.4.3 Search Dialog box.............................................................................................. 65 4.4.4 Sort Dialog box .................................................................................................. 67 4.4.5 Filter Dialog box................................................................................................ 68 4.4.6 Columns dialog box ........................................................................................... 72 4.4.7 Find Text dialog box .......................................................................................... 74 4.4.8 Replace Text dialog box..................................................................................... 75 4.4.9 About MVTS Manager dialog box ..................................................................... 76

5 MVTS GUI CONFIGURATION OPTIONS ............................................................. 77

5.1 GENERAL OPTIONS.................................................................................................... 77 5.2 DATA OPTIONS.......................................................................................................... 79 5.3 INTERFACE OPTIONS ................................................................................................. 80 5.4 APPEARANCE OPTIONS.............................................................................................. 82 5.5 GRAPH SETTINGS ...................................................................................................... 85 5.6 MISCELLANEOUS....................................................................................................... 86

6 WORKING WITH THE MVTS GUI......................................................................... 87 6.1 REGISTERING A NEW MVTS SERVER AGENT IN THE MVTS GUI............................. 87 6.2 LOGGING ON TO THE MVTS SERVER AGENT ........................................................... 87 6.3 WORKING WITH OBJECTS .......................................................................................... 88

6.3.1 Working with Objects......................................................................................... 88 6.3.2 Organizing Objects by Folders .......................................................................... 89 6.3.3 Sorting Objects................................................................................................... 89 6.3.4 Adding, Changing and Removing Objects ......................................................... 90 6.3.5 Printing a List of Objects ................................................................................... 90

6.4 EDITING DATA .......................................................................................................... 90

7 CONFIGURING MVTS............................................................................................... 92

7.1 STARTING, STOPPING AND RESTARTING THE MVTS................................................. 92 7.2 CONFIGURING MVTS................................................................................................ 92 7.3 SETTING PRIMARY OPTIONS...................................................................................... 93 7.4 CONFIGURING RAS USERS........................................................................................ 93 7.5 CONFIGURING GATEWAYS ........................................................................................ 94 7.6 CONFIGURING GATEKEEPERS .................................................................................... 95 7.7 CONFIGURING DIAL PEERS........................................................................................ 96

APPENDIX A ....................................................................................................................... 98 LIST OF ACRONYMS USED IN THE DOCUMENT ..................................................................... 98

5

Introduction

List of figures

Figure 1 MVTS and MVTS MS interaction .......................................................................... 14

Figure 2 Launching MVTS Manager..................................................................................... 16

Figure 3 MVTS Server logon dialog box .............................................................................. 17

Figure 4 Proxy Server Settings dialog box ............................................................................ 18

Figure 5 MVTS Server Connection Options dialog box ....................................................... 19

Figure 6 MVTS Manager Main Window............................................................................... 20

Figure 7 MVTS GUI File menu............................................................................................ 21

Figure 8 Edit menu................................................................................................................. 23

Figure 9 Session Menu........................................................................................................... 25

Figure 10 Object Menu .......................................................................................................... 29

Figure 11 Graph Menu........................................................................................................... 33

Figure 12 The selected area of a graph .................................................................................. 35

Figure 13 The Move mode..................................................................................................... 36

Figure 14 Saving a report file ................................................................................................ 36

Figure 15 Adding a graph ...................................................................................................... 37

Figure 16 Added graphs......................................................................................................... 37

Figure 17 The Fill Beneath option implemented ................................................................... 38

Figure 18 Select date range dialog box.................................................................................. 38

Figure 19 View Menu ............................................................................................................ 39

Figure 20 Window Menu ....................................................................................................... 40

Figure 21 Cascaded windows ................................................................................................ 40

Figure 22 Windows tiled horizontally ................................................................................... 41

Figure 23 Arranged icons....................................................................................................... 41

Figure 24 Help Menu ............................................................................................................. 42

Figure 25 File toolbar............................................................................................................. 42

Figure 26 Session Toolbar ..................................................................................................... 43

Figure 27 Main Status Bar ..................................................................................................... 43

Figure 28 MVTS Server Agent window................................................................................ 44

Figure 29 Object toolbar ........................................................................................................ 44

Figure 30 Server Status Bar ................................................................................................... 45

Figure 31 The Item Category Area of the Server Window.................................................... 45

6

Introduction

Figure 32 Object View........................................................................................................... 46

Figure 33 MVTS GUI Administration Console..................................................................... 47

Figure 34 MVTS GUI Activity Monitor................................................................................ 48

Figure 35 Object Tree ............................................................................................................ 49

Figure 36 The Root Item Popup Menu .................................................................................. 49

Figure 37 User Account Properties dialog box...................................................................... 50

Figure 38 Gateway Properties dialog box...............................Error! Bookmark not defined.

Figure 39 Dialpeer Properties dialog box .............................................................................. 51

Figure 40 Gatekeeper Runtime Information dialog box ........................................................ 52

Figure 41 Endpoint Runtime Information dialog box............................................................ 53

Figure 42 Active Call Runtime Information dialog box........................................................ 54

Figure 43 Directions Load Properties dialog box .................................................................. 55

Figure 44 CDR Properties dialog box.................................................................................... 56

Figure 45 Select Range dialog box ........................................................................................ 57

Figure 46 MVTS GUI call debug log .................................................................................... 57

Figure 47 Toolbar Customization dialog box ........................................................................ 58

Figure 48 Item Properties dialog box (categories expanded) ................................................ 59

Figure 49 Item Properties dialog box (categories collapsed)................................................. 60

Figure 50 Value List Editor ................................................................................................... 62

Figure 51 Value Set Editor .................................................................................................... 64

Figure 52 Search dialog box .................................................................................................. 65

Figure 53 Sort dialog box ...................................................................................................... 67

Figure 54 Filter dialog box .................................................................................................... 71

Figure 55 Columns dialog box............................................................................................... 73

Figure 56 Find Text dialog box ............................................................................................. 74

Figure 57 Replace Text dialog box........................................................................................ 75

Figure 58 About MVTS Manager dialog box........................................................................ 76

Figure 59 General Tab of the MVTS GUI Options dialog box ............................................. 77

Figure 60 Data Tab of the MVTS GUI Options dialog box .................................................. 80

Figure 61 Interface Tab of the MVTS GUI Options dialog box............................................ 81

Figure 62 Appearance Tab of the MVTS GUI Options dialog box....................................... 82

Figure 63 Show item code option at work ............................................................................. 83

Figure 64 Show item name option at work............................................................................ 84

Figure 65 Graph Settings Tab of the MVTS GUI Options dialog box.................................. 85

7

Introduction

Figure 66 Miscellaneous Tab of the MVTS GUI Options dialog box................................... 86

Figure 67 MVTS Server Connection Options: New dialog box............................................ 87

Figure 68 Sorting Objects in the ascending order.................................................................. 90

Figure 69 Configuring RAS Users......................................................................................... 93

Figure 70 Adding a new RAS User ....................................................................................... 94

Figure 71 Configuring Gateways........................................................................................... 95

Figure 72 Configuring gatekeepers........................................................................................ 95

Figure 73 Adding a new gatekeeper ...................................................................................... 96

Figure 74 Configuring Dialpeers ........................................................................................... 97

8

Introduction

List of tables

Table 1 Conventions .............................................................................................................. 11

Table 2 File menu items......................................................................................................... 21

Table 3 Edit menu items ........................................................................................................ 23

Table 4 Session menu options................................................................................................ 25

Table 5 Object menu options ................................................................................................. 29

Table 6 Graph menu items ..................................................................................................... 33

Table 7 View menu items ...................................................................................................... 39

Table 8 Window menu items ................................................................................................. 40

Table 9 Help menu items ....................................................................................................... 42

Table 10 Types of values ....................................................................................................... 60

Table 11 List of operators ...................................................................................................... 69

Table 12 List of Acronyms .................................................................................................... 98

9

Introduction

Table of References

Reference Name of the document [1] “MVTS 3.1.0_User_Manual” [2] “MVTS_Configuration”

10

Introduction

1 INTRODUCTION

1.1 DOCUMENT PROFILE This document is a working manual covering the essentials of installation, configuration and operation of the MVTS Management System (MVTS MS).

1.2 AUDIENCE This manual is intended for System Administrators and operators whose responsibility is to deploy, configure and operate the MVTS Management System. The readers of this document are assumed to have a profound knowledge of the MERA VoIP Transit Softswitch [1] and thorough understanding of its operation.

1.3 NOTATIONAL CONVENTIONS The conventions used in this document are described in Table 1 below.

Table 1 Conventions

Example Convention Note: some text A text to pay special attention to Server Connection Options Arial 11 pt Italic font is used to highlight the

names of dialog boxes Ctrl+Ins Times New Roman 12 pt Bold Italic font is

used to highlight a key or a key combination File Times New Roman 12 pt Bold font serves

to mark names of various menu commands void Text in Verdana 10 pt represents examples

of source code, program output, logs, configuration files etc.

1.4 DOCUMENT STRUCTURE The MVTS Management System contains the following chapters:

• Chapter 1 Introduction contains the description of the profile, target audience and structure of the document.

• Chapter 2 Product Overview covers the product purpose and functionalities.

• Chapter 3 Installation tells you how to install the server and the client part of the MVTS MS. It also details general hardware and software requirements that are prerequisite for installation and operation of the product.

11

Introduction

• Chapter 4 MVTS GUI Interface gives a detailed description of the elements of the application interface.

• Chapter 5 MVTS GUI Configuration Options leads you through the particulars of the MVTS GUI configuration procedure.

• Chapter 6 Working with the MVTS GUI explains how to register a new server agent and how to work with the MVTS server agent objects.

• Chapter 7 Configuring MVTS Server tells you how to start, stop, restart an MVTS, as well as focuses on the ways of setting the essential parameters of the server part of the MVTS MS.

12

Product Overview

2 PRODUCT OVERVIEW

2.1 GENERAL INFORMATION The MVTS Management System (the MVTS MS) is a set of software utilities designed for remote control and administration of the MERA VoIP Transit Softswitch.

The MVTS MS provides a Graphical User Interface for easy MVTS operation and statistical data viewing by a user not familiar with UNIX-like OS.

The primary intent of the MVTS Management System is to facilitate the MVTS administration tasks by means of:

• Run-time modification of the MVTS configuration files • Creation of user groups with distinctive permissions • MVTS GUI Administration console (emulation of the Linux CLI) • Presentation of gateway, dial peer and route statistics in a tabular form

(providing information about peak and current traffic load, total amount of processed calls and their aggregate duration, ASR, ACD etc.)

• Active calls details (originating and terminating gateways, call duration, codecs employed etc.)

• Current traffic listings • Operating gatekeepers and endpoints listings • Statistic plots (with selectable graph type options, adjustable scale,

viewable values, printouts etc.) • Requests for current statistics from the MVTS server agent over

SNMP • SNMP traps for monitoring the MVTS server agent • Regexp templates (for ease of number translation) • Tabular presentation of CDR records • Call logs viewing (in the html format)

2.2 THE MVTS MS STRUCTURE The MVTS MS consists of the following components:

• MVTS Manager (in what follows referred to as the MVTS GUI) that provides the Windows client part of the system.

• MVTS Agent (further the MVTS server agent) that is the server part of the MVTS MS. The MVTS agent runs on the MVTS server and functions as an interface between the Windows-based GUI and the MVTS application running under Linux. The client and the server parts of the MVTS MS communicate over the HTTPS protocol.

13

Product Overview

• MVTS Console, a small CLI utility available in the delivery bundle, which serves to test connectivity between the GUI client and the MVTS agent.

• Remote Client Controller (RCC) API, an application that controls connection and communication between the MVTS GUI and the MVTS server agent.

The picture below shows a block diagram of the MVTS MS components interaction:

Figure 1 MVTS and MVTS MS interaction

14

MVTS GUI : Installation

3 INSTALLATION

3.1 HARDWARE AND SOFTWARE REQUIREMENTS The MVTS GUI hardware and software requirements are:

Pentium II 500 MHz or higher, 128 Mb RAM

Windows NT 4.0 service pack 5 or Windows XP

The system requirements of the MVTS Agent do not differ from those of the MVTS application (see [1]).

3.2 INSTALLING THE MVTS MS To deploy the MVTS MS install the MVTS server agent on the MVTS server and MVTS GUI on a Windows platform.

You must have the root account privileges to be able to install the MVTS server agent.

To install the MVTS server part of the MVTS MS proceed as follows:

1. Log on to the system as root

2. Unpack the supplied archive #> tar xzf manager-RedHat-2.3.20050511.tgz

3. Change the working directory to manager/ #> cd manager

4. Run the installation script: #> ./setup.sh

5. To configure the server part of the application, follow the instructions appearing onscreen

6. Change the working directory to bin/ type #> cd /usr/local/mvts/manager/bin

7. To start the MVTS server agent, type the following string in the bin directory of the MVTS server agent: #> ./mvtsagntctl start

The MVTS GUI is user-friendly and is essentially identical to those of many other Windows-based applications that you have undoubtedly had to go through many times.

Install the MVTS GUI on the Windows platform by running the SetupMVTSmgr.exe executable.

Follow the instructions of the installation wizard appearing on the screen.

During the installation procedure the installer by default places the files into the folder C:\Program Files\MVTS Manager.

15

MVTS GUI : Installation

The shortcuts to the executable components of the GUI package (the console and the MVTS GUI) will be included into the Start menu and can be invoked as any other Windows application by the following mouse pointing-clicking sequence:

Start -> Programs -> MVTS Manager -> MVTS manager (for the MVTS GUI). Also see the picture below:

Figure 2 Launching MVTS Manager

Start -> All programs -> MVTS Manager -> mpsh (for the console).

16

MVTS GUI : Operation

4 MVTS GUI

4.1 STARTING THE MVTS GUI To start the MVTS GUI run the MVTSmgr.exe executable. The application starts with the Logon dialog box that provides a tool to create a new or modify the existing MVTS server agent connection record.

Figure 3 MVTS Server logon dialog box

The dialog box consists of the following elements:

and are logon credentials employed for identification and authentication of a user trying to connect to the selected MVTS server agent.

The fields User ID and Password are filled in automatically when you select the MVTS server agent record, which you used for last log-on to the MVTS

server with the checkbox selected.

This checkbox is a duplicate of the "Store password" checkbox in MVTS GUI General Options. Check the checkbox to make the

17


MVTS GUI save the logon credentials you use when connecting to the MVTS server agent, so next time you won't need to enter them again. Remember, though, that the passwords are stored in clear text which is insecure.

Checking this box enables the offline operation mode, which allows user to work with the MVTS GUI locally. In this case no connection with the MVTS server agent will be established.

. This checkbox allows you to connect to the MVTS server

agent via a proxy server. If this checkbox is checked the button becomes active.

This button invokes the following dialog box:

Figure 4 Proxy Server Settings dialog box

Checking the checkbox will enable use of the proxy server settings of your Internet Explorer browser. In this case the address and port fields are filled in automatically and you have to provide only the username and password.

displays the list of connection records established by the MVTS GUI with MVTS server agents. Here you can select the connection record you want to modify or connect to.

If the logon credentials for the server agent connection record you have

selected were saved during the last session, the and fields are filled in automatically.

Click this button to delete the selected connection record..

Click this button or press Enter to use the selected connection with the MVTS server agent under the specified logon credentials. It is impossible to establish more than one connection with the same server.

18


The button closes the dialog box.

The button shows the help topic.

This button brings up the MVTS Server Connection Options dialog box, which allows editing the MVTS server agent connection record that you have selected.

The button invokes the MVTS Server Connection Options: New dialog box, which serves to add a new MVTS agent connection record.

Figure 5 MVTS Server Connection Options dialog box

Fill in the edit fields of the dialog box to configure the following parameters:

Use the field to enter the name of the new connection record. It can be the name of the place where the MVTS server is located or the name of your company. This field is mandatory.

Enter the IP address of the MVTS server agent host here. This field is mandatory.

– enter the port number used by the MVTS server agent. The default value is 1730. This field is mandatory.

and are your logon credentials to access the MVTS server agent. For a newly installed server agent the User ID is "admin" and the password is "admin" (typed without quotes). These fields are optional and if not filled, you will have to enter your credentials each time you connect to the MVTS server.

19


The text box is intended for comments about the server that you may wish to add. This field is optional.

When through with filling in the necessary parameters click

4.2 THE MVTS GUI MAIN WINDOW After logging on to the MVTS Server you will see the MVTS GUI Main Window, which looks like this:

Figure 6 MVTS Manager Main Window

It contains the MVTS GUI menu, toolbars and free space for simultaneous representation of several application windows.

Note: the IP addresses of the gateways, which appear in the Object View (Fig. 6), have been intentionally removed for safety reasons.

4.2.1 THE MVTS GUI MENU

The MVTS GUI menu items provide access to a range of the application functions.

20


4.2.1.1 File Menu The screenshot below shows the MVTS GUI File menu.

Figure 7 MVTS GUI File menu

Table 2 File menu items Command Description Shortcuts

This command creates an empty window for free textual editing. It invokes a built-in text editor, designed for users’ convenience. It allows creating and editing configuration files in plain text format, as well as viewing debug logs.

• Click on the File toolbar to carry out this command.

This command brings up the "Open File" dialog box that allows you to choose a plain text file to open for viewing or editing.


This command closes the current textual window offering to save its contents if it was modified.

This command saves the contents of the current textual window.


This command is absolutely identical to the “Save”

21


command

Note! This command is unavailable if no textual window is currently active.

This command displays a standard Windows "Print setup." dialog box, which allows you to select and configure printers.

This command allows you to configure the current page size, layout and other options.


This command prints the contents of the current view or textual window.

Notes!

• This command is unavailable if no textual window or MVTS server agent view is currently active.

• This command will pop up a Print Setup dialog box, which allows you to choose and configure the printer options and page layout.


This command shows how the current textual document or MVTS server agent view will look when printed.

Note! This command is unavailable if no textual window or MVTS server agent view is currently active.


This command shows the "MVTS Manager Options" dialog box. For more information, see MVTS GUI Configuration Options.


22


Use this command to exit the MVTS GUI

Note! You can also close the main MVTS GUI window to exit the program.


4.2.1.2 Edit Menu The following is the MVTS GUI Edit Menu:

Figure 8 Edit menu

Table 3 Edit menu items

Command Description Shortcuts

Use this command to remove the selected text from the active textual window to the Windows Clipboard.

Note! This command is unavailable if no textual window is currently active or nothing has been selected in the current textual window.


Use this command to copy the selected text from the active textual window to the Windows Clipboard.

Note! This command is unavailable if no textual window is currently active or nothing has been selected in the current textual window.


23


Use the command to insert the contents of the Windows Clipboard to the insertion point in the active textual window.

Note! This command is unavailable if no textual window is currently active or there is nothing in the Windows Clipboard.


Use “Undo” or Ctrl+Z on the keyboard to undo the last command or revert to the previous entry made in the active textual window.

Notes!

• This command is unavailable if no textual window is currently active.

• This command reverses itself as well, so choosing Undo for the second time will restore the reversed changes.


Use the command to select all the text in the active textual window.


This command brings up a Find Text dialog box, which allows you to search for a specified string in the contents of the active textual window.

Notes!

• This command is unavailable if no textual window is currently active or the current


24


textual window is empty

To search through the objects of the Object View, use the Search button from the Object toolbar.

This command brings up the Replace Text dialog box, which allows you to search for a specified string in the contents of the active textual window and replace it with a string of your choice.

Note! This command is unavailable if no textual window is active or the current textual window is empty.


4.2.1.3 Session Menu This is what the MVTS GUI Session Menu looks like:

Figure 9 Session Menu

Table 4 Session menu options


This command brings up the Logon dialog box that

• Click on the Session toolbar to carry out this

25


allows you to connect to the MVTS server agent of your choice.

command.

This command brings up an MVTS Server Connection Options New dialog box, which allows you to create a new MVTS server agent connection record in the MVTS GUI.

• Click on the Session toolbar to carry out this command.

Use this command to delete the currently selected MVTS server agent connection record


This command allows viewing the properties of the MVTS server you are currently connected to.


Use this command to start the MVTS Notes!

• This command is not available when there is no server window currently active or when the MVTS is already running.

• Only members of the Admin group can carry out this command

• Click on the Session toolbar to carry out this command

This command shuts down the MVTS.

Notes!

• This command is not available if no server window is currently active or if the MVTS is not running.



This command enables the edit mode to modify the

• Click on the Session toolbar to carry out this

26


existing configuration of gatekeepers, gateways, dial peers and RAS users.

This command is available to only one user at a time.

Note! This command is not available when no server window is currently active or when the current MVTS server agent record is already in the edit mode.

Only members of the Admin group can carry out this command

command.

This command quits the edit mode for the current MVTS server agent connection record without saving any changes made.

Notes!

• This command is not available when no server window is currently active



If you are working in the off-line mode (no connection to a remote server has been established) this command saves the edited configuration on your computer.

If you are connected to a remote MVTS server, this command saves the changes in the configuration on this server. However, the changes will be effective only after you carry out the “Apply changes”


27


command (see below).

Notes!

• This command is not available when no server window is currently active or when the current MVTS server agent record is not in the edit mode.


When in the off-line mode, this command establishes a connection to the MVTS server and uploads the edited configuration files to the MVTS.

Edit all the configuration files locally and then use this command to upload the edited files to the MVTS server all at once.

Notes!

• This command is not available when there is no server window currently active or the current MVTS server agent connection is not local.

• This command is available only to the users of group “Admin”.


This command makes the remote MVTS load the configuration files that you have saved on or uploaded to the remote server.

Notes!

• This command is not available when there is no server window


28


currently active or when the MVTS is shut down.


4.2.1.4 Object Menu The following picture illustrates the MVTS GUI Object menu.

Figure 10 Object Menu

Right click the object in the Object View to invoke the dropdown list, which comprises the same items as the Object menu.

Table 5 Object menu options


29


Use this command to create a new folder in the Object View.

Note! It is impossible to create a new folder in the User accounts section of the Object Tree.

• Click on the Object toolbar to carry out this command.

This command creates a new item in the Object View and displays the Item Properties dialog box.


This command deletes the selected item in the Object View, be it a regular item or a folder.

Note!

It is impossible to delete folders (Admin, Support and Billing) in the User Accounts section of the Object Tree.


This command displays the Properties dialog box that allows you to edit the properties of the item currently selected in the Object view.

If the selected item is a folder, a simple dialog box with a single edit field is displayed, allowing you to rename the folder.

Note!

It is impossible to modify the properties of the three folders (Admin, Billing and Support) in the User Accounts section.

• Click on the Object toolbar to carry out this command

30


This command retrieves the configuration information of the selected item from the MVTS.

If this command is carried out in the edit mode, all the unsaved configuration changes you have made will be lost.


Use this command to comment/uncomment the object of the configuration file you are currently editing.


This command allows you to create a copy of the selected configuration entry.


Use this command to check the entries of the configuration file you are dealing with.

If all the entry fields of this configuration file are correct, the command’s output will read “Checked successfully”.

Otherwise the command will display a warning message with the name of the problem entry.


This item allows you to choose between the following wizards:

The Configuration wizard helps you to create records for originating and terminating communication entities (gateways, RAS users etc.)

The Gatekeeper wizard helps you to create gatekeeper records for originating and terminating call legs

31


This command moves the selection in the Object View to the first item on the list.


This command moves the selection in the Object View to the previous item.


This command moves the selection in the Object View to the next item.


This command moves the selection in the Object view to the last item on the list.


This command brings up the Search dialog box, which allows you to search for a specific item through the Object View.


This command invokes the Sort selection dialog box, which allows user to choose the sort order of the items in the Object View.


This command invokes the Filter definition dialog box, which allows you to set the filter for the items in the Object View.


Note: this command is not active for dial peers.

This command is identical to the “show dial” command of the MVTS administration console. However, with the help of “show dial” in MVTS GUI you can view the translated ANI and DNIS numbers of the call originator.

This command brings up the Columns selection dialog box, which enables user to select the columns that will make up the Object View.


32


Use this command to close the connection to the MVTS server agent you are currently using.


4.2.1.5 Graph Menu This menu can be invoked as a popup menu by right-clicking the mouse in the plot area of the Graph View.

The following is a picture of the MVTS GUI Graph menu.

Figure 11 Graph Menu

Table 6 Graph menu items

Command Description

This command allows you to cancel the action invoked by other menu items, i.e. Move, Cursor etc.

This command allows you to enlarge a portion of the graph. The mouse pointer will change to a cross. Keeping the left mouse button depressed drag the mouse cursor to select the area you want to enlarge (your selection will be highlighted by a rectangular shape). The selected area of the graph will stay enlarged till the next screen redrawing (see Fig. 12).

33


This command initializes the graph drawing.

This command allows you to adjust the position of the curve in the graph window. The shape of the mouse pointer will change to a four-arrow cross (see Fig. 13).

Drag the graph picture with the mouse and position it as you prefer.

The graph picture retains its new position till the next screen redrawing. Pick Select on the Graph menu to cancel the Move mode.

With graphics being a very resource-intensive process in terms of computing power plotting curves covering an activity history for considerable stretches of time is a serious job for the system.

To avoid unnecessary dissipation of the system computing capacity the plotting data are written to files in the directory named after the server name in the folder specified on the Graph settings tab of the MVTS Manager options dialog box.

Click this option to create a graph file into which the activity curve for the period of interest will be saved. It will bring up a file dialog box (Fig. 14) for you to select a file with the necessary data for the graphic report. Select Continue drawing to recover from the Make report mode.

This command allows you to save a screenshot of the current graph. Clicking “Export” brings up a file dialog box for you to select a name for the file in the .bmp format.

This item invokes a submenu (see Fig. 15) with communication entities whose activity you wish to have plotted on the graph. The names of the added entities appear in the curve-color legend under the plot area (see Fig 16).

This option is a shortcut for the curve plotting mode. It allows you to remove all additional curves from the plotting area. The gateways, terminators, originators and dialpeer curves will all disappear from the graph, and the Active calls plotting only will continue.

This option clears the current graph and resumes curve plotting from the moment of the data clearing.

This command allows you to interrupt the curve

34


plotting. Click this option again to resume the graph construction. After you select the Make report option the Suspend drawing menu item changes for the drawing continuation.

This option toggles the number-of-active-calls curve drawing option.

This option toggles displaying of the 5 minutes average curve for calls.

This option will allow you to fill the area between the curve and the X axis with the curve color (see Fig. 17).

Note: The option is available for single-curve graphs only.

This item becomes active and accessible only when you are in the Make report mode. Click the item to invoke the date setting dialog box (see Fig. 18) and define the portion of the report graph you wish to inspect.

Figure 12 The selected area of a graph

35


Figure 13 The Move mode

Figure 14 Saving a report file

36


Figure 15 Adding a graph

Figure 16 Added graphs

37


Figure 17 The Fill Beneath option implemented

Figure 18 Select date range dialog box

4.2.1.6 View Menu The picture below is a screenshot of the MVTS GUI View Menu.

38


Figure 19 View Menu

Table 7 View menu items


Use this command to show or hide the File toolbar.

• Right-click any toolbar and check/uncheck the File toolbar item in the popup menu.

Use this command to show or hide the Session toolbar.

• Right-click any toolbar and check/uncheck the Session toolbar item from the popup menu.

Use this command to show or hide the Status bar.

This command brings up the Customize Toolbar dialog box, which allows you to add or remove buttons from the File toolbar.

• Right-click the File toolbar and pick the "Customize..." item from the popup menu.

This command pops up the Customize Toolbar dialog box, which allows you to add or remove the Session toolbar buttons.

• Right-click the Session toolbar and pick the the "Customize..." item from the popup menu.

4.2.1.7 Window Menu Below is the MVTS GUI Window Menu:

39


Figure 20 Window Menu

Table 8 Window menu items

Command Description

Use this command to cascade all the MVTS server agent windows (see Figure 22).

Use this command to tile all the MVTS server agent windows (see Figure 23).

This command arranges all the minimized MVTS server agent windows (see Figure 24).

Window list ( ) This item allows you to switch between the MVTS server agent windows by checking the appropriate window name.

Use the key combination Ctrl+Tab to shift through the server agent windows.

Figure 21 Cascaded windows

40


Figure 22 Windows tiled horizontally

Figure 23 Arranged icons

4.2.1.8 Help Menu The picture below is a screenshot of the MVTS GUI Help Menu:

41


Figure 24 Help Menu

Table 9 Help menu items


This command displays the Help Topic.

This item allows you to obtain information on any of the MVTS GUI interface elements.

Click on the File toolbar and then click the object you wish to get information on.

This command brings up the About MVTS Manager dialog box


4.2.2 MVTS GUI TOOLBARS The MVTS GUI toolbars are the File toolbar and the Session toolbar.

The toolbars are made up of shortcuts to the most frequently used menu commands.

Notes!

• The currently active toolbars have a check mark next to them in the View menu.

• To hide a toolbar, right-click it and uncheck the corresponding item of the pop-up menu.

• To customize a toolbar, right-click it and choose the "Customize..." item. It will bring up the Customize Toolbar dialog box.

4.2.2.1 File Toolbar The File toolbar contains shortcut buttons to the most commonly used commands of the File, Edit and Help menus.

Figure 25 File toolbar

42


4.2.2.2 Session Toolbar The Session toolbar contains shortcut buttons for the frequently used options of the Session Menu.

Figure 26 Session Toolbar You can find the description of the toolbar buttons in the table of the Session Menu items description.

For the description of the File and Session toolbar buttons see section 4.2.1 MVTS GUI Menu.

4.2.3 MVTS GUI MAIN STATUS BAR The MVTS GUI Main Status Bar consists of two parts: Description area and Lock Indicators (see Fig. 27 below). Check/uncheck the ‘Status bar’ item of the View menu to show or hide the status bar.

Figure 27 Main Status Bar

The Description area is a mini-help, which displays the tooltip for the menu command or the toolbar button currently pointed at with the mouse.

For example, when you point your mouse at the "Shutdown" command in the Session menu, it displays the tooltip "Shutdown MVTS Server".

The Lock Indicators are CapsLock, NumLock and ScrollLock - the duplicates of the corresponding keyboard lights.

For example, when the Caps Lock is on, "CAP" is displayed in the status bar.

4.3 MVTS SERVER AGENT WINDOW Below is a sample of the Server Agent Window:

43


Figure 28 MVTS Server Agent window

4.3.1 OBJECT TOOLBAR The Object toolbar (see Fig.29 below) of the Server Agent Window contains shortcuts to the most commonly used commands of the Object menu.

Figure 29 Object toolbar For the description of the File and Session toolbar buttons see section 4.2.1 MVTS GUI Menu.

4.3.2 SERVER STATUS BAR The Status bar of the Server Window (Fig.30 below) comprises three sections: the category area, the total items counter and the selected items counter.

44


Figure 30 Server Status Bar

The category area displays the name of the category currently selected in the Object Tree:

Figure 31 The Item Category Area of the Server Window

The Total items counter shows the total number of items in the Object View.

The Selected items counter displays the number of items currently selected in the Object View.

4.3.3 OBJECT VIEW Object View is the main part of the MVTS server agent window. It displays the contents of the object currently selected in the Object Tree.

45


Figure 32 Object View

You can add, edit, delete, move, sort, filter and print the items in the Object View.

4.3.4 MVTS CONSOLE The Administration Console of the MVTS GUI provides a command-line interface (CLI) for remote MVTS administration. It features the same commands as the MVTS administration console.

For the list and description of the MVTS administration console commands please refer to [1].

The picture below shows the output of the show stat command entered in the MVTS GUI console.

46


Figure 33 MVTS GUI Administration Console

4.3.5 ACTIVITY MONITOR The Activity monitor (see Fig. 34 below) is a real-time graph, which shows the MVTS call activity in a graphical form.

The X-axis of the graph is the time scale while the Y-axis shows the number of concurrent calls being handled.

Use the Graph Menu options to work with the MVTS call activity graph.

47


Figure 34 MVTS GUI Activity Monitor

4.3.6 OBJECT TREE The Object Tree is a part of the MVTS server agent window that displays a tree-like structure of the MVTS server agent objects and folders.

48


Figure 35 Object Tree

The root of this tree-like structure is the MVTS itself. When the MVTS is

running, the color of its icon is green: . The icon turns red when the server is stopped: .

Right-click the MVTS server icon to invoke a popup menu associated with it (Fig.36).

Figure 36 The Root Item Popup Menu

The options of this menu are identical to those of the Session Menu.

49


The first-level items of this tree are four categories (User Accounts, Configuration, Server Statistics, Runtime Information), which contain objects or individual items.

When you select a category or an object in the Object Tree, its contents are displayed in the Object View.

4.3.6.1 User Accounts This category provides the information concerning the Admin, Billing and Support user groups.

Figure 37 User Account Properties dialog box

4.3.6.2 Configuration This category allows users to configure the properties of the gatekeepers, gateways, dial peers and RAS users. For more information see Section 7 “Configuring MVTS”.

4.3.6.3 Server Statistics This category permits viewing statistics data on Originators, Terminators, Gateways and Dialpeers.

50


Double-click a record in the Object View to display its properties.

The Dial peer Properties dialog box contains statistical data concerning dial peers such as statistics collection start, current and maximum load, received call etc.

In the same way the Originator Properties dialog box displays statistical information concerning outgoing calls from the selected gateway.

The Terminator Properties dialog box contains information with regard to the calls received by the selected gateway.

Similarly, the Gateway Properties dialog box displays information about the selected gateway be it a terminating or an originating gateway.

Figure 38 Dialpeer Properties dialog box

4.3.6.4 Runtime Information This category represents runtime information, concerning the following objects:

• Gatekeepers

• Endpoints

• Active calls

• Directions Load

51


• SNMP Traps

• CDRs

The object “Gatekeepers” contains a list of gatekeepers, with which the MVTS registers as a RAS-user. Double-click a gatekeeper record in the Object View to display its properties.

Figure 39 Gatekeeper Runtime Information dialog box

The object “Endpoints” is a list of RAS-users currently registered with the MVTS. Double-click an endpoint record in the Object View to see its properties in a dialog box, similar to the one shown in Fig. 41 below.

52


Figure 40 Endpoint Runtime Information dialog box

The object “Active Calls” of the Runtime Information object category represents a list of active calls and their details.

53


Figure 41 Active Call Runtime Information dialog box

The object “Directions Load” displays call grouped on the “originator-to-terminator” principle.

The Object View displays the originating party, the terminating party and the number of active calls between each originator-terminator pair.

54


Figure 42 Directions Load Properties dialog box

The object “SNMP Traps” contains a list of SNMP traps, received by the MVTS Manager.

To enable SNMP traps service for the Windows OS use the following mouse pointing-clicking procedure:

Start – Control Panel – Administrative Tools – Services – SNMP Traps service.

The object «CDR» item contains a list of call detail records.

The number of CDRs to be displayed in the Object View is defined in the MVTS GUI File menu, item “Options”, tab “Miscellaneous”.

Double-click any of the CDRs in the Object View to show its properties (Fig. 44).

55


Figure 43 CDR Properties dialog box

If you wish to view CDRs of all calls, handled by the MVTS within a certain time period, use item “Retrieve” of the Object menu or press F4.

The Retrieve item pops up the Select Date Range dialog box (see Fig. 45), where you can define the period of time for CDR retrieval.

56


Figure 44 Select Range dialog box

The MVTS GUI allows viewing a debug log of any call, whose CDR is present in the Object View. To do so, right-click the mouse on the CDR of the call of interest and choose item “Debug” from the drop-down menu. It will display the call debug log (See Fig. 46).

Figure 45 MVTS GUI call debug log

4.4 MVTS GUI DIALOG BOXES

4.4.1 TOOLBAR CUSTOMIZATION DIALOG BOX The Customize Toolbar dialog box serves to customize the MVTS GUI toolbars, which involves adding, rearranging and removing the available toolbar buttons, changing their size and showing or hiding their text labels.

To display the Customize Toolbar dialog box (Fig. 47 below) use the Customize File and Customize Session items of the View menu.

57


Figure 46 Toolbar Customization dialog box

The description of the dialog box elements is given below:

displays the buttons that you can add to the toolbar.

displays the buttons in the order they appear (from left to right) on the toolbar.

adds the selected button to the toolbar. Clicking moves the button selected in the to the . Only the buttons listed in the can appear on the toolbar.

removes the selected button from the toolbar. Clicking moves the button selected in the to the .

The items of the drop-down list box serve to add, remove, and change position of the toolbar button name.

With No text labels, the buttons on the toolbar will look like this: , the Selective text on right item will display text on the right side of the button -

and the Show text labels item will place text beneath the button -

.

allows you to choose the size of the toolbar buttons.

moves the selected button one line up. The button shifts one space left on the toolbar.

moves the selected button one line down. The button shifts one space right on the toolbar.

58


enables default settings of the toolbar rearranging all available buttons in the order they commonly appear.

closes the dialog box.

4.4.2 ITEM PROPERTIES DIALOG BOX The Item Properties dialog box (shown in Fig.48) allows you to modify the properties of any item appearing in the Object View with the help of the Properties and Edit commands. You can change the properties of the MVTS itself by right-clicking its icon in the object tree and choosing “Properties” from the menu.

Figure 47 Item Properties dialog box (categories expanded)


The topmost edit box allows you to specify the name of the item. However, it is impossible when you are modifying the MVTS properties.

The list of properties contains the item parameters and their values, organized by categories.

59


In our example (see Figure 48 above), ‘General’ is the name of a category, which includes the gateway parameters, for instance: IP address (118.233.233.112 in our case).

The list of categories collapsed is given below:

Figure 48 Item Properties dialog box (categories collapsed)

Working with the Properties list:

To expand or collapse a category, click the plus or minus sign on its left or just double-click the category name. Alternatively, click to expand or to collapse all categories at once.

Each category, when expanded, shows a certain number of parameters with their values on the right. To change the value of a particular parameter, select it and press the Enter key, or just click the value itself.

All the parameter valid values fall into several categories or types, shown and described in the table below:

Table 10 Types of values

Type Description Means of entry

Flag This type of value allows you to choose between Yes or No only.

Check or clear the checkbox.

String An arbitrary sequence of alphanumeric characters.

Type the character sequence in the edit box.

60


Password Same as a string, but all characters are masked with the '*' character.

Type the password in the edit box.

Do not mistype!

Masked string A string that accepts only certain characters or only a predefined number of characters.

The types of masked strings are described below.

Type the value in the edit box.

The masked edit box does not accept incorrect characters.

Number A masked string which allows entry of numeric characters only. The length of such a string is usually limited to 5 characters.

IP address A masked string that accepts four 3-digit numbers separated by dots (the IP address format).

Do not enter dots. They are already in the edit box.

Value list A list of values delimited by the ';' character. Click the button to bring

up the Value List editor and enter values into the fields of the Value List.

Range list A list of values delimited by the ';' character. Each value is a number or a combination of two numbers separated by '-' (the minus sign). For example: 10;20;200-230;250-253;255

Click the button to bring up the Range List editor and enter values into the fields of the Range List.

Value set A set of values, delimited by the ';' character. The values are usually taken from a pre-defined set, but it is possible to enter a user-defined value. The value set is commonly used to modify a set of the allowed codecs. The order in which the values appear is of no importance.

This type of value can be entered into the right column of the Properties dialog box opposite the parameter, but it is recommended only when you need to add a user-defined value. In all other

cases click the button to bring up the Value Set editor and choose a value from the pre-defined set.

61


Choice A fixed list of values. Select an appropriate value from the combo box.

Description area. The description area is located immediately above the OK and Cancel buttons. Click a category or any of its individual items to see its brief description in the description area.

4.4.2.1 Value/Range List Editor The Value and Range list editors are two variants of the same dialog box, which provides an interface for editing or entering a list of values or value pairs.

Figure 49 Value List Editor The description of its elements is given below:

Value list toolbar. The toolbar contains shortcut buttons to commands for manipulations with the list of values.

These commands are also present in the popup menu that can be invoked by right-clicking the value list (see below).

62


The individual commands of the Value list toolbar are described below.

• Add (Alt + Ins). Adds a new item to the end of the list and switches to the edit mode.

• Insert (Ins). Inserts a new item by moving the currently selected one a line down and invokes the edit mode.

• Delete (Del). Removes the currently selected item from the list.

• Edit (F2). Enables the edit mode for the selected item. Alternatively, you can enter the edit mode by double-clicking an item. Use the Tab key to switch between the first and last values of an interval. To accept the changes, press the Enter key. To discard the changes, press Esc. Empty fields will be removed automatically.

• First (Home). Selects the first item on the list.

• Previous (Up). Selects the previous item on the list, if some item is already selected.

• Next (Down). Selects the next item on the list, if some item is already selected.

• Last (End). Selects the last item on the list. To move an item up and down the list you can use “drag-and-drop”.

• Move up (Alt + Up). Moves the currently selected item one row up, if the item is not in the first row already.

• Move down (Alt + Down). Moves the currently selected item one row down, if the item is not in the last row yet.

4.4.2.2 Value Set Editor The Value Set editor is a dialog box that allows choosing a set of values from the list.

63


Figure 50 Value Set Editor

The description of its elements is given below:

is a field containing a number of items chosen as the parameter values.

is a field containing all possible values for a given parameter that are not in the Selected Items list but can be added to it.

moves the selected values from the list to the list.

moves all values from the list to the list.

removes the selected values from the list to the list.

moves all the values from the list to the list.

Working with the Value Set Editor:

• To move a value from the ‘Selected Items’ to the ‘Available Items’ or contrariwise, double-click the value, or select the value and click the

or button, or drag-and-drop the value.

64


• To move several items at once click them one by one holding down the Ctrl key and click ‘Add’ or ‘Remove’. To select a number of adjacent items click the first item and then click the last item holding down the Shift key.

4.4.3 SEARCH DIALOG BOX The Search dialog box allows you to search for items of a particular type throughout the Object View. To invoke the Search dialog box use the Search command or the toolbar button.

Figure 51 Search dialog box

The description of the Search dialog box elements is given below:

is a character string you want to search for.

is a list of checkboxes each representing a column in the Object View. It allows you to specify the columns where the search will be carried out. To include a column in the search, check the checkbox on its left. The search will not start if no columns are specified.

features two options: Only visible columns and All available columns.

65


With the first option selected, only the visible columns of the Object View will appear in . If you select the second option, will contain all columns available for this type of the Object View item.

serves to base the search on the case match of every character in the search string. For example, if your search string is "Sample" starting with a capital "S", the word "sample" will not be found if the match case checkbox checked.

allows searching for a particular object using regular expressions as a string pattern.

Detailed information on regular expressions is available in [1].

checks all the checkboxes in thus including all the columns into the search.

unchecks all the checkboxes in .

initiates the search. The search results are displayed in the Results field.

moves the selection in the Results field one row down. A corresponding item in the Object View is highlighted when possible.

closes the current instance of the Search dialog box.

Results field displays the search results. When you select an item in this field, it is highlighted in the Object View.

Working with the Search dialog box:

Imagine that you need to find all the gateways that belong to an imaginary company called "MegaIP". You know, that the names of these gateways contain the word "mega" in either the Identifier or the Group name field. Go through the following steps to perform the search:

• Click the Gateways category in the Object Tree;

• Click on the Object toolbar or press Ctrl+F7 to invoke the Search dialog box;

• Type the word "mega" in the field;

• Check the "Identifier" and the "Group name" checkboxes in ;

• Make sure the and checkboxes are unchecked;

• Click ;

• Explore the results.

66


4.4.4 SORT DIALOG BOX The interface of the Object View allows sorting data without having to resort to the aid of the Sort dialog box. The Object View consists of columns, which represent the parameters of the item selected in the Object Tree, so it is possible to sort the data by each of these parameters independently.

Since the parameters of an object (a gateway, a dialpeer, a RAS user or a gatekeeper) are represented by columns in the Object View, to sort data by a parameter click the corresponding column header. You can perform two types of sort: ascending sort and descending sort. When you click a column header for the first time, the data in this column is sorted in either alphabetical or numeric ascending order. The ‘up arrow’ will appear on the left of the column header name: .

Click the column header once again to sort the data in the descending order. In this case the ‘down arrow’ will appear in the header name:

.

However, you might want to sort data by two or more parameters simultaneously. The Sort dialog box is intended for this purpose. Use F7, the

button or the Sort command from the drop-down menu to invoke this dialog box.

Figure 52 Sort dialog box

The description of the Sort dialog box elements is given below:

contains a list of the columns whose data is to be sorted.

67


is a list of all visible columns of the Object View.

moves the selected column from the list to the list.

moves all the fields from the list to the list.

moves the selected field from the list to the list.

moves all the fields from the list to the list.

Working with the Sort dialog box:

• To move a column from one list to the other, double-click the column, or select it and click or , or just drag-and-drop the column.

• To move several columns, click them one by one holding down the Ctrl key and then click or , To select a contiguous set of columns, click the first one and then click the last column holding down the Shift key.

• To sort the data by all available columns, click .

• To disable sorting click .

• To change the precedence of columns, drag-and-drop them within the list.

• To change the type of sort for an individual column, click the arrow on its left. The up arrow ( ) means the ascending sort order and the down arrow ( ) means the descending sort order.

4.4.5 FILTER DIALOG BOX The Filter dialog box allows you to define filters for data in the Object View. To invoke the Filter dialog box use F8, or the Filter command from the drop-down menu.

Filter definition rules:

A filter is a Boolean expression in the following format: Column1 Operation1 Value1 [boolean_operation1] Column2 Operation2 Value2 [boolean_operation2]]

ColumnN OperationN ValueN [boolean_operationN]

where

Column is a unique name of the object parameter.

68


Operation is a drop-down list box, which contains operators enumerated in the table below.

Table 11 List of operators

Operator Corresponding symbol Explanation

Equal to == The value of the filtered object(s) will be equal to the user-defined value in the Value field.

Not equal to != The value of the filtered object(s) will NOT be equal to the user-defined value in the Value field.

Greater than > The value of the filtered object(s) will be greater than the user-defined value in the Value field.

Less than < The value of the filtered object(s) will be less than the user-defined value in the Value field.

Greater than or equal to >= The value of the filtered object(s) will be greater than or equal to the user-defined value in the Value field.

Less than or equal to <= The value of the filtered object(s) will be less than or equal to the user-defined value in the Value field.

Starts with No symbol The value of the filtered object(s) will start with the user-defined value in the Value field.

Ends with No symbol The value of the filtered object(s) will end with the user-defined value in the Value field.

Contains No symbol The value of the filtered object(s) will contain the user-defined value in the Value field.

Not start with No symbol The value of the filtered

69


object(s) will NOT start with the user-defined value in the Value field.

Not end with No symbol The value of the filtered object(s) will NOT end with the user-defined value in the Value field.

Not contain No symbol The value of the filtered object(s) will NOT contain the user-defined value in the Value field.

MaskInCond No symbol MaskInCond as the operator assumes that the Value field will contain a user-defined regular expression as a filtering condition, i.e. the data in the respective column(s) of the Object View will have to match the provided regular expression.

MaskInField No symbol MaskInField as the operator assumes that the Value field will contain a user-defined string of numeric characters as a filtering condition, i.e. the regular expressions in the respective column(s) of the Object View will have to match the provided string of numeric characters.

Value is an arbitrary character string.

Boolean_operation is either AND or OR.

AND and OR are logical operators introduced to combine two or more filtering conditions. Choose one of the operators from the ‘Clause’ combo box.

AND – makes the filter show the data meeting all the filtering conditions in the specified combination;

OR – makes the filter show the data meeting at least one of the specified filtering conditions;

See the screenshot below for an example:

70


Figure 53 Filter dialog box

In the example shown in the screenshot above the user specified three filtering conditions: IP address, parameter ‘acct enable’ and parameter ‘codec allow’. The logical operator ‘AND’ was used to combine the conditions. Therefore the data returned by the filter will match all the conditions provided by the user.

The description of the Filter dialog box elements is given below:

is a filter definition field that consists of:

• Column - the name of the column to filter.

• Operation - the operator to use in filtering.

• Value - a user-defined string to filter by.

• Clause - AND or OR operator to combine conditions. Please note that the Clause field of the last filtering condition is ignored.

is a list of all visible columns of the Object View, which are not currently included in the filter.

moves the selected column(s) from to i.e. includes them into the filter.

moves all the columns from to , i.e. includes all columns into the filter.

71


moves the selected columns back from to , i.e. removes them from the filter.

moves all the columns back from to , i.e. empties the filter.

Working with the Filter dialog box:

• To move a column from one list to the other, double-click the column, or select a column and click or , or just drag-and-drop a column.

• To move several columns, click them one by one holding down the Ctrl key then click or . To move a contiguous set of columns, click the first column then click the last one holding down the Shift key.

• To include all available columns into the filter, click . To empty the filter, click .

• To set the parameters (Operation, Value or Clause) of a filtering condition select it and click the mouse under the appropriate parameter. This will display an edit box or a combo box for setting/modifying these parameters.

• You can drag-and-drop the filtering conditions within the field.

4.4.6 COLUMNS DIALOG BOX The Columns dialog box allows adding, removing and arranging the columns displayed in the Object View. Use F9, or the Columns command from the drop-down menu to invoke this dialog box.

72


Figure 54 Columns dialog box

The description of the Columns dialog box elements is given below:

is a list of the displayed columns and their width.

is a list of the columns that are not currently displayed but can be added to the Object View.

moves the selected column(s) from to , i.e. makes the column(s) visible in the Object View.

moves all the columns from to , i.e. makes the MVTS Manager display all the available columns.

moves the selected column(s) from to , i.e. prevents the columns from being displayed. Note that the

Identifier column cannot be removed and is always present in the Object View.

moves all the columns except Identifier back from to .

Working with the Columns dialog box:

• To move a column from one list to the other, double-click the column, or select it and click or , or drag-and-drop the column.

• To move several columns, click them one by one holding down the Ctrl key. To select several contiguous columns, click the first column then click the last one holding down the Shift key.

73


• To display all available columns in the Object View, click . To display the Identifier column only, click .

• To change the width of a particular column in , select it and click the Width field (where the current width value is shown). This will bring up an edit box where the column width can be modified.

• Use drag-and-drop to move a column or several ones within .

4.4.7 FIND TEXT DIALOG BOX The Find text dialog box (see Fig. 56) offers an interface for searching the contents of a textual window. Use CTRL+F or the Find command on the Edit toolbar to invoke this dialog box.

Please mind that it is impossible to invoke a Find Text dialog box without an active textual window.

Figure 55 Find Text dialog box

The description of the Find Text dialog box elements is given below:

is an edit field for the search string. The search starts from the current position of the cursor.

is a check box, which enables/disables the search on the whole-word match principle. For example, if you enter "note" as the search string the search will not return the word "notebook".

is a check box which makes your search case sensitive. For example, if you enter "Sample" as the search string, the word "sample" will not be returned.

- click this button to go to the next occurrence of the search string.


Notes:

• The Find Text dialog box is not a modal one; you can continue working with the manager and keep the dialog box in the foreground.

74


• Only one instance of the Find text dialog box can be invoked at a time. It is not possible to carry out multiple searches even in different textual windows.

4.4.8 REPLACE TEXT DIALOG BOX The Replace Text dialog box allows searching the content of a textual window for a given string and replacing it with some other string. Use the Replace command on the Edit toolbar to invoke this dialog box.

Please mind that it is impossible to invoke a Replace Text dialog box without an active textual window.

Figure 56 Replace Text dialog box

The description of the Replace Text dialog box elements is given below:

is an edit field for your search string.

is an edit field for the replacement string.

is a check box, which enables/disables the search on the whole-word match principle. For example, if you enter "note" as the search string the search will not return the word "notebook".

is a check box which makes your search case sensitive. For example, if you enter "Sample" as the search string, the word "sample" will not be found.

- click this button to go to the next occurrence of the search string. The search starts from the current position of the cursor. No replacement is made if the ‘Replace’ field is empty.

- click this button to find the next occurrence of the search string and replace it. The search starts from the current position of the cursor.

click this button to find and replace all occurrences of the search string in the current textual window.


75


Notes:

• The Replace Text dialog box is not modal; you can continue working with the MVTS Manager and keep this dialog box in the foreground.

• Only one instance of the Replace dialog box can be opened at a time, so it is not possible to carry out multiple simultaneous replacement actions even in different textual windows.

4.4.9 ABOUT MVTS MANAGER DIALOG BOX • The About MVTS Manager dialog box displays the MVTS GUI

version and copyright information. Use the About MVTS Manager command from the ? menu to invoke this dialog box.

Figure 57 About MVTS Manager dialog box


is a checkbox that enables/disables pop up of this dialog box at every MVTS GUI startup. This checkbox is identical to the "Show about dialog on startup" item in the Interface options.


76

MVTS Manager Configuration Options

5 MVTS GUI CONFIGURATION OPTIONS The MVTS GUI is a flexible tool, which offers you an extensive set of configuration options. Configuration is accomplished with the help of the Options dialog box, which includes the following tab sheets:

• General

• Data

• Interface

• Appearance

• Graph settings

• Miscellaneous.

To bring up the Options dialog box choose the "Options..." command from the File menu or use the toolbar button.

5.1 GENERAL OPTIONS This is the General tab sheet of the MVTS GUI Options dialog box:

Figure 58 General Tab of the MVTS GUI Options dialog box

The description of the Tab sheet elements is given below:

77


is a combo box, which allows choosing the MVTS server agent that will be selected automatically in the Logon To MVTS Server dialog box at the start of the MVTS Manager.

is a checkbox, which enables work with configuration files stored locally on your computer; therefore no connection with the MVTS server agent will be established.

is an edit field, which allows you to specify a timeout period (in seconds) for an MVTS server agent to carry out a remote command received from the MVTS GUI. Failure to carry out the command within the specified timeframe testifies to the MVTS server agent malfunctioning.

Entering a zero value in this edit field you grant an MVTS server agent an infinite period of time to carry out the remote command.

is an edit field that allows a user to specify a timeout period in seconds, during which the MVTS GUI waits for the MVTS server agent to start. If the server agent does not respond before the specified timeout expiration, it is considered that the server agent hanged during the startup or a network error occurred. Make another attempt to connect to the MVTS server agent.

Entering a zero value in this field allows an infinite startup timeout.

is an edit field that allows a user to specify a timeout period in seconds, during which the MVTS GUI waits for the MVTS server agent to shut down. If the server agent does not respond before the specified period expires, it is considered that the server hanged during the shutdown or some network error occurred. Make another attempt to disconnect from the MVTS server agent.

Entering a zero value in this field allows an infinite shutdown timeout period.

is an edit field, which enables user to set a time interval between two consecutive automatic statistics updates received from the MVTS server agent.

Entering a zero value in this field prevents automatic statistics collection.

is an edit field, which allows user to define a time interval between two successive inquiries (made by the MVTS GUI) after call statistics.

Entering a zero value in this field prevents automatic inquiries after call statistics.

Note: the settings of , , , , are meaningful only when the

check box is unchecked.

78


is a check box that allows selecting the information detail level of runtime journals (logs) that the MVTS GUI writes. These runtime event logs are compulsory for troubleshooting and debugging.

Entering a zero value in this field disables log keeping. The default value is zero.

is a check box, which allows you to save the login and password for connection to the MVTS so that you do not have to re-enter them every time you connect to the server.

Warning! Remember that the system stores the passwords unencrypted, which is insecure.

is a checkbox, which allows you to enable/disable pop-up of the Logon to MVTS Server dialog box when the MVTS GUI is started.

is a checkbox, which enables automatic save of the changes made to the MVTS configuration when a user logs out or closes the MVTS SS application.

is a checkbox, which allows saving the configuration data received from the MVTS server agent to the directory specified in the "Data" tab sheet.

is a check box to allow/disallow hiding insignificant MVTS configuration parameters and displaying only those absolutely indispensable for satisfactory MVTS operation.

is a check box that allows you to carry out a performance check of the remote host before establishing a connection with it.

5.2 DATA OPTIONS The description of the Tab sheet elements is given below:

79


Figure 59 Data Tab of the MVTS GUI Options dialog box

is an edit field, which allows specification of the directory to store the configuration data files received from the MVTS server agent.

, , , , are edit fields, which allow you to modify or completely change the names of the corresponding MVTS configuration files. Situations that might compel you to do so are hard to imagine but not altogether improbable.

5.3 INTERFACE OPTIONS The description of the Interface tab sheet elements is given below:

80


Figure 60 Interface Tab of the MVTS GUI Options dialog box

is a combo box, which allows you to select a language for the MVTS GUI interface. Currently, the MVTS GUI supports only the English and the Russian languages.

is a check box, which enables pop-up of the About MVTS Manager dialog box at every start of the MVTS GUI.

is a check box that allows the MVTS GUI to minimize itself into the system tray instead of the taskbar.

is a check box to make the MVTS GUI save its window size and position on shutdown and restore them on startup.

is a checkbox, which allows the MVTS GUI to save the size and position settings of MDI windows and use these settings after restart of the application.

is a check box which serves to allow/disallow the MVTS GUI to maximize all newly created MDI windows.

is a check box, which allows to user to define and save the width of columns in the Object View. At the next start the MVTS GUI will display the columns with the width defined during last session.

is a check box, which makes the MVTS GUI display the error messages in form of dialog boxes (when checked) or in the Status bar (when unchecked).

81


5.4 APPEARANCE OPTIONS The description of the elements of this Tab sheet is given below:

Figure 61 Appearance Tab of the MVTS GUI Options dialog box

is a combo box containing two options: ‘Show item code’ and ‘Show item name’.

The ‘show item code’ option displays the headers of the columns in the Object View as well as the parameters in dialog boxes in the format similar to that of the MVTS configuration files (see Fig. 63). This feature may be useful for system administrators familiar with the MVTS configuration parameters.

The ‘show item name’ option displays the headers of the columns in the Object View as well as the parameters in dialog boxes in common text format (see Fig. 64).

82


Figure 62 Show item code option at work

83


Figure 63 Show item name option at work

is a set of edit fields, which allow user to specify the width and/or the height of the Item Properties dialog box as well as the position (offset) of the divider in it, i.e. the width of the first column. The minimum values for the width and height are 200, while the minimum divider offset is 100 units.

is a set of edit fields intended to specify the width and the height of the Value List dialog box. The minimum values for the width and height are 170 units.

is a checkbox that enables the MVTS GUI to save the size of the Item Properties and Value List dialog boxes. If it is not checked, the dialog boxes will always be sized in accordance with the settings specified in and .

Note: All sizes are presented in the so-called "dialog units". One dialog unit width is equal to the average width of the system font characters (in pixels) divided by 4. One dialog unit height is equal to the height of the system font characters (in pixels) divided by 8. Therefore, these values are not fixed, and the size of a "dialog unit" varies with the font size setting in your system.

84


5.5 GRAPH SETTINGS The description of the Graph Settings tab sheet elements is given below:

Figure 64 Graph Settings Tab of the MVTS GUI Options dialog box

is a set of check boxes, which allow you to select the number, type and appearance of the curves drawn in the graph area.

• is a check box that allows you to fill the under-curve area with the curve color. Remember that this setting is applicable only to single-curve graphs.

• is a check box, which makes the MVTS GUI curve plotter display the average number of calls in five minutes in the graphical form.

• is a check box, which serves to make the plotter display all calls on the graph.

You can have both the curves (one showing all active calls and the other – the calls five-minute average) plotted simultaneously on the same graph.

contains a set of check boxes and edit fields that allow you to configure parameters of work with statistical data.

• is a check box that allows you to save statistical data to the directory specified in .

• is a check box, which enables user to get graphs for a certain period of time, specified in .

85


• is an edit field, which serves to specify or modify the format of the time axis.

• is an edit box, which allows you to specify the number of points to be output to the screen when dealing with large graphs that can not be shown at once and have to be divided.

5.6 MISCELLANEOUS Below is the Miscellaneous tab sheet of the MVTS GUI Options dialog box:

Figure 65 Miscellaneous Tab of the MVTS GUI Options dialog box

is a group of settings including:

• - a checkbox that serves to enable/disable SNMP traps

• - a check box that allows saving a trap journal to a file

• - a check box, which allows you to set automatic updates for SNMP traps displayed in the Object View.

• - a combo box serving to define the trap information detail level

• is an edit field to specify a filename where trap messages will be written.

section contains the edit field, which serves to specify the number of the latest CDR displayed in the Object View.

86

Configuring MVTS Server

6 WORKING WITH THE MVTS GUI

6.1 REGISTERING A NEW MVTS SERVER AGENT IN THE MVTS GUI To register a new MVTS server agent follow the instructions below:

• Select the Create server command from the Session menu, or click on the Session toolbar. This will pop up the MVTS Server

Connection Options: New dialog box.

Figure 66 MVTS Server Connection Options: New dialog box

• Fill in the fields of this dialog box. See Starting the MVTS GUI to view the description of the dialog box fields.

• Click

6.2 LOGGING ON TO THE MVTS SERVER AGENT To logon to the MVTS server agent:

• Register the server agent with the MVTS GUI is it has not been registered yet (see Registering a New MVTS Server Agent in the MVTS GUI)

• Choose Connect from the Session menu or click on the Session toolbar, or press F5 to bring up the Logon to MVTS Server dialog box.

• Select the server you want to connect to.

87


• Enter your log-on credentials into the User ID and Password fields. If you are unwilling to enter the log-on information every time you connect to this server, check the Remember password check box. Remember that your User ID and Password will be stored in clear text, which is insecure.

• Click

6.3 WORKING WITH OBJECTS

6.3.1 WORKING WITH OBJECTS The MVTS server agent can be treated as a set of objects, each possessing an individual set of properties. The principal object is the MVTS itself, with all other objects falling under the following categories:

• MVTS server

• User accounts - Admin

- Support

- Billing

• Configuration - Gatekeepers

- Gateways

- Dialpeers

- RAS Users

• Server statistics - Originators

- Terminators

- Gateways

- Dialpeers

• Runtime information - Gatekeepers

- Endpoints

- Active calls

- Directions load

- SNMP traps

- CDR

88


Some objects are a part of the MVTS configuration, while other objects are generated in real time and can only be viewed but not modified (such as active calls).

The objects within each category can be grouped into folders. Such categorization is for users’ convenience only, as the MVTS does not recognize folders. The only exception is the built-in folders under the User accounts category. Refer to Organizing Objects by Folders for more information

The category-and-folder structure is displayed in the Object Tree. When you click a category or its subfolder in the Object Tree, the objects contained in it are displayed in the Object View.

The Object View offers you a variety of ways to customize the visual representation of the objects. You can choose the columns to be included in the view, the position of the displayed items and the items to be present in the view (i.e. filter out the unneeded items). For more information refer to the description of the Columns dialog box, Sort dialog box, and Filter dialog box.

Nevertheless, the main purpose of the Object View is to allow the user to add, change and remove objects.

6.3.2 ORGANIZING OBJECTS BY FOLDERS The objects in each category can be grouped into folders. The folders are transparent to the MVTS, so there is no difference in which folder to place a particular object.

Note: The User accounts category has only three predefined subfolders and it is not possible to create, remove or rename the folders in this category.

• To create a new folder open a category you want to be the parent one for the new folder, and use Alt+Ins or the New folder command from the Object menu. Enter the name of the new folder in the appearing dialog box and click “OK”. Note that all names of the folders and subfolders within each category must be unique. The newly created folder will be displayed in the Object View.

• To remove a folder right click it and select “Delete” from the drop-down menu. Note that the information contained in the selected folder will be removed as well.

• To rename a folder, select it and press F2 on the keyboard or choose Edit in the Object menu. Enter the new folder name into the appearing dialog box and click “OK”.

• To move an object into a folder, select the object and drag-and-drop it to the folder of your choice either in the Object View or in the Object Tree. To select several objects, click them holding down the SHIFT key.

6.3.3 SORTING OBJECTS There are two ways to specify a sort order for the objects in the Object View.

89


1. Click the header of a column to enable the ascending sort of the column items. Clicking that header again will sort the items in the descending order. Up arrow and down arrow on the column header indicate the sort order.

The items on the picture below are sorted by the IP address in the ascending order

Figure 67 Sorting Objects in the ascending order To sort data by two ore more columns, click the respective column header while holding down the Ctrl key.

Use the Sort Dialog box for more complex sorting tasks.

6.3.4 ADDING, CHANGING AND REMOVING OBJECTS • To add an object to the Object View select a category you want to

place a new object into and press Ctrl + Ins or select ‘Add’ form the Object menu. This will bring up the Item properties:New dialog box. Fill in the fields of the dialog box and click “Apply”.

• To remove an object, select it and press Ctrl+Del or choose Delete from the Object menu.

• To change the properties of an object, select it and press F2 or choose Edit from the Object menu. This will bring up the Item properties dialog box. Enter new data in the dialog box fields and click ‘Apply’.

6.3.5 PRINTING A LIST OF OBJECTS You can print the contents of the MVTS GUI Object View with the help of the Print command in the File menu or by pressing CTRL+P on the keyboard.

If you need to print only some objects of the Object View, use the filtering feature of the MVTS GUI.

6.4 EDITING DATA The MVTS GUI features two ways of editing the configuration data of the MVTS:

• On-line operation. When working in the online mode, the MVTS GUI connects to the MVTS via the MVTS server agent and all the

90


changes you have made in the configuration are saved on the remote server immediately upon execution of the Save config command. To make the modified configuration effective, carry out the Apply config command. Now the MVTS will be running with the new configuration.

• Off-line operation. In this case the MVTS GUI poses as a local data storage (plain-text files). No actual connection to the MVTS is established. All the settings of the local data storage are located on the Data tab sheet of the Options dialog box. To upload the modified configuration to the MVTS server carry out the Upload config command.

91


7 CONFIGURING MVTS

7.1 STARTING, STOPPING AND RESTARTING THE MVTS Before configuring the MVTS you should start it. To start the MVTS go through the following steps:

• Logon to the MVTS server agent as described in the Logging On To the MVTS Server Agent section. Note that the Local checkbox of the log-on dialog box must not be checked.

• Choose Startup from the Session menu or click on the Session toolbar.

To stop the MVTS, choose Shutdown from the Session menu or click on the Session toolbar.

To restart the MVTS, stop it and then start it again.

7.2 CONFIGURING MVTS The MVTS stores its configuration settings in several configuration files found in the cfg subdirectory of its root directory. However, you do not have to deal with these files directly, since the MVTS GUI offers you a user-friendly interface for setting or editing all the configuration parameters of the MVTS.

The common MVTS configuration procedure includes the following steps:

• Log on to the MVTS server agent you wish to configure as described in the Logging On To the MVTS Server Agent section. Note that your User ID must belong to the Admin group.

• Enter the edit mode by choosing Edit config on the Session menu or by clicking on the Session toolbar. This mode allows locking all the configuration files so that no one else could modify the MVTS configuration at the same time. Therefore, two administrators can not enter the edit mode simultaneously.

• Make all necessary changes in the server configuration.

• To save the changes made choose Save config from the Session menu or click on the Session toolbar (by doing so you also leave the edit

mode). Choose Apply config from the Session menu or click on the Session toolbar to make the MVTS read the modified configuration (clicking the Apply config button has the same effect as the 'reload config' command run at the command prompt of the MVTS Administration console).

92


• To discard the changes, choose Cancel edit from the Session menu or click on the Session toolbar. This command also leaves the edit mode.

Note: The detailed description of all the configuration parameters is given in [2].

7.3 SETTING PRIMARY OPTIONS Setting MVTS primary options involves:

• Entering the edit mode as described in Configuring MVTS section.

• Choosing Properties from the Session menu or clicking on the Session toolbar to bring up the MVTS Server properties dialog box. See Item Properties dialog box.

• Setting all the necessary parameters in the Item Properties dialog box.

• Leave the edit mode as described in Configuring MVTS section.

7.4 CONFIGURING RAS USERS RAS users are VoIP entities (i.e. softphones, IP phones etc.) registered with the MVTS under the RAS protocol. The information about such RAS-registering objects is stored in the user.cfg configuration file.

To configure a RAS user select RAS users in the Object Tree:

Figure 68 Configuring RAS Users

93


Double-click a RAS user record in the Object View to edit it. To add a new RAS-user record right-click the mouse in the Object View and select Add from the pop-up menu,

Figure 69 Adding a new RAS User

7.5 CONFIGURING GATEWAYS A gateway is a VoIP entity with a static IP address. The gateway records are stored in sections of the gateway.cfg configuration file.

94


Figure 70 Configuring Gateways

To configure a gateway select Gateways in the Object Tree then double-click the gateway (whose configuration you wish to edit) in the Object View.

To add a gateway record right-click the mouse in the Object View and choose Add from the pop-up menu.

7.6 CONFIGURING GATEKEEPERS To configure a gatekeeper select Gatekeepers in the Object

Tree:

Figure 71 Configuring gatekeepers Double-click the gatekeeper (whose configuration you wish to edit) in the Object View.

Right-click the mouse in the Object View and choose Add from the pop-up menu to invoke the Properties: New dialog box and enter new gatekeeper data.

95


Figure 72 Adding a new gatekeeper

7.7 CONFIGURING DIAL PEERS A dial peer is an addressable call endpoint. Information about dial peers is stored in the dialpeer.cfg configuration file.

To configure a dial peer select Dialpeers in the Object Tree, then double-click the dial peer (whose configuration you wish to edit) in the Object View. To add a dial peer right-click the mouse in the Object View and choose ‘Add’ from the popup menu.

96


Figure 73 Configuring Dialpeers

97

Appendix A

APPENDIX A

LIST OF ACRONYMS USED IN THE DOCUMENT

Table 12 List of Acronyms

Application Programming Interface API Call Detail Record CDR Command Line Interface CLI Graphical User Interface GUI Hyper Text Transfer Protocol (world wide web protocol) HTTP Hyper Text Transfer Protocol Secure sockets HTTPS MERA VoIP Transit Softswitch MVTS Registration, Admission, and Status protocol. An H.225 signaling protocol used between endpoints and the gatekeeper to perform management functions. RAS signaling function performs registration, admissions, bandwidth changes, status, and disengage procedures between the VoIP gateway and the gatekeeper.

RAS

Remote Client Controller (MVTS-specific) RCC Management System MS Operating System OS Answer Seizure Ratio ASR Average Call Duration ACD Simple Network Management Protocol SNMP Transport Control Protocol TCP Common Gateway Interface CGI

98

mvts management system

Documents