Tariscope 4.6. Administrator's guide

Chapter 3 Activation

The Tariscope installation package contains a trial activation key for the Tariscope Provider edition. The key provides a support for 15 extensions (telephone numbers) or IP addresses and works for 15 days. The Tariscope Provider edition includes all features of the Tariscope Enterprise edition and some additional features.

If you purchased the Tariscope license, you should activate the license.

If you have not yet purchased Tariscope, but you want to try it with the desired number of subscribers (for the Tariscope Enterprise edition) or extensions and IP addresses (for the Tariscope Provider edition) for one month, you should create a test activation request and send one to the SoftPI Support Service.

To obtain the Tariscope activation key you, in the menu, select Additional options → License.

The Tariscope page will look like the one shown in Figure 3.1.

activation en
Figure 3.1

The Tariscope activation consists of the following steps:

Creating and sending an activation request file.
Applying the activation key.

If the computer with the Tariscope server has a connection to the Internet, sending a request, receiving, and applying an activation key are performed automatically by Tariscope. The automatic generation and applying the key are performed by the Tariscope Main service (Tariscope server).

In case the Tariscope server has no Internet connection, the Tariscope administrator should send the request and get the activation key himself by e-mail, and then apply it using the License page.

Activation request

If you purchased the Tariscope license, click on the Request activation in the page shown in Figure 3.1. The Tariscope page will be as shown in Figure 3.2.

activation request en

Figure 3.2

In the Serial number box, type the serial number of your license.

In the E-mail box, type your e-mail address. If there is no possibility to send the activation key directly to Tariscope, the key will be sent on your e-mail address.

If you wish to send any additional information to SoftPI, you can type it in the Comment box.

Click Send. The registration information will be sent to SoftPI if the server has a connection to the Internet.

If Tariscope determines that the Internet connection is not available, a message appears. It is shown in Figure 3.3.

en caution
Figure 3.3

Click Close. In the Open window, select a folder to save the request file and save it.

Send this file to the email address: This email address is being protected from spambots. You need JavaScript enabled to view it..

If you have not purchased Tariscope yet, but would like to test it in fully functional mode for one month, click on the Request trial activation (no serial number) (Figure 3.1). The page will be as shown in Figure 3.4.

test activation request en
Figure 3.4

In the Owner box, enter your company name.

In the Contact box, enter your contact phone numbers.

In the Address box, enter the company address.

In the E-mail box, enter the e-mail address on which the activation key will be send, if the computer has no Internet connection.

In the Comment box, enter the desired Tariscope edition (Enterprise or Provider) and the desired number of subscribers or telephone numbers (extensions).

Click Send. The request information is sent to SoftPI if the computer with Tariscope has the Internet connection.

If Tariscope determines that the Internet connection is not available, a message that is shown in Figure 3.3 appears. Follow the steps mentioned in the window.

We do not provide test activation keys to anonymous users.

Applying the activation key

If the request file is sent automatically, receiving the activation key and applying it are performed automatically.

To verify that the activation key has been obtained, open the License page (Figure 3.1) and select Current key properties. The Tariscope page will be as shown in Figure 3.5.

activation key view en
Figure 3.5

If you have received the activation key by e-mail, click Apply an existing key (Figure 3.1). The page will be as shown in Figure 3.6.

appling key en
Figure 3.6

Click the Browse button and select the file with the activation key. Click Next. The window displays the activation key parameters. An example of this is shown in Figure 3.5.

Previous page Next page

Contents of "Tariscope 4.6. Administrator's guide"

Tariscope 4.6. Administrator's guide

Chapter 2 The first connection to Tariscope

To work with Tariscope, we recommend using the following browsers: Chrome (Google) or Edge (Microsoft).

Open a Web browser and enter IP address and IP port of Tariscope. If you are on the server where Tariscope was installed, you can enter localhost:8085, where 8085 is an IP port that you specified earlier. If you set another IP port, enter it instead of 8085.

If you connect from another computer, enter IP address of Tariscope server and IP port. For example: 10.10.5.19:8085

The first Tariscope page will look like the one shown in Figure 2.1.

twa1
Figure 2.1

In the E-mail box, enter This email address is being protected from spambots. You need JavaScript enabled to view it.. It is a default TWA administrator login.

In the Password box, enter 111111. It is a default password.

You should to change the password to avoid unauthorized access to the application.

If you have correctly entered the login and password and you use Chrome or Edge, the window appears as shown in Figure 2.2. The window offers you to use Progressive Web applications (PWA) to work with Tariscope. This means that Tariscope application will open in the separate window without the browser window. This allows you to better use screen. At the same time, you can work with Tariscope through browser. If you want to use PWA, click Install in the window and specify a folder where a shortcut will be created.

en pwa
Figure 2.2

The application page will look like the one shown in Figure 2.3. The main Tariscope page displays the application menu, dashboard, username connected to Tariscope, and presence of requests from subscribers (customers). The menu is used both for the Tariscope configuration and for work.

twa2
Figure 2.3

The main Tariscope page displays the application menu, dashboard, username connected to Tariscope, and presence of requests from subscribers (customers). The menu is used both for the Tariscope configuration and for work.

The menu contains the following items and subitems:

Home. The item includes the following subitems:
The Dashboard page can display different widgets that allows you to control and manage Tariscope.
The latest news feed page displays announcements of the latest news from the Tariscope site.
The Update history item allows you to open the Tariscope Version History page on the Tariscope site. The page contains the Tariscope update history.
Views. This item is intended to create, edit, and analyze views with calls, services or IP traffic information, processing CDR data and import of calls and services data from external files into Tariscope. Correspondingly, there are the following subitems:
View list allows you to work with views of calls, services, and IP traffic.
CDR processing allows you to process a CDR file from PBX. Use this function if you want to process a CDR file without using the Tariscope Observer service.
Import calls and services allows to process some data, for example, CDR or services information if Tariscope does not contain a specific parser for your PBX or services. Before use the item, you should create the script that will execute these actions.
Reports. The item allows you to generate a report. There are subitems:
Report list displays a list of available reports.
Service log is a log of the result of reporting.
Data Collection/Observer. The item is used to configure and control the automated CDR data collection. There are subitems:
Observer management allows you to open a page that contains brief information about all Observers.
A list of the Tariscope Observer services.
Tariscope Tasks. This item is used to configure tasks that are scheduled. There are following subitems:
Task list contains a list of tasks that Tariscope Tasks must execute.
Service log is a log of the Tariscope Tasks service.
Work order. First of all, this item is intended for telecom operators who want to use Tariscope to form tasks for employees and monitor their implementation. There are the following subitems:
Create order. It allows you to create a new work order.
Order list. The item allows you to manage the work orders.
Smart Assistant. It contains tools that use machine learning and artificial intelligence, which allows you to detect the fraud, execute call information monitoring, and predict subscribers’ payments.
Subscribers' accounts. The item is applied only for the Tariscope Provider edition. It allows you to work with subscribers' (customers') accounts.
Communication nodes. The item is used to configure a communication node that includes PBXs' and subscribers' parameters. The item contains the subitems:
Equipment creation wizard helps you to create a new communication node.
Node management opens a page that contains brief information about all communication nodes.
A list of communication nodes.
Providers and rates. This item allows you to setup telecom provider settings which are applied to calculate the call costs. The item contains the following subitems:
Common phone codes allows you to manage telephone codes (country codes, area codes, mobile operator codes, and local codes) that can be applied by different telecom provides.
Providers management opens a page that contains a list of telecom providers. The page allows a user to view, edit, import, and export providers. A list of telecom providers.
Rate plans. The item is applied only for the Tariscope Provider edition. It allows you to manage rate plans.
Services. The item is applied only for the Tariscope Provider edition. The item allows you to manage services provided to customers. The Services item includes the following subitems:
Services list displays a page that contains a list of services. You can manage any of these services.
Bundles list displays a page that contains a list of service bundles. You can manage any of these bundles.
Taxes displays a list of taxes that are applied to services.
Day types allows you to set days when services will have the specific price.
Currency rates. The item allows you to manage currency settings.
Additional options. The item contains a set of subitems that are enumerated below.

There are the following Additional options:

Users. This item allows you to manage Tariscope users.
Personal Area. The item allows you to manage parameters of Personal Area. Personal Area is an interface for subscribers to get information about their calls, status of account, to execute payments for telecom services and others.
Categories. The item allows you to manage the call categories.
Service-rate. The choice of the item allows you to manage service-rates. A service-rate means that a rate can be applied to the service. This provides using a single service name in different rate plans, but these services will have different rates.
Database info. This item provides database information, database restoring, database moving, calls archiving, restoring, and removing. Also, the item provides a creation of Tariscope backup and recovering the Tariscope database from the backup.
Integrations. The choice of the item opens the page of Tariscope integrations with other applications. This page contains the links to the following Tariscope applications:
Tariscope API contains a short information about Tariscope API.
SureTax provides configuration and getting taxes from SureTax (Wolters Kluwer).
3CX Phone System provides working with the 3CX databases.
Hotel systems. This item allows you to setup and manage the service that exports calls data in the hotel or other systems.
Netflow/IPFIX/rFlow Collector. The item is used to configure and manage a collection of data about IP traffic with NetFlow, IPFIX or rFlow.
Active Directory provides a profile configuration to get subscribers information from Active Directory.
New integration opens windows with information that SoftPI are ready to develop any integration with your system.
_ SQL queries. The choice of the item allows you to create a query to the Tariscope database. You should use T-SQL.
Service log. The item displays the Tariscope log. You can use it to solve issues in Tariscope.
Notifications and mailing. The item allows you to setup notifications and mailing in Tariscope.
Dictionaries. This item allows you to manage dictionaries which are used in Tariscope.
Day with interruption allows you to fix such day. This information will use to charge services to customers.
System variables. The item provides a management of Tariscope system variables.
License. Select the item if you want to get the activation key or have a look at the license conditions.
About. This item allows to get the license information and warranty period, system requirements, SoftPI Support Team contacts, and links to different Tariscope sources.

Previous page Next page

Contents of "Tariscope 4.6. Administrator's guide"

Tariscope 4.6. Administrator's guide

Purpose

This document provides administrator guidance for how to set up, configure and maintain the Tariscope Enterprise 4.6 or Tariscope Provider 4.6 editions (SoftPI) or above. Further in the text, if there is not needed to clarify the edition, the Tariscope name is used.

Introduction

Tariscope Enterprise 4.6 is a call accounting software that is intended for companies which use telephone systems (PBXs) and Internet equipment for internal needs.

Tariscope Provider 4.6 is a telecommunications billing system that is intended for telecommunications service providers.

The Tariscope is a Web application.

Tariscope administrator must be an experienced user of the operating system Windows 10 or Windows Server 2019 / 2016 or Linux depending on which operation system is used and have a basic level of knowledge in Microsoft SQL Server.

Tariscope is a web application of the Tariscope system, which can be used both to configure the system and to work with it. This document discusses how to set up and maintain Tariscope.

Contents of "Tariscope 4.6. Administrator's guide"

Tariscope 4.6. Administrator's guide

Chapter 1 Installation

Advance preparation

Tariscope can be installed both on Windows (Windows 10, Windows Server 2019 / 2016) and Linux (Alpine, CentOS, Debian, Fedora, OpenSUSE, Red Hat, SLES, Ubuntu).

Before the Tariscope installation, perform the following steps:

Determine under which operating systems the individual components of the Tariscope system will work. It is possible to install individual components on servers (computers) with different operating systems. For example, Microsoft SQL Server is installed on Windows, and Tariscope on Linux. Other installation options are also possible.
Determine the Microsoft SQL edition you will use for the Tariscope database. Whether it will be installed from the installation package on the same computer where Tariscope will be installed, or the SQL server will be installed on a separate server.
Select an option to install the system.
Select a server (computer), you will install the system. Server parameters for the Tariscope system depend on the selected installation option, telephone traffic, activity with the Tariscope system. When placing the Tariscope system and MS SQL server on one server, as well as low telephone traffic, we can recommend the following minimum server parameters:
Processor: AMD FX-6300 or Intel Core i5-4430 or server AMD Opteron 3380 or Intel Xeon E3-1505L v5;
RAM: 8 GB;
Hard disk: 512 GB.

Additional dependencies

For Windows

The Tariscope distribution includes Microsoft SQL Server 2017 Express. This is a free edition, but it has several limitations, primarily related to the size of the database and performance. It is not required to install this server, but in this case, you should connect the Tariscope database to Microsoft SQL server of a different version and edition, which you already have, or purchase a new one. Microsoft SQL Server 2019 and 2017 are supported.

For Linux

Before installing the Tariscope system, you must install the following applications:

cupid,
inxi,
libgdiplus,
wkhtmltopdf,
.Net Core Runtime 5.0. How to install this application for a specific Linux version, see the Microsoft website: https://docs.microsoft.com/en-us/dotnet/core/install/linux

Installation for Linux, unlike installation for Windows, does not contain Microsoft SQL Server installation. Therefore, you must install this server yourself, either under Windows or under Linux. How to install this server under Linux, see the Microsoft website: https://docs.microsoft.com/en-us/sql/linux/sql-server-linux-setup?view=sql-server-ver15

1.1 Installation for Windows

The Tariscope system has a single installation package to setup the Tariscope server, Tariscope database, and Microsoft SQL Server 2017 Express edition.

The Tariscope server executes general functions of the system.

The Tariscope is a Web application that is used to setup Tariscope parameters and to work with calls, services, customers' accounts and other information. It is a main application of the Tariscope system with which the user works.

The installation is contained in the file of tariscope46.exe, which you can download from the Tariscope site.

Run the file. The Installer Language window appears as shown in Figure 1.1.1.

installation uk 1
Figure 1.1.1

Select the desired language and click OK. The installation window appears as shown in Figure 1.1.2.

en setup1
Figure 1.1.2

This is an information window. Read information and click Next. The License Agreement window appears as shown in Figure 1.1.3.

en setup2
Figure 1.1.3

Read the Agreement. If you agree with the agreement, click I Agree, otherwise click Cancel. If you have selected the I Agree button on the previous step of installation, the installation window looks as shown in Figure 1.1.4.

en setup3
Figure 1.1.4

The Components selection window offer you to select an installation option. There are three options:

Tariscope with components and database, Microsoft SQL Server 2017 Express.
The choice of the option allows you to install all Tariscope applications, the Tariscope database and Microsoft SQL Server 2017 Express edition. If you planning to use another edition of Microsoft SQL Server, do not select this option.
Tariscope server and applications (without Microsoft SQL Server).
The choice of the option allows you to install all Tariscope applications and the Tariscope database. Microsoft SQL Server does not install during the installation. The Tariscope database backup was made on the Microsoft SQL Server 2017, therefore, you should have this Microsoft SQL Server version or higher to attach the Tariscope database.
Tariscope applications only or update.
Select this option if you already installed the Tariscope. Also, you should select the option if you update the previously installed Tariscope applications.

Select the desired option and click Next. Whatever your choice is, the next installation window is as shown in Figure 1.1.5.

en installation 5

Figure 1.1.5

The Tariscope components windows allows you to select applications that you want to install. There are following applications:

Tariscope is a Web application that provides the Tariscope configuration and work. You only need to install it on one server.
Observer Server is a server of Tariscope Observer remote services. It should be installed on the remote computer that has access to calls from a telephone system.

Select the desired components and click Next. The next installation window appears as shown in Figure 1.1.6.

en setup5
Figure 1.1.6

There are three Tariscope utilities for which you can create shortcuts in the Start menu of Windows.

The Move database utility allows you to move the Tariscope database from one folder to another.

The Attach database utility allows you to attach data files (MDF and LDF files) to the desired Microsoft SQL Server.

The Restore database utility allows you to restore the Tariscope database from the Tariscope database backup.

Select the desired check boxes and click Next. The installation window will be as shown in Figure 1.1.7.

en setup6
Figure 1.1.7

Enter or select the desired folder where Tariscope will be installed and click Next. The installation window will be as shown in Figure 1.1.8.

en setup7
Figure 1.1.8

This window allows you to select a folder name in the Start menu of Windows. By default, the Tariscope name is offered. You can change it on another. Click Install to begin the installation. The Tariscope installation window will look like the one shown in Figure 1.1.9.

en setup8
Figure 1.1.9

The applications that you selected on the installation step shown in Figure 1.1.3 are installed. After the installation of the Tariscope system is completed, the Tariscope Start window will appear, an example of which is shown in Figure 1.1.10.

en tariscope start

Figure 1.1.10

You can change the language of the window. To do this, select on the toolbar: Settings → Language.

To enter the parameters for connecting the Tariscope system to Microsoft SQL Server, click the Change connection options link. The SQL Server Connection window appears, an example of which is shown in Figure 1.1.11.

en setup9

Figure 1.1.11

Specify the SQL server name or its IP address in the Server name or IP box. If Microsoft SQL Server that should be used for the Tariscope database is on another server, type IP address of the server.

If the SQL server instance name is not default one (MSSQLSERVER), you should specify its name in the SQL server name (optional) box. For example, the SQL Server name is MySQLServer. In this case, you should type: MySQLServer.

If you are installing the SQL Server from the Tariscope installation package, you can type '.' ('dot' symbol) in the SQL server name (optional) box.

In the Authentication section, in the Type list, select the desired type of authentication. There are options:

Windows Authentication;
SQL Server Authentication.

If you select Windows Authentication, you do not need to enter any parameters. You can use this authentication type if you are installing Tariscope on the same server where SQL Server works.

For the second option, in the Username and Password boxes, type a username and its password that are used to update the database on the SQL Server.

We reccomend using SQL Server Authentication.

If your SQL Server is located on another server, you should use only SQL Server Authentication.

If you use SQL Server that was installed from the Tariscope installation package, you can use both Windows Authentication and SQL Server Authentication. In the last case, you should use the username of 'sa' and password of 'Tariscope123'.

We strongly recommend to change the password when you begin to work with Tariscope.

Click Check connection.

If you have correctly entered parameters, the Connection status string displays the value of "connected". Otherwise, ckeck the set parameters.

Click Done, you will return to the Tariscope Start window.

In the Port box, you can specify the IP addresses that will be used to access the Tariscope application. Default value: 8085. You can change this value. If you want to open the application after installing it, select the Open in web browser check box.

If you want to use HTTPS and have a corresponding certificate, then to connect it, select in the menu: Settings → HTTPS. The HTTPS setup window appears, an example of which is shown in Figure 1.1.12.

en https settings

Figure 1.1.12

Select Enable HTTPS. The rest of the window positions become active.

In the HTTPS ports box, enter one or more IP ports on which Tariscope will work.

If you want all users who connect to Tariscope via an unprotected protocol to be redirected to a secure site, select Enable HTTPS redirection.

Click on the button to the left of the SSL certificate box and select the certificate file.

In the Certificate password box, enter the password for the certificate and repeat it in the Validate password box.

To check if the settings are correct, click the Validate button. Click the Done button to complete the configuration.

The Tariscope website keeps a log of requests to it. You can set the period for creating such a new log. To do this, select in the Tariscope Start menu: Settings → Kestrel Logger. Kestrel is the name of the server that hosts the Tariscope website. The Kestrel Logger window appears, where in the Period list, select the required one and click Apply.

If you have used Tariscope versions 4.4 or lower before, and you want to transfer previously created views, select Tools → Migrate the views from the menu.

If you have used Tariscope versions 4.4 or lower before, and you want to transfer previously added telephone codes, select Tools → Migrate the codes in the menu.

To launch Tariscope, click the Start button. Tariscope installation will be completed.

1.2 Installation for Linux

Installation for Linux does not contain Microsoft SQL Server, which is needed for the Tariscope system to work. You must download it from Microsoft website and install it yourself. Microsoft SQL Server 2019 (2017) can be installed on both Linux and Windows.

Unpack the archive: tariscope46.tar.gz

As a result, the App and Generic folders will be created, and the install-tariscope.sh file will be in the root.

Run the following command with the root user rights to install the Tariscope system:

sh install-tariscope.sh - p 'name of the installation folder'

In this command instead of 'name of the installation folder', specify, for example, '/home/softpi/tariscope’.

If all the listed applications in the Additional dependencies section have been installed, then the Tariscope system installation should be completed without errors.

Go to the folder where you installed Tariscope. It should contain the www folder. The Tariscope database is in this folder /www/Database/Database. Install Microsoft SQL Server 2019 (2017) on this or another server and attach the specified database to it. How to install Microsoft SQL Server for Linux, see the article: https://docs.microsoft.com/en-us/sql/linux/sql-server-linux-setup?view=sql-server-ver15.

How to install Microsoft SQL Server for Windows, see the article: https://docs.microsoft.com/ru-ru/sql/database-engine/install-windows/install-sql-server?view=sql-server-ver15.

Go to the www folder and find appsettings.json file. Open it for editing. An example of this file is shown in Figure 1.2.1.

uk appsettings.json

Figure 1.2.1

In the connection string (DefaultConnection) after Data Source, specify the IP address of the server where Microsoft SQL Server was installed. In the example in Figure 1.2.1, this is the IP address: 10.10.0.133. In the same line, the system administrator, "sa", with the password "Tariscope123" is specified as the user from whom the Tariscope system works. Instead of the "sa" user, you can use any other user who has all the rights (owner) to the Tariscope database.

Tariscope works on the Kestrel server. By default, this server keeps a log of requests to it. This is reflected in the line: "KestrelLogger": true.

Change true to false to disable this logging. We recommend keeping this log.

The line "KestrelLoggerPeriod": 1 defines the period for creating a new Kestrel log: 0 - daily, 1 - weekly, 2 - monthly. Change the period for creating the log if necessary.

The IP port on which Tariscope will work is specified in the line: "Http": "8085".

That is, IP port of 8085 will be used by default. Change it if necessary.

If you want Tariscope to work over HTTPS, you must have an SSL certificate and set its parameters in this file.

In the line "SSLCertificate": "" specify the path where the file of this certificate is located.

In the line "SSLPassword": "" enter the password for this certificate.

Specify the IP port for working over HTTPS in the line: "Https": ""

To enable HTTPS, change false to true in the line: "HttpsEnabled": false.

If you want to redirect all requests made in Tariscope via HTTP to HTTPS port, change the value false to true in the line: "HttpsRedirect": false.

Save the settings for this file.

In the www folder there is the run.sh file that starts the Tariscope server.

Run the command as the root user: sh run.sh.

After that you can work with the Tariscope system.

Previous page Next page

Contents of "Tariscope 4.6. Administrator's guide"