Tariscope 4.5.x. Administrator's guide
Chapter 4 Tariscope configuration
4.13. Tariscope Observer
The Tariscope Observer service (or the Observer service) is used for collecting call information (CDR, SMDR, AMA, and others) from a telephone system and its initial processing.
A profile of this service must be set individually for each telephone system. You can create a new profile in two ways:
- On the page of the specific telephone system settings (Figure 4.11.1), click on the Create new profile here link.
- In the Tariscope menu, select the Data collection/Observer → Observer management → the Add icon on the toolbar.
In both cases a new menu item is created as a subitem of the Data collection/Observer item. But in the first case the name of the profile has the same name as the telephone system, and in the second case you should specify the name. All other settings in both cases are the same.
To do any actions with the Tariscope Observers, select the Observer management item in the menu. The Data Collection/Observer page appears as shown in Figure 4.13.1.
Figure 4.13.1
The page contains the toolbar that includes the following icons:
- Add. Allows you to add a new Observer profile.
- Rename. Allows you to rename the profile.
- Edit. Allows you to edit the profile settings.
- Service management. Allows you to specify the Observer service settings, install, uninstall, start, and stop the service.
- Start. Allows you to start the selected Observer service.
- Stop. Allows you to stop the selected Observer service.
- Observers’ scripts. Allows you to assign scripts to the specific events of the selected Observer.
- Import profile. Allows you to import the profile settings into the selected profile.
- Export profile. Allows you to export settings of the selected profile into the external file.
- Delete. Allows you to delete the selected Observer profile.
- Start all. Starts all Observer services.
- Stop all. Stops all Observer services.
- Refresh remote Observers. The Tariscope Observer services can work on the remote computer. This icon allows you to refresh the remote services.
- Clear cache. Clears the cache memory that is used by Observers.
- Remote Observers. Allows you to configure the remote Observer.
- Export of the table. Allows you to export Observers table into the external file.
- Settings column visibility. Allows you to set columns that will be displayed in the Observers table.
To configure the profile, select the profile row in the Observer table (Figure 4.13.1) and click on the Edit icon on the toolbar. An example of the Tariscope Observer profile page is shown in Figure 4.13.2.
Figure 4.13.2
If the Equipment position contains ‘not selected’, click on the ‘here’ link. The Equipment selection window appears. Turn on the switch near the required telephone system and click on the Select button.
The Data source list contains a list of the available sources from which Observer can get CDR. There are the following options:
- Folder/file. The data is contained in a file (files) that may be in a local or network folder.
- FTP Client. The Observer service works with telephone system as FTP client.
- FTP Server. The Observer service works with telephone system as 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 SFTP client.
- SFTP server. The Observer service works with telephone system as SFTP server.
- SSH client. The Observer service works with telephone system as SSH client.
- TCP client. The Observer service works with telephone system as TCP client.
- TCP/IP server. The Observer service works with telephone system as TCP server.
- UDP Server. The Observer service works with telephone system as a UDP server.
- Asterisk AMI. Observer works with Asterisk using Asterisk Manager Interface (AMI).
- Alcatel OXO. Observer collects CDR from Alcatel-Lucent OmniPCX Office (Alcatel-Lucent OXO) using Web services.
Select the desired data source. For example, if your telephone system sends CDR through the FTP client, you should choose the FTP server in the Data source list.
You should configure the data source settings. To do this, click on the Data source configuration button. The Data source configuration window appears. It is specific for each data source. Each window is described in the following sections.
In the Raw CDR storage box, type a path to folder where the CDR source files will be stored.
In the Creation period list, select the period of time when Tariscope will automatically create a new file to store the original call information. There are options:
- Single file. All data are written into a single file.
- Every day.
- Every week.
- Every month.
- Every year.
- Don't create. Initial CDR data are not saved.
The choice of option depends on the number of calls per day, your requirements to archive data, the free space on the drive, and others. We recommend keeping the original CDR data, because it can be useful when you want to reprocess the data.
In the Log level list of the configuration page (Figure 4.13.2), you can choose the Observer logging level. 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 in the folder: ...\ProgramData\Tariscope
It has a name like the name of the Tariscope Observer service with the 'log' file extension. For example: CUCM.observer.log
To view the Observer log, in the Tariscope menu, select Data Collection/Observer → Observer profile → Service log.
Click Save to keep settings.
Tariscope Observer can start a script on the specific event. The script can execute any actions, for example, to additionally process CDR data, send an email, interact with the telephone system, and others. To use this ability, select the row with the desired profile in the Observer table and click on the Observers’ scripts icon on the toolbar. The Observers’ scripts page is opened. An example of the page is shown in Figure 4.13.3.
Figure 4.13.3
The page contains a list of events for which you can associate an execution of a specific script.
There are following possible events:
- Data source connected. This event means that there is a connection to the telephone system. 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. The event 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.
- Change class of service. 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 the script. The script can change, for example, class of service, or disable, enable subscriber's port, etc.
- Group state changed. 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, class of service for the group of subscribers, or disable, enable subscribers’ ports, etc.
- Periodic action. This event is intended to periodically execute a script. When you select this event, the Interval box appears, where you must set the interval in milliseconds after which the script will be executed. The default value is 60000.
- New call. This event occurs when information about a new call was 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.
- Database unavailable. This event occurs when Tariscope gets the database connection error.
To bind an event to a specific script, select the desired event from the Event list and select the script from the Script list. By default, the list includes scripts from the Tariscope installation. By default, the scripts are stored in the folder: …\Program Files (x86)\SoftPI\Tariscope\ObserverNg\Scripts
Tariscope allows you to edit a script. To do this, select the desired script from the Script list and click on the Edit button located on the right from the list. The Edit widow appears where you can do changes. After changes, click Close.
You can create your own script and use it with any event.
Contents of "Tariscope 4.5.x. Administrator's guide"