Version 1.1.0
Users Manual
Copyright(c) 2010 PT Inovao, S.A. All rights reserved. Full or partial reproduction,
copying, translation or conversion to electronic format of this manual is prohibited
without strict written authorization of PT Inovao, S.A.
ArQoS NG is a registered trademark of PT Inovao, SA.
ii
Users Manual
This manual describes the Management System
ArQoS NG.
The access to this application is done via web
browser by invoking the URL where the web
application management system ArQoS NG
resides.
iii
Index of Content
Introduction
Systems purpose
Architecture
Organization
4.1
Login
4.2
4.3
Site Manager - SM
4.4
Resource Manager RM
10
4.4.1
10
4.4.2
Status List
13
4.4.3
Discovery
14
4.4.4
Inserting a probe
15
4.5
Alarm Manager AM
16
4.6
ArQoS
17
4.6.1
Macros
18
4.6.2
Interactive Tests
21
4.6.3
Tests
25
4.6.4
Tests Array
28
4.6.5
Calendar
30
4.6.5.1
Recursive Tests
32
4.6.6
Results
34
4.6.7
Reports
36
38
5.1
38
5.2
38
5.3
39
5.4
39
5.5
40
iv
Q_PDS_DM_006_V1.3
1 Introduction
The purpose of this manual is to describe user application interfaces of Management
System ArQoS NG.
The outline of this manual is:
Architecture
Systems components
o
ArQoS NG component
Q_PDS_DM_006_V1.3
2 Systems purpose
Q_PDS_DM_006_V1.3
3 Architecture
ArQoS NG is a modular, scalable, future-proof solution that can easily adapt to
network or service evolutions.
Figure 1 intends to represent ArQoS NG Management Systems architecture. As
shown below, the System consists of several probes (mobile or fix) and by the
Management System that communicates through a backbone IP. ArQoSs Probes
can have Wireless, PSTN, RDIS and VoIP modules. The Management System
controls ArQoSs probes and allows users to configure tests and generate reports.
Q_PDS_DM_006_V1.3
4 Organization
The Management System ArQoS NG is organized in independent modules that
combined have features to manage/configure/query all systems aspects.
The main modules are:
Site Manager SM
Resource Manager RM
Alarm Manager AM
Configuration Manager CM
ArQoS
4.1
Login
Q_PDS_DM_006_V1.3
After credentials validation, user is presented with a panel of the modules that are
available on the Management System, as presented in the figure below.
The Application Selection Page gives Access to the Management Systems modules.
Logout can be done at this point, otherwise its done automatically when this page is
closed. It is recommended to use the logout button.
All the modules present a quick menu for direct navigation to another module. On the
example below, the selected module is the Site Manager where its possible to
navigate to Resource Manager, Alarm Manager, Access Control System SCA or
ArQoS. If you want to maintain current window opened, navigation must be done
throught Application Selection Page.
Q_PDS_DM_006_V1.3
4.2
Q_PDS_DM_006_V1.3
Description of Access Control Systems - SCA is not covered by this Manual. The
SCA Users Manual is accessible in the Help link of the application SCA and in the
URL http://172.16.48.20/sca/manuals/SCA_MNMU_UserManual_V3.0.pdf
4.3
Site Manager - SM
The purpose of the Site Manager is to create and configure an organizational tree
and hierarchy that supports the arrangement of the resources.
Building this organizational tree must be the first step of the Management Systems
usage.
The following Figure presents one image of the SM with an example of the
organizational tree.
The functions to add and remove entities from the organizational tree are marked in
yellow with arrow 1. It is possible to refresh the tree with the button
. This function
only affects the attached area. On the figure above, the refresh command marked
with arrow 1 refreshes the organizational tree and the one marked with arrow 2
refreshes the main window.
Q_PDS_DM_006_V1.3
Note that the Close button on yellow area 2 only closes current window, not
performing logout from the Management System.
Error! Reference source not found. presents several different entity types that can
define a new element. Element configurations are quite simple, only requiring the
name, code and managed domain. The last parameter, Managed Domain shows a
list of options which are configured usingSCA.
Q_PDS_DM_006_V1.3
4.4
Resource Manager RM
RM is the module to discover, insert and configure ArQoSs Probes. Each probe
must be inserted on the Management System in one single node of the tree that was
previously created on the site manager. By that fact, the general layout of the RM is
quite similar with the SM, but the functionalities and operation are very distinct.
4.4.1
Q_PDS_DM_006_V1.3
Element selection is possible through tree navigation. With an element selected, new
operation tabs are visible where query, management and configuration operations
are performed. Some examples of query, management and configuration menus are
presented on the next figures. These menus depend on the options selected by
users.
10
On area 1 its presented some information about the ArQoS Probe. Some of this
information can be updated/changed by users, while others are merely informative.
The following pictures show different parameters available in different tabs.
Q_PDS_DM_006_V1.3
11
Area 2 shows the operations executable on the ArQoS Probe. In this case, only
Reset is available.
Area 3 shows the modules preset on the ArQoS Probe. This graphical information is
also showed in a tabular view, as we can see in the figure below.
Area 4 shows the operations that can be performed on the managed elements, with
emphasis for element removal.
Q_PDS_DM_006_V1.3
Each ArQoS Probe has its own specific configurations, accessible through the lower
tree, as shown in the next figure.
12
On the Area 1 the modules are selected and on area 2 its specifics parametters are
showed and can be configured. Its important to notice that there are several tabs
that group related parametters. The number and type of tabs depend on the type of
the selected module.
4.4.2
Status List
Q_PDS_DM_006_V1.3
The option List provides access to a list of existing modules with description of it
status. The Figure bellow presents an example. This list has the advantage of quickly
supply a general preview of the operational and administrative status and location of
each module.
13
4.4.3
Discovery
The discovery functionality allows to discover probes by IP. Before inserting one
Probe in the system it must be discovered first.
Q_PDS_DM_006_V1.3
This option receives an IP address of a specific ArQoS Probe and try to istablish
communication with it. Its then possible to register that Probe on the management
System.
14
4.4.4
Inserting a probe
After establishing a connection with the ArQoS Probe and gather some information,
the probe is ready to be inserted and registered in the ArQoS System. Before that,
the user can update information available, if the probe is selected, in the panel.
To insert a probe the user should drag and drop to one node in the tree.
Q_PDS_DM_006_V1.3
15
4.5
Alarm Manager AM
Q_PDS_DM_006_V1.3
The alarm operations toolbar is marked with yellow area 2. Some of these
functionalities imply that at least one alarm must be selected: comment,
acknowledge, unacknowledge, close, view details and send by e-mail. In this area
there is also a text box to perform searches over listed alarm information and a
button to access filter management.
16
4.6
ArQoS
The ArQoS module enables users to create and execute tests, analyze results and
generate reports.
Each test is made of one or more macros. A macro can be defined as a group of
tasks organized in a certain sequence.
Macros and tests are reusable, i.e., after defined they can be used as many times as
needed. The only present restriction is related with the profile of the user that defined
the macro.
The first two phases of ArQoS usage must be macros and test creation. Naturally,
only afterwards its possible to schedule tests, which is simply to define the time
when they are going to be executed.
The final stage is to query and analyze the individual task execution results and to
produce overall reports over this information.
Q_PDS_DM_006_V1.3
17
4.6.1
Macros
Q_PDS_DM_006_V1.3
18
Area 5: list of available tasks. Macros are built over a group of pre-defined
and configurable tasks, listed on this area. Tasks are arranged into the
categories Voice, Data, IP, General and Scripts marked with unique and
distinct colors.
The most important areas for building a macro are the list of tasks, the programmer
and the task properties area. These areas are displayed with more detail on the
figure below.
The grid for building macros is the area where tasks to be executed are placed. The
six lines of the grid, from A to F, represent six potential modules, called virtual
modules, and all the tasks at a line are executed by the same module. At this stage,
no ArQoS Probe Module is specified. With this abstraction level, macros can be
applied later to any module of a Probe, maximizing its reutilization.
Q_PDS_DM_006_V1.3
Tasks arrangement on Timeline is done by simple drag and drop operations from
the tasks list to the desired position. Removing a task on the Timeline is done by
clicking on the option
placed beside the macros name.
Each task has specific properties, showed on the Properties Area, under the
Timeline. These properties must be configured each time a task is used. There are
two properties common to all tasks: the delay of the beginning of the task referred to
the beginning of the macro (by default 0), and the time to end the task, or Timeout,
also referred to the beginning of the task. These two values can be adjusted
graphically, or in a more fine grained way in the properties. Graphically, the
beginning of the test is adjusted by dragging the task on the left side of the task icon.
The termination of the task is adjusted by dragging the right end of the task icon.
19
To simplify the manipulation of the programmer grid, users can zoom in and out the
time scale. It is also possible to adjust these parameters writing directly in the related
text boxes.
Q_PDS_DM_006_V1.3
To facilitate the use of the programming schedule, users can increase or decrease
the time scale of the grid, choosing the appropriate time 'Scale' on the select box that
lies underneath the grid. Its also possible to increase or decrease the work areas,
using the 'handles' of horizontal and vertical separators, as shown in the figure.
The command 'Apply' at the lower right allows the user to save changes to the
macro. However, the system is prepared to ask for confirmation when users try to
perform an action that could result in loss of changes.
20
4.6.2
Interactive Tests
An Interactive Test is a macro that is being tested as it is being created. This way,
users can immediately check whether the tasks used are appropriate and if the
properties are correctly configured. They are commonly used for troubleshooting
operations or immediate verification tests.
The interactive test button that lies at the right bottom allows access to the area of
Interactive Tests.
As shown in the figure below, some of the macro building details remain visible, as
new screens are visible where the execution can be controlled. Mode detains are
described below.
Q_PDS_DM_006_V1.3
One of the requirements needed to run an interactive test is to select which ArQoS
modules will run each line of virtual modules on the programmer. To select desired
modules use tab 'Modules', which shows the ArQoS modules available in the system,
and drag them to the programmer boxes that represent virtual modules from 'A' to 'F'.
Each ArQoS module can only perform the tasks in one virtual module, so they
disappear from the available list as they are assigned to virtual modules. If you want
to remove a module, just drag it to the modules list again or press the option
below.
21
Double clicking on a ArQoS Probe Module on this list opens a window with the RM
module in question selected. This facility allows users to query and/or configure
ArQoS module parameters, in order to better configure the test in question. In case
you need to consult another ArQoS Probe Module, the content of the window of RM
is updated.
Note that the ArQoS Probe Module list may present the following states:
Q_PDS_DM_006_V1.3
As the test is being executed, the user is having the visual representation of
execution state, as exemplified in the following figure.
22
Q_PDS_DM_006_V1.3
Each symbol has a specific meaning and is listed in the following table:
23
Upon execution completed, the user will have access to the tab 'Results', where
result details for each task are presented.
While a test is running, the user can not change the contents of the programmer or
the properties of tasks. Once the execution ends (because it completed all the tasks
or because the user pressed the command 'Stop'), it is possible to change the
programmer, adding or removing tasks in any of the modules 'A' to 'F', or change the
properties of existing tasks. You can choose to continue running the test from the last
work performed or restart the execution.
When satisfied with the outcome, if required, its possible to leave the area of
Interactive Tests and return to the area of macros' configuration, where you can
record a macro with the tested tasks. Thus, the user can ensure that the created
macro will run the way it aims as its configuration was already tested with ArQoS
Probe Modules.
Q_PDS_DM_006_V1.3
Additionally to create a macro, configure it and test it is also possible to select a preexisting macro from the list of macros and run it in the area of Interactive Tests. It is
also possible to make any necessary changes to the configuration of the macro until
the result is satisfactory. The only caveat here is that if the macro is tested for use in
a test (described below), its not possible to save the modifications with the same
name, and a new macro must be created.
24
4.6.3
Tests
The next step is to create tests that use the previously created macros. A test can
only use a single macro, or may consist of several macros and/or repetitions of the
same macro. Thus it is possible to quickly create tests of considerable complexity.
The figure below shows an example of a test screen.
The elements of this screen are quite similar to the ones on the Macro screen.
The area marked with 1 contains the commands that can be performed on the tests,
including create, remove and duplicate tests as well as searching for specific tests.
The test list displays all existing tests that the user has access to. Note that the
checkbox only serves to select one or more tests for removal.
Area 2 is the test programmer. At the bottom of the programming grid areas the user
has text box in order to assigns a name to the test (this name must be unique). User
can also configure the public scope if he has the proper permissions. The is also an
option to controls the time scale of the programming schedule. The test name should
be unique.
Q_PDS_DM_006_V1.3
In Area 3, on the right, is the list of available macros for creating tests. Macros are
classified according to its scope, public or private, the user can choose to view only
the private macros, only public macros, or both selecting the two buttons located on
top of the list.
25
By double click a macro in this list it opens the Macros window, which allows the user
to see the composition of the macro in question. If this window is already opened,
double clicking on another macro replaces the information presented.
The areas 2 and 3 are only active when the user selects the command to create a
new test ( ) or selects a test from the list of existing tests. The same applies to the
tab 'Creation of Tests Array', which is described in following sections.
To configure a test is mandatory identifying the macros that constitute it and its
configuration: sequential, simultaneous or mixed (as is the case represented in the
previous figure). In addition, for each macro is necessary to specify the ArQoS
modules that will occupy the positions of virtual modules.
The following figure shows an example of configuring a test.
The indication of the macros that are part of a test is done by dragging the selected
macro to the scheduler tests grid. Macros placed in the same row will be executed
sequentially. Macros placed in different rows can be performed simultaneously, if
their moment of execution overlap, or sequentially, if not. It is not mandatory that the
programmer macros are unique. Users can repeat the same macro as many times as
intended so.
The programmer area can be controlled by hiding or adjusting the areas in the left
and below, through the 'handles' in the middle of the existing vertical and horizontal
tabs, as shown in previous figure.
To remove macros from the programmer select the macro and then press the
removal command ( ) that lies at the bottom of the grid.
Q_PDS_DM_006_V1.3
After being placed on the scheduler grid, Macros immediately will present a yellow
warning symbol, meaning that something is not right.
26
Typically, the correction of this state is to select the macro in question and then, in
the lower area for allocation of ArQoS modules, drag to each of box the appropriate
modules. Unlike what happens in the configuration of Interactive Tests, here are only
shown the cases of virtual modules that are really necessary. You must fill all the
boxes with ArQoS Probe Modules. This process has to be executed for all the
programmer macros. As already happens in interactive tests, you can only assign
one ArQoS module to each virtual box module. However, it is possible to repeat
ArQoS modules in macros that are executed at different moments in time.
The error indicated in the table above may also occur if two macros share the same
module that is being used at the same time. This may happen, for instance, when
two macros that already have all the ArQoS Probe Modules allocated are moved in
the programming grid to a position where their executions time overlaps. In this case
the modules in conflict should be changed, or the macros moved to positions that do
not overlap.
As already happens in the Interactive Tests, a double-click in the list of ArQoS Probe
Modules provides access to a window positioned at the RM module. A double-click
on other Probe Modules from the list simply updates the information in the RM
window, no more windows are opened.
Q_PDS_DM_006_V1.3
Changes to a test are only complete if the user saves it, by using the 'Apply' button at
the right bottom. However, no changes can be recorded to a test that is being used
on a scheduled test (described below). In that case it can be saved as a new test.
27
4.6.4
Tests Array
The test screen is complemented by the tabulator Creation Matrix Test' that lies
behind the list of available tests. In this area the user can quickly configure a new test
by automatically combining existing modules and macros.
This area is only active after creating a test ( ) or after the selecting a test from the
list of tests. The following figure presents an example of usage of the Creation of
Tests Array.
Its use is fairly simple and straightforward: user chooses the macros he wants to use
in the test from the list of macros that appears at the top. It then indicates which
ArQoS modules should be involved in this test.
Q_PDS_DM_006_V1.3
User must also indicate the type of matrix of tests to create: a new matrix, by adding
at the end of an existing test (which may or may not have been created through a
Tests Array) or by inserting the array of tests to create in the middle of a test that
already exists. In the latter case, the macros that might be affected are 'pushed'
forward in the timeline of the test. Besides this option, the user must specify a
maximum limit time for the test set, i.e., the test will have a total duration not longer
than the value indicated. It is also possible to state whether the array of tests to
create can or cannot contain repetitions.
Finally, the command 'Create Automatic Matrix' generates an array using the
selected macros and modules.
28
One advantage of creating Matrix-Test is the possibility to edit Macros in the built
test, adding macros manually, or removing and/or modifying the layout of the macros
automatically generated. Furthermore, it is also possible to use an existing test and
complement them with one or more array tests.
Q_PDS_DM_006_V1.3
Editing ArQoS Probe Modules assigned to each macro on the Programmer Testing
Grid is done in the same manner as described in the previous paragraph: just select
the macro in question, query or change its values in the lower area of modules
assignment.
29
4.6.5
Calendar
After Test setup, its now possible to schedule it. This operation is done on-screen
Calendar, as exemplified in the following figure. A schedule is, by definition, a test
with date and time assigned for execution.
Q_PDS_DM_006_V1.3
It can also happen that in the calendar there are some underlined days, and when
selecting that day no test appears on the programmer. This means that existing
schedules belong from another user and, but the current user has no permissions to
query the type of activity. In those cases, a marked day still represents that there is
or was scheduled activity for that day.
A feature of the programmer is that it automatically positions the line with the
schedule that is being consulted, with no need for the user to drag the horizontal
scroll to find the schedule for that day.
30
The programmer is used for adding, removing and putting tests asleep. For each new
test a new line is added on the programmer.
The area marked with 3 displays the list of tests that are available for creating
schedules. Tests can be public or private and it's possible to filter only private or
public by using the commands above the list. You can also open a specific test by
double-clicking on it. A new window will be opened with the Tests screen and the
details on the selected test.
The Area 4 allows users to configure rules for a more detailed schedule. This area
will be described in greater detail next.
Creating a schedule is made by drag a drop a test to the grid of the programmer, as
exemplified in the next window.
Its only possible to drag a test for an empty row of the programmer. If you need to
create more lines, use the command
to create them and then drag the test to test
the grid. To remove a schedule, select the unwanted test and press the button .
Q_PDS_DM_006_V1.3
Each schedule can be configured in more detail in Area 4 as shown in the following
figure. This area can be increased for better presentation, using the 'handles' that
appear in the middle of the horizontal tab, as shown in the figure.
31
When setting a schedule, the system suggests a name attribute. Its recommended to
use a name that has a concrete meaning and easy of reading in the programmers
scale.
The user can define more precisely the date of beginning of the schedule, either by
editing the date and time, by selection on the calendar that appears aside, or by
choosing 'Schedule Now', which means that the schedule will start immediately after
pressing the button Apply.
Furthermore, users have the possibility to consult the modules that will run the test.
Its also possible to double click on an ArQoS module in the displayed list to go to the
RM and easily check the configurations of the module.
4.6.5.1 Recursive Tests
Q_PDS_DM_006_V1.3
One possibility that users have is to define rules to repeat schedules. In this case, the
schedule shall be classified as recursive. There are several rules of recursion that
are almost self-explanatory. Tests can be scheduled consecutively or periodically. In
this case, the frequency can be supplied in hours, days, weeks or months. The user
must also indicate how to cease scheduling cycle: after a certain number of
occurrences or after a specific date and time. The button 'Preview recursive test'
allows users to view the schedule in the recursive programming schedule.
The recursive schedules can be expanded or compressed through the commands
and
to show or condense tests area. These buttons are only available for
recursive schedules. The following figure shows an example of expanding a
recursive scheduling. Darker blue areas indicate the times when the tests are
actually being executed.
32
The classification of recursive scheduling only serves to help the user to create
repetitive schedules of tests according to a given rule. It has no influence on the
performance of a test nor is reflected in the presentation of results, where all
schedules are individual and schedule resources are shown in multiple individual
schedules.
To conclude, the schedule must be saved before navigating to another area. Users
are notified if trying to run a command that involves the potential loss of unsaved
settings.
The programming grid has several graphic symbols that help to reflect the current
state of a schedule: saved, running, running with error or success, etc. The following
table lists the multiple states and their meaning.
Q_PDS_DM_006_V1.3
33
4.6.6
Results
The results screen enables users to see Test Results, query details of each
performed task and, whenever possible, the related CDRs. The following figure
shows a possible results screen.
Q_PDS_DM_006_V1.3
Area 1: List of performed tests and overall status. This list is paged, and, by
default, ordered chronologically, from the most recent to the oldest test. This
list is provided with search engines. You can choose to filter only failed tests,
using the 'See only alerts'.
Area 2: List of macros executed on the test. Information in this list depends on
the test user selected in the previous list. Similar to the previous list, you can
also search the list and choose to see only macros that have not gone well.
Note that in the shown example, there are two macros with the same name.
This only means that the test was composed of two equal macros..
Area 3: lists tasks performed by the macro selected in the previous area.
Here too its possibility to search and filter only the results with errors.
Area 4: This area can be subdivided into two parts: test summary and
additional information of the macro. The test summary is only displayed when
users select a test that will ascertain the number of tasks of the test and how
many were planned and executed successfully or with error. Additional
information of the macro is shown only when users select a macro, showing
which ArQoS modules were chosen for the macro in question
34
Area 5: This area contains three types of information: CDRs associated with
the macro selected, detailed information about the outcome of the selected
task and information about the properties of the task that was performed. The
following figure shows some examples of this information.
Q_PDS_DM_006_V1.3
As can be seen in the examples, tests, macros and tasks are accompanied by
symbols that represent their states. The following table decodes its meaning.
35
4.6.7
Reports
This module allows extracting reports on tests results. The following figure shows an
example of use.
Figure 33 - Reports
In Area 1 users select the report type. In Area 2 filtering conditions can be specified
and its also possible to exports obtained results to a worksheet.
The bottom area may be increased by using the 'handle' that is in the middle of the
page, this way showing or hiding Area 1.
Information presented in the report is in accordance to the filtering options. These
conditions are additive, i.e., using the example of the previous figure, the results
obtained correspond to the period between 9:00 oclock on day 01/28/2010 and
12:59 from the same day, and which have been obtained by the test MOC probes
'2'and executed by the module' Peak: May: MC8775V: P ...', etc.. Only after selecting
the command 'Search' is being produced the report. If no results conform to these
conditions, the user will be informed.
Q_PDS_DM_006_V1.3
The following figure shows the window when a user access 'Options' command.
36
Q_PDS_DM_006_V1.3
For each report set, users can select the fields he wants to be presented. Also the
presentation order filed and the ordering criteria (ascending/descending) can be
selected in the same window. The number of results per page is also configurable.
Notice that too many results per page may appear slow in loading the data. Changes
take effect only after pressing the command 'Search' again.
37
Identification: When trying to access the system, at the login page, the message
"Credentials Invalid!" is always returned.
5.2
Q_PDS_DM_006_V1.3
Characterization: This error can occur after an upgrade or reboot of the server.
Solution: Clean the browser cache and try again. If the problem persists, contact
your system administrator or manager.
38
5.3
Identification: When trying to close a module (ArQoS, RM or SM) with the button
'Close' the window does not close and you can not do anything else.
Characterization: This problem may occur if there is any idle time of application.
In this case, the user session ends and your browser cease communicating with
the server where the application resides. No more pressed commands will
execute.
5.4
Q_PDS_DM_006_V1.3
Identification: I created an interactive test but when trying to run it I always get a
message reporting that the physical module is not specified.
Characterization: This problem may occur if use tasks that provide links to other
virtual modules and dont identify no physical module for these virtual modules. For
example, the task only uses the module A to make and end a call, but the task of
making call indicates that the destination is the module B. If you do not indicate any
physical module in B, you will get this error.
39
Solution: Check the configuration of tasks and make sure that all the modules listed
in the task (A, B, C, D, E or F) have physical modules mapped.
5.5
Identification: When trying to read a test the browser reports an error message on
the script.
Characterization: This message occurs whenever the server application is taking
too long. This typically happens at reading tests with many macros or at creating an
array of tests that involve many modules and/or macros.
Q_PDS_DM_006_V1.3
Solution: Select 'Continue' for the read request until its completed. Depending on
the complexity of the test, it may happen to receive this message several times.
40