Tariscope 4.x. Administrator's guide
Chapter 3. Tariscope configuration
3.18. Tariscope Tasks configuration
The Tariscope Tasks configuration page is intended to configure the automatic performance of the following tasks by schedule:
- generation of reports;
- synchronization of subscribers' data with Active Directory;
- receiving of the currency rates;
- full backup of the Tariscope database;
- differential backup of the Tariscope database;
- charging of periodic services;
- archiving of the calls database;
- execution of a program.
In the Tariscope Tasks page you can perform the configuration of these tasks and to install, start or stop the TSSchedule service that executes these tasks.
To use this configuration page, select the Tariscope Tasks branch in the configuration tree. The Tariscope window will be as shown in Figure 3.18.1.
Figure 3.18.1
Initially, create the desired tasks. To do this, click on the Configure link. The program window will be as shown in Figure 3.18.2.
Figure 3.18.2
Create a new task. To do this, on the toolbar, click on the Add icon. The Edit new task window appears as shown in Figure 3.18.3.
Figure 3.18.3
In the Name box, type the name of the task. This name is displayed in the task table (Figure 3.18.2) and it allows to identify the purpose of a specific task.
If necessary, in the Description box, type a description of the task. This can be especially useful when tasks are created by several persons.
The Start parameters section (Figure 3.18.3) is used to specify the activity or inactivity of the task, the date and time of its initial start and periodicity of its execution.
In the Next start calendar box, select the date and time of the initial start of the task.
For task execution in the specific time and date, select the Active job check box after configuration of all data.
In the Period list, select a period of the task execution. There are the following options:
- Once. The task will be performed only once at the time specified in the Next start calendar list, and then it becomes inactive. If necessary to execute this task once more, you need to define a new date and time of task execution and select the Active job check box.
- Every hour. The task will be executed at intervals of multiple N hours specified in the Every box.
- Daily. The task will be executed at intervals of multiple N days specified in the Every box.
- Weekly. The task will be executed at intervals of multiple N weeks specified in the Every box.
- Monthly. The task will be executed at intervals of multiple N months specified in the Every box.
- Annual. The task will be executed at intervals of multiple N years specified in the Every box.
- Every minute. The task will be executed at intervals of multiple N minutes specified in the Every box.
- On service start. The task will be executed once, immediately after the Tariscope Tasks service starts, regardless of the value of the Next start box.
In the Type list, select the required type of task. There are the following options:
-
Report. One from the reports, which Tariscope contains or the Tariscope administrator was created, is generated. Or a procedure is performed for working with the Tariscope database.
- Full backup. The full backup of the Tariscope database is executed.
- Differential backup. This task creates backup only a part of the Tariscope database which was changed from the last backup. This option requires less time and computer resources to perform than a full backup.
- Backup calls. The archiving of the call database is executed and the appropriated call records are deleted from the database.
- Currency update. The automatic receiving of the required currency rates are executed.
- Synchronize subscribers from Active Directory. Synchronization of subscribers' database with Active Directory of enterprise is performed. Previously you should create a profile for synchronization with Active Directory.
- Charge periodic services. The service costs are charged for subscribers. The task is useed only for the Tariscope Provider edition.
- Execute program. The specific program is started.
The Filter box is active only if you have selected tasks: Report or Backup calls. It allows to select a set of rows with calls information for which the task will be performed. The list contains two fix values:
- No filter.
- Customer filter.
Also the list contains the filter names that were created in the call views or IP traffic views of Tariscope.
If your task must be applied to the whole of the calls database, select the No filter item. This is default item.
If you need a filter that its parameters have been previously saved with any name, select the name from the list.
If the list has a filter, which is generally suitable, but requires a small correction, select the desired name from the list and click the "..." button on the right of the list. The Edit SQL window opens, an example of which is shown in Figure 3.18.4.
Figure 3.18.4
Modify the query and click Save and close.
If you desire manually set the filtering options, select the Customer filter option and click the "..." button to the right of the list. The Edit SQL window opens, as shown in Figure 3.18.4, where you shoud type a query condition. The query must comply with a part of SQL query, which is written after WHERE. Click Save and close.
If you have chosen the Report item in the Type list box, you must select the report or procedure in the Report box. To do this, click on the "…" button, which is located on the right of the Report box. The Choose report window appears where you must choose a required report. This window contains the list of reports and procedures which was included in the Tariscope installation. If this list doesn't contain the required report or procedure you can create one using the Tariscope Report Designer program. After a choice of the report in the window, the report name will displayed in the Report box.
If you wish to generate a report for each subscriber, select the Separate report for every subscriber check box. When you select this check box, the filter is set which selects all subscribers in the Tariscope database. If necessary, make changes to the data of the filter by clicking on the "..." button to the right of the check box.
In the Folder list, enter or choose a folder, where reports, backups or archives will be written. Use the "…" button, which is located to the right of the box. The folder can be located on the local computer or remote computer. By default the folder is: %MyDocuments%\Tariscope\
In the File mask list, type or select a file name template. The file name supports the following templates:
- %d – day;
- %m – month;
- %y – year;
- %h – hour;
- %M – minute;
- %s – second;
- %a – subscriber account number;
- %e – main telephone number or IP address;
- %n – subscriber name.
By default the template is offered: report-% y-% m, which means that reports will be generated in files with names such as: report-2016-05, report-2013-06 and so on. The File mask list contains also other samples of file names that the Tariscope administrator can change at will.
In the File type list, select a file type in which a report will be written. The following file types are suppoted:
- xlsx,
- xls,
- xml,
- mdb,
- csv,
- txt,
- htm,
- html,
- pdf,
- prt.
The prt file type means that the file will be automatically sent on a printer.
By default the html file type is offered.
If you selected the Separate report for every subscriber check box, the Attach report to subscriber documents check box becomes active. If you select this check box, this allows you to automatically sort the documents for subscribers. In this case the documents will be saved in the folder specified in the Folder list, and in the Tariscope database. Documents from the database can be available to the administrator when he selects a specific subscriber in the Subscribers page. The subscriber may view such documents through his Personal Area, if it is allowed. If necessary, select the Attach report to subscriber documents check box.
To automatically send a report for a subscriber by email, select the Send to each subscriber check box. In this case, make sure that the subscribers' data contain their email addresses.
Reports, as well as notifications about the completion of tasks will be sent to the email address that is specified in E-mail box. It may be, for example, the email address of the Tariscope administrator. If you want to send reports or notifications to multiple addresses, enter them in the E-mail box, separating addresses with a semicolon.
In the Subject box, type a subject of the email message. For example: "Tariscope notification".
When in the Type list, the Currency update item was selected, the Report box is replaced to the Profile list. The Profile list contains a list of currently available profiles:
- GE-NBG. The profile is used to receive the currency rates from the site of National Bank of Georgia.
- KZ-NB. The profile is used to receive the currency rates from the site of National Bank of the Republic of Kazakhstan.
- RU-CBR. The profile is used to receive the currency rates from the site of Central Bank of the Russian Federation.
- UA-NBU. The profile is used to receive the currency rates from the site of National Bank of Ukraine.
- UA-PIB. The profile is used to receive the currency rates from the site of Prominvestbank (Ukraine).
The above profiles are stored in the folder: ...\Program files (x86)\SoftPI\Tariscope4\CurrencyProfile\. They have a structure of the XML file. The administrator can edit any of the profiles or create your own.
In the profile file, you can create or change the following settings:
- a name and settings of a proxy server;
- Web page, where it is necessary to obtain information on currency rates;
- a list of required currencies and parameters of search of a currency rate.
Also you can change a profile data by clicking on the "..." button located on the right of the Profile box. An example of the Currency update profile window is shown in Figure 3.18.5.
Figure 3.18.5
Since the information to update the currency rates is taken from an external site, the computer, where Tariscope Tasks will run, must have an access to the relevant site. If your network uses a proxy server, you must specify its parameters. Click on the Use proxy check box (Figure 3.18.5) and, type values in the Proxy server, Login, Password boxes.
To add a new currency and site that contains currency rates, right-click on the table of currency codes (Figure 3.18.5). In appeared menu, select the Add item. The Edit profile window appears as shown in Figure 3.18.6.
Figure 3.18.6
Type values in the boxes of the window. An example of such an input is shown below:
Currency code: USD
Decimal delimiter:.
Factor:0.01
Url: http://www.bank.gov.ua/control/uk/curmetal/detail/currency?period=daily
Startkey1:<td class="cell">United State Dollar</td>
Startkey2<td class="cell_c">
Regular expression:
EndKey:</td>
Start or stop of Tariscope Tasks
Before starting the Tariscope Tasks service, configure the service connection to SQL Server. To do this, on the toolbar, click on the SQL Server connection configuration icon or the Configure SQL Server connection here link, which is located in the notification line of the Tariscope Tasks window (Figure 3.18.2). The Connect to Tariscope server window appears as shown in Figure 3.18.7.
Figure 3.18.7
In the Server name list, specify a name of server, where the Tariscope server is located.
In the Authentication list, select a required option from the followings:
- SQL Server Authentication. A validation is performed by Microsoft SQL Server.
- Windows Authentication. A validation is performed by Windows.
In the User name box, type a user name whose rights the Tariscope Tasks service will use to connect to the Tariscope server. To see the list of available Tariscope users or create a new user you can in the Users configuration page.
In the Password box, type a password for the selected user.
Click Connect.
To install, uninstall, start, stop the Tariscope Tasks service you should select the Tariscope Tasks configuration branch in the configuration tree (Figure 3.18.1).
The Service status position the current status of the Tariscope Tasks service is displayed. When this page is opened initially, the value of the position is "Not installed".
To install the service, click on the Install service link. In the case of a normal installation the Service status position is displayed "Stopped". The Install service link is replaced to the Uninstall service link, and the Start service link is active.
To start the service, click on the Start service link. In the Service status position is displayed "Running". The Start service link is replaced to the Stop service link. The Uninstall service link is inactive.
After the service start we recommend to click on the Service log link or select on the same branch in the configuration tree and make sure there are no errors. If the log contains errors, stop the service, return to the configuration and, validate the configuration data. After that, start the service.
To stop the service, click on the Stop service link. The Stop service link is replaced to the Start service link, and the Uninstall service link is active. The Service status position is displayed: "Stopped".
The Tariscope Tasks service keeps a log of its work. To see this log, select in the configuration tree: Tariscope Tasks → Service log.
