JeraSoft Documentation Portal
Docs for all releases
This section represents a built-in tool to monitor statistics and generate alerts, as well as block numbers, codes/code names, destinations, clients, or accounts, if some conditions are met. The section is presented in a form of a table with the following columns:
Screenshot: Factors Watcher main section
|ID||Identification number of a factors watcher|
|Name||Name of a factors watcher|
|Watch Rule||Total number of watch rules within a factors watcher|
|Presets||Total amount of traffic rules, created by a factors watcher|
|Query||Factors watcher query|
Functional buttons/icons, presented in the section, are as follows:
|Allows editing existing watch rules|
|Allows viewing traffic rules, created by a factors watcher|
|Allows editing a factors watcher|
|Allows deleting a factors watcher|
Screenshot: Adding a New Factors Watcher
|Name||Factors watcher's name. This field is mandatory. The name must be no longer than 128 symbols.|
Different reports provide a different set of parameters that are available for monitoring. For instance, xDRs List allows you to work with service sources (phone numbers, data) while Summary report allows such operations with ACD and ASR.
Specify the template for further usage (optional)
|Analyze Interval of, min||Interval of time to check. Please note, this option checks a current period, not the past hour.|
|Period Offset||This period is used to compare results of different intervals. It deducts a specified period from the Period Start date, then takes the statistics according to the Analyse interval of value and the date calculated above.|
Check Every, min
Frequency of checks, performed by a factors watcher
Enter the specific time to set a factors watcher starting date
Specify a timezone that will be used for reports queries/blocking routes
When you choose the time profile, it will use the statistics in the factors watcher according to the chosen value, for example, at peak times. However, if you click on Test Query, it will display the statistics without the selected time profile.
|Query information block||Indicate the query fields that will be used for generating a selected type of report|
Select a client. You can specify multiple clients.
Select a target client's account
Indicate a code name
Define the code
Specify a Reseller
Indicate a target code deck
Select a respective gateway
Group by #
Group query by a selected parameter (client, account, code name, code or gateway). Pay attention that based on selected parameters, respective Action options will be available. For instance, if you group by Code, in the rule settings you will have the Block Code option and so on.
Test Query button
Click on this button to perform a test query in the Summary or xDRs List Report for the period, specified in the Check Every and Analyze Interval of fields
When you click OK, the new factors watcher will be created. You can edit properties of this watcher later by clicking the edit icon.
Next, you need to configure the watcher rules – parameters, under which conditions are monitored. To do this:
Screenshot: Editing Factors Watcher rules
|Priority||Define a priority of rules execution if they have the similar Match parameter|
|Match||A set of parameters that are used as a basis for checks|
|Determine the type of service (e.g., calls, SMSs, data)|
|Type of route to check (Origination/Termination)|
|Indicate the code name to apply a rule to|
|Specify the gateway to apply a rule to|
Enter factors that will be applied to a current rule.
Parameters must be listed with a semi-colon “;” as a delimiting symbol.
The list of parameters available for usage:
For example, if you enter total_volume > 100, it means that when the total event volume (e.g., call time) count for respective match parameters goes over 100 (here - minutes), the system will create an alert.
It's possible to add a factors watcher rule with negative values. For example, total_cost < -10.
Factors with a reference to the side-by-side reports:
You can adjust these factors on your own, using the next formula and pre-existing factors mentioned above: factors_name_1 - value for the first period; factors_name_2 - value for the second period; factors_name_diff - difference between periods.
For example: total_cost_1 (of the 1st period), total_cost_2 (of the 2nd period), total_cost_diff (difference in %).
An action that must be taken if a matched rule is found.
There are respective options: Alert, Block Code Name/Account/Client
|Lock Period||Defines the lockout time in minutes for analyzed route in case of a block action (0 value means infinite lockout)|
If enabled, the rule will expire at the end of a period specified in the Analyze interval of field in the Watcher settings. Please note, that this option has higher priority than the Expiration Date.
|Expiration Date||Specify date when the rule must be automatically deleted|