Tariscope 4.x. Administrator's guide
Chapter 3. Tariscope configuration
3.14. Tariscope Observer
The Tariscope Observer service (or the Observer service) was designed for collecting information about calls from a telephone system, telephone exchange, or buffer device and its initial processing.
A profile of this service must be set individually for each telecommunications equipment. To start a new profile creation of the service you can use two options:
- in the window of parameters of specific telephone system (Figure 3.12.1), click on the Create new profile here link,
- in the Tariscope configuration tree, select the Data collection/Observer branch and, right-click on it. In the appeared menu, select New profile.
In both cases a new branch of the configuration tree is created as a subbranch of the Data collection/Observer branch. But in the first case the name of the profile has the same name as the telephone system, and in the second case the profile has the Profile name. In the second case you must rename it to a desired name. All other settings in both cases are the same. An example of the Tariscope window when the profile is created from the configuration page titled "CUCM" is shown in Figure 3.14.1.
Figure 3.14.1
To configure the profile, click the Configure link (Figure 3.14.1) or, opend the profile branch and, click on the Configuration subbranch. The window will be as shown in Figure 3.14.2.
Figure 3.14.2
In the Equipment position the equipment name and type are displayed as links. In Figure 3.14.2 the equipment name is 'CUCM' and the equipment type is 'Cisco CallManager'. If you click on the 'CUCM' link you move on the appropriate window of the equipment configuration.
Under the Equipment position there is a list of CDR data sources. There are the following source:
- Folder/file. The data is contained in a file that may be in a local or network folder.
- FTP Client. The Observer service works with telephone system as a FTP client.
- FTP Server. The Observer service works with telephone system as a FTP server.
- Microsoft Lync. The Observer service collects CDR from Microsoft Lync.
- MS SQL Server database. The Observer service gets the data from Microsoft SQL Server database.
- MySQL database. Tariscope gets the data from MySQL database.
- Rlogin client. The Observer service works as Rlogin client to collect CDR.
- Serial port. The service gets CDR through a serial port.
- SFTP client. The Observer service works with telephone system as a SFTP client.
- SFTP server. The Observer service works with telephone system as a SFTP server.
- SSH client. The Observer service works with telephone system as a SSH client.
- TCP client. The Observer service works with telephone system as a TCP client.
- TCP/IP server. The Observer service works with telephone system as a TCP server.
- UDP Server. The Observer service works with telephone system as a UDP server.
- Asterisk AMI. The Observer wokrs with Asterisk using Asterisk Manager Interface (AMI).
The part of the window on the right from the list varies depending on the data source. Descriptions of the Tariscope Observer service for each data source, see in the following sections.
After configuring the CDR data source, in the Tariscope server connection section of the configuration page (Figure 3.14.2), set the Observer connection parameters to the Tariscope server. If it is assumed that Observer will work with the same rights that the Tariscope administrator has, skip this setting. Otherwise, click the Change Tariscope connection options link. The Connect to Tariscope server window appears as shown in Figure 3.14.3.
Figure 3.14.3
When you open this window, it reflects the current connection parameters of the Tariscope administrator. If necessary, replace them with the required parameters and, click Connect.
In the Raw CDR storage section of the configuration page of Observer (Figure 3.14.2), in the Path box, select or type a path to folder where the source files with CDR data will be stored.
In the New file every list, select he period of time that Tariscope will automatically create a new file to store the original call information. There are options:
- Single file. All data will be written into a single file.
- Every day.
- Every week.
- Every month.
- Every year.
- Don't create. Initial CDR data will not be recorded in a special file.
A choice of option depends on the number of calls per day, internal requirements of your company to archive data, the free space on the drive, and others.
We recommend to keep the original CDR data, because it can be useful when you want to reprocess the data.
In the Advanced features section of the configuration page of Observer (Figure 3.14.2), you can choose a logging level of Observer and specify the parameters of scripts on the specific events in the Tariscope system.
In the Log level list, select a desired logging level of Observer. There are following options, where each following option increases logging level:
- Status,
- Critical error,
- Error,
- Warning,
- Information,
- Advice,
- Debug.
The log is needed to identify the causes of malfunction of Tariscope Observer. If you using the log have not identified the cause of an incorrect operation of the service, send the log to the technical support service of SoftPI. A log file is located in the folder: ...\ProgramData\Tariscope
It has a name similar to the name of the Tariscope Observer service with the 'log' file extention.
To view the log of the Tariscope Observer service in Tariscope, click on the Service log link of the window shown in Figure 3.14.1, or choose the Service log subbranch of the configuration tree.
If you want that the Tariscope Observer service reacts to specific events that occur in the processing of CDR data, click on the Scripts button on the configuration page (3.14.2). The Tariscope Observer scripts window opens as shown in Figure 3.14.4.
Figure 3.14.4
The window contains a list of events for which you can associate an execution of a specific script.
There are following possible events:
- Data source connected. Means that there was a connection to the telephone system. Using this event can be helpful when the Data source disconnected event is occurred. Tracking such events you can always know about connecting Tariscope Observer to the telephone system.
- Data source disconnected. Means that Tariscope Observer was disconnected from the telephone system. This event can lead to stop receiving CDR data, and respectively, to the loss of information about the calls made during this period, while the port is closed. Use this event in conjunction with the Data source connected event. Tracking these events you can always know about connecting Tariscope Observer to the telephone system.
- Subscriber COS change. This event is relevant only for the Tariscope licenses with the restriction feature. It is used to change phone port parameters of a subscriber, channel, line, or route using a script. The script can change, for example, COS, disable, enable subscriner's port, etc.
- Group COS change. This event is relevant only for the Tariscope licenses with the restriction feature. It is used to change phone port parameters of a subscriber group. The script can change, for example, COS of a group of subscribers, disable, enable subscriners' ports, etc.
- New call was received. This event occurs when information about a new call is processed. It can be used, for example, to perform certain actions, such as sending e-mails when the call cost is more than a specific value, a call duration is more than a certain duration, the call was made to a specific phone numbers, etc.
- Periodic action. This event is intended to periodically execute a script. When you select this event, in the Tariscope Observer script window the Periodic script interval box appears, where you must set the interval in milliseconds after which the script will be executed. The default value is 60000. This event you can use, for example, when Tariscope Observer connects to a telephone system using a FTP client to get CDR files at specified time intervals.
- Database connection error. This event occurs when Tariscope gets the database connection error.
To bind any of these events to a specific script, select a desired event from the list and click the "..." button. Then, select a desired script. By default, the scripts are stored in the folder: \Program Files (x86)\SoftPI\Tariscope4\Scripts\
Tariscope allows to edit a script. To do this, in the Tariscope menu, select File -> Open file. In the Open window, select a file.
How to start or stop the Tariscope Observer service, see in the article.
