Tariscope 4.5.x. Administrator's guide

Chapter 4  Tariscope configuration

4.20 Dashboard configuration

Tariscope 4.5 contains a dashboard that allows you to monitor current information about calls, services, subscribers, and others. Now the Tariscope dashboard includes 22 widget types that allows you to create hundreds different widgets. You can choose any combination of the widgets for your dashboard.

The dashboard is the first page that appears after you log in. An example of the page is shown in Figure 4.20.1.

Figure 4.20.1

The default dashboard contains only one widget. This is Information about Tariscope that displays the valid date, support date, Tariscope version, and version that is available on the Tariscope site. You cannot change or delete this widget.

You can open the dashboard at any moment if you click on the Dashboard item of the menu.

To do any actions with the dashboard, click on the sign of three dots after the Tariscope dashboard title. The menu appears that contains the following items:

• Add widget. Allows you to add a new widget to the dashboard.
• Settings. Allows you to configure the dashboard settings.
• Widget access. Allows you to set access to widgets for users.
• Refresh all widgets. Allows to refresh the widgets.
• Go full screen. Allows you to expand the dashboard on the full screen.

4.20.1 Adding a widget

Open the menu as it is described above and click on the Add widget item. The page will be as shown in Figure 4.20.2.

Figure 4.20.2

Open the Available widgets list. It contains the following items:

• 3CX – active calls. The widget is relevant only for 3CX users. It displays the number of current active calls and number of maximum available simultaneous calls according to 3CX license.
• Abnormal subscribers. The widget displays statistics on subscribers whose services are abnormal according to the Tariscope Payment Forecast service. If you do not use this service, it makes no sense to use the widget.
• Balance statistics. This widget can be applied by telecom service provides who use the Tariscope Provider edition. It displays the beginning balance for the current month, sum of charged services on the current day, sum of payments from customers for the current month, and current day balance.
• Call statistics. It is a graph of call traffic. The Tariscope administrator can configure a graph period, traffic type (from a communication node, PBX, department, or subscriber), call direction (all directions, incoming, outgoing, internal, or transit). It is possible to simultaneously display data on two elements of the same type.
• Current date and time. Displays the current date and time.
• Current version of Tariscope. Displays the latest version number of Tariscope, which is available on the Tariscope site, and version number of Tariscope that you use.
• Database information. It displays the server name, database size, log file size, and Tariscope database version.
• Database size. If you use Microsoft SQL Server Express edition, it has a restriction on the database size. In this case the widget is useful to control the database size. It displays the percentage of available database volume.
• Latest news article. Displays an announce of the latest article on the Tariscope site.
• License usage. The widget displays the percentage of the Tariscope license usage.
• Missed call statistics. The widget displays statistics on the missed calls.
• Notes. The widget allows you to create notes that will be displayed on the dashboard.
• Observers status. The widget displays statuses of the Tariscope Observer services.
• Request to database. The widget allows you to create a query to the Tariscope database to get any data and display them in the widget using HTML tags.
• Resource usage. The widget displays a usage of the server resources by Tariscope.
• Tariscope task status. Displays a task list of Tariscope Tasks for today and yesterday. The list contains a task name, time when task must be executed, and execution status.

In the Available widgets list, select the desired widget. It appears in the box below as it is shown in Figure 20.3.

Figure 20.3

Select the widget and drag and drop it on the dashboard. The page will be as shown in Figure 20.4.

Figure 20.4

To save these changes on the dashboard, click on the click here link. To cancel the changes, click on the cancel changes link. To close widgets selection, click on the Close button.

Let us consider widget types in more detail.

3CX active calls

The widget is intended to 3CX users who wish to monitor information about active calls. There are two views of the widget: the detailed view and simplified one. The examples of these views are shown in Figure 20.5 and 20.6.

Figure 20.5

Figure 20.6

The widget shows a number of the current active calls in 3CX Phone System and number of maximum calls that can be made.

Before you will configure the widget, you should configure Tariscope to monitor active calls.

To set up settings of the widget, double click on it and in the appeared menu, select the Configuration item. The Widget configuration window appears as shown in Figure 20.7.

Figure 20.7

In the Equipment ID text box, enter an identifier (ID) of the 3CX Phone System in the Tariscope system. You can find it on the Equipment page. To go to this page, select in the menu: Communication nodes → your node → Equipment → Equipment management.

In the Widget type list, select the desired type of the widget. There are two options:

• Detailed.
• Simplified.

Click on the Save button to keep settings.

Balance statistics

The widget can be applied by telecom service providers. It allows you to monitor the value of services provided and money that customers paid for these services in the current month.

An example of the Balance statistics widget is shown in Figure 20.8.

Figure 20.8

Call statistics

The widget allows you to monitor calls traffic intensity. An example of the widget after adding it on dashboard is shown in Figure 20.9.

Figure 20.9

You should specify the widget settings. Before doing this, determine for which object you want to calculate the traffic: a specific communication node, PBX, group of subscribers, or subscriber. Find ID of the required object in Tariscope.

To specify the widget settings, double click on the widget, the menu appears as shown in Figure 20.10.

Figure 20.10

Select the Configuration item. The Widget configuration window appears as shown in Figure 20.11.

Figure 20.11

In the Period list, select the desired period. There are the following options:

• Last hour.
• Last 6 hours.
• Last 12 hours.
• Today.
• Yesterday.
• This week.
• Last week.

In the Statistics for list, select an item for which you wish to get the statistics. There are the following options:

• Node.
• Equipment.
• Group.
• Subscriber.

Depend on what object you selected in the Statistics for list, the title of the next box can be changed. For instance, if you have selected 'Subscriber', the next box title will be 'Subscriber ID', and so on.

Enter an identifier (ID) of the selected object in this box.

The Statistics on all directions switch allows you to select a call direction. By default, the switch is on. This means that the widget will contain data on incoming, outgoing, internal, and transit calls. If you want to monitor only the specific call direction, turn off the switch and in the Call direction list, select the required call direction.

The Compare switch allows you to display traffic of one or two objects. By default, the switch is off. This means only traffic of one object will be display. To display traffics of two objects, turn on the switch. The ID of object appears, where you should specify an identifier (ID) of the object.

To show the date on the widget, turn on the Show the date switch. By default, it is off.

If you wish to show the legend, turn on the Show legend for chat switch.

You can use a special color to display the chat. To specify the color of the main chat, enter the color code in the Main line color text box. If you use two chat in the widget, to specify the color of the second chat, enter the color code in the Color for comparable line text box.

To save settings, click on the Save button.

Current date and time

The widget displays the current date, time or date and time. An example of the widget is shown in Figure 20.12.

Figure 20.12

To configure the widget settings, double-click on the widget and in the appeared menu, select the Configuration item. The Widget configuration window appears as shown in Figure 20.13.

Figure 20.13

In the Display mode list, select the desired item. The list contains the following items:

• Time.
• Date.
• Date and time.

In the Time format list, select the desired time format:

• 12 hours.
• 24 hours.

Click the Save button to keep the widget settings.

Current version of Tariscope

This widget displays the latest version number of Tariscope, which is available on the Tariscope site, and version number of Tariscope that you use. An example of the widget when the used Tariscope version is equal to the version on the Tariscope site is shown in Figure 20.14.

Figure 20.14

Database information

The widget displays the server name, database size, log file size, and Tariscope database version. An example of the widget is shown in Figure 20.15.

Figure 20.15

Database size

The widget is relevant if you use Microsoft SQL Server Express edition, that has a restriction on the database size. The widget is useful to control the database size. It displays the percentage of available database volume if you use Microsoft SQL Server Express edition. For other Microsoft SQL Server editions it writes that there are no limits on the database size as it is shown in Figure 20.16.

Figure 20.16

If you use other Microsoft SQL Server editions than Express edition and want to control the database size, use the Database Information widget.

Latest news article

The widget displays an announce of the latest article on the Tariscope site. An example of the widget is shown in Figure 20.17.

Figure 20.17

Click on the ‘more’ link to go to the article.

License usage

The widget displays the percentage of the Tariscope license usage. As you know there are two Tariscope editions: Tariscope Enterprise and Tariscope Provider. The Tariscope Enterprise license specify the number of subscribers that Tariscope processes. The Tariscope Provider license specify the number of extensions, IP addresses or subscriber without extensions and IP addresses that Tariscope processes. The License usage widget displays the maximum value on the license and value that you used. An example of the widget is shown in Figure 20.18.

Figure 20.18

Missed calls statistics

The widget displays statistics on the missed calls. An example of the widget when there is no data on the missed calls is shown in Figure 20.19.

Figure 20.19

You can configure the widget. To do this, double-click on the widget. In the appeared menu, select the Configuration item. The Widget configuration windows appears as shown in Figure 20.20.

Figure 20.20

In the Period list select the desired period. There are the following options:

• Last hour.
• Last 6 hours.
• Last 12 hours.
• Today.
• Yesterday.
• This week.
• Previous week.

In the Statistics for list, select an object for which you want to create the widget. As an object you can select:

• Node. This means you will get the statistics for the desired communication node.
• Equipment. This means you will get the statistics for the desired telephone system.
• Group. This means you will get the statistics for the desired group of subscribers.
• Subscriber. This means you will get the statistics for the selected subscriber.

To specify the desired object, enter its ID in the Object ID box. The word of ‘Object’ will be changed on Node, Equipment, Group, or Subscriber depending on previous choice.

If you need, you can select a call direction. By default, the widget displays information for all call directions. To choose the specific direction, turn off the Statistics on all directions switch and in the Call direction list, select the desired direction. There are the following options:

• Incoming.
• Outgoing.
• Internal.
• Transit.
• Unknown.

You can select the data display mode. To do this, in the Display mode list, select the required option from the following options:

• Pie chart. The mode displays the chart that contains answered and missed calls. An example on the char is shown in Figure 20.21.
• Text mode. The mode displays text information about answered and missed calls. An example on the char is shown in Figure 20.22.
• Only answered. The widget displays information only about the answered calls. An example on the char is shown in Figure 20.23.
• Only missed. The widget displays information only about the missed calls. An example on the char is shown in Figure 20.24.

Figure 20.21

Figure 20.22

Figure 20.23

Figure 20.24

Missed calls are considered to be those that have an unanswered feature in Tariscope. If you want to consider the missed calls that have zero duration, turn on the Calls with zero duration are counted as missed switch.

By default, the widget displays data as a percentage. To display the data as a value, turn off the Show percentage switch.

Click on the Save button to save settings.

Figure 20.25 shows the use of the Missed calls statistics widget for different departments.

Figure 20.25

Notes

The widget allows you to display some notes. For example, you can create a list of tasks that you should do in Tariscope. An example of the widget is shown in Figure 20.26.

Figure 20.26

To create notes, double-click on the widget. In the appeared menu, select the Configuration item. The Widget configuration window appears. The window allows you to enter your notes using HTML. An example of the windows is shown in Figure 20.27.

Figure 20.27

After you entered your notes, click on the Save button to keep text.

Observers status

The widget allows you to monitor the statuses of the Tariscope Observers services. It displays a name of Observer, status of the service (Not installed, Running, Stopped), and the time when the Observer processed the latest call. An example of the widget is shown in Figure 20.28.

Figure 20.28

The widget has two settings. Double-click on the widget and in the appeared menu, select the Configuration item. The window appears as shown in Figure 20.29.

Figure 20.29

The value in the Warning threshold (min) box allows you to specify the time period that if there are no new calls during the period you will get the warning. A warning sign is a red exclamation mark before the Observer name.

The Time format list provides the choice of time format: 24 hours or 12 hours.

Click on the Save button to keep the settings.

Request to database

The widget allows you to create a query to the Tariscope database to get any data and display them in the widget using HTML tags.

If you have selected the widget, it appears as shown in Figure 20.30.

Figure 20.30

At first, you should decide what information from the Tariscope database you want to display. Then you should define how to get these data. There is a document "Tariscope 4.x. Database scheme" that contains the descriptions of all Tariscope tables and views. Find tables or views that contain the required data and create the SQL query. You can check out the correctness of the query using Tariscope. To do this, in the menu, select Additional options → SQL queries, enter and execute the query.

If you get the required result, enter the query in the widget. To do this, double-click on the widget and select the Configuration item. The Widget configuration window appears as shown in Figure 20.31.

Figure 20.31

Enter the query in the SQL query to database box. In the Response format box, enter information that will display in the widget. You can use HTML to display data. For example, you can enter the following string to display the result of query contained calls cost for current date:

Total calls cost: {0},
where {0} is a result of the query.

Click on the Save button to keep the settings.

The widget allows you to create hundreds of different widgets.

Resource usage

The widget displays a usage of the server resources by Tariscope. An example of the widget is shown in Figure 20.32.

Figure 20.32

Blue color shows the resource usage by other applications. Yellow color shows the resource usage by Tariscope applications. It is possible to show only the resource usage by Tariscope applications. To do this, double-click on the widget. In the appeared menu, select the Configuration item. The Widget configuration window appears as shown in Figure 20.33.

Figure 20.33

The window contains only the Advanced mode switch, which is enabled by default. Turn off the switch to show only the resource usage by Tariscope applications.

Tariscope Task status

The widget displays a task list of Tariscope Tasks for today and yesterday. The list contains a task name, time when task must be executed, and execution status. Tariscope Task is a Windows service that executes different tasks by schedule. Therefore, the widget is relevant if you use Tariscope Tasks. An example of the widget is shown in Figure 20.34.

Figure 20.34

Dashboard settings

The Tariscope dashboard has some settings. To configure the dashboard, click on the sign of three dots after the Tariscope dashboard title. In the appeared menu, select the Settings item. The window appears that is shown in Figure 20.35.

Figure 20.35

The Auto refresh widgets switch enables or disables automatic refresh of widgets content. By default, the switch is off. Most widgets contain data that are changed over time, therefore, to see actual data, turn on the switch and specify the period of data change in the Interval box.

The Enable widget reordering switch allows you to enable or disable the widget rearrangement.

The Auto sorting widgets switch allows or disallows you to leave an empty space on the dashboard.

If you want to have more space for the dashboard, turn on the Close left menu switch.

Click on the Save button, to keep the settings.

Widget access

When you create a Tariscope user, you can give access rights to the dashboard for the user. The configuration of widget access allows to restrict number of widgets that users can see. Click on the sign of three dots after the Tariscope dashboard title. In the appeared menu, select the Widget access item. The window appears as shown in Figure 20.36.

Figure 20.36

By default, all widgets disable. Enable the widgets that can be visible for users.

Refresh all widgets

If you want to refresh all widgets, click on the sign of three dots after the Tariscope dashboard title and in the appeared menu, select the Refresh all widgets item.

Go full screen

If you wish to extend the dashboard to full screen, click on the sign of three dots after the Tariscope dashboard title and in the appeared menu, select the Go full screen item.

Specific actions for a widget

There some specific actions that you apply to each widget. Double-click on the desired widget. The menu appears as shown in Figure 20.37.

Figure 20.37

The Back item of the menu allows you to close the menu.

If you want to pin the widget position, select the Pin item. If you want to unpin the widget from the specific position, select the Pin item again.

If you need to refresh the widget content, select the Refresh item.

A widget can have a different size. To change the widget size, select the Resize item and in the appeared window, select the desired size of the widget.

If you want to rename the widget, select the Rename item of the menu.

Some widgets have settings. To change these settings, select the Configuration item of the menu.

If you want to understand the widget purpose, select the About widget item.

To remove the widget from the dashboard, select the Remove item.

Previous page   Next page

Contents of "Tariscope 4.5.x. Administrator's guide"