This documentation relates to an earlier version of JeraSoft VCS.
View User Guide 3.19 or visit our current documentation home page.
Skip to end of metadata
Go to start of metadata
On this page

Summary Report Query Form

This section allows you to generate a summary statistical report. Here you can create a report based on an existing template or generate a new one. Also, you can get the information sorted by date, clients and calls, even by the VoIP group. 

 

Screenshot: Summary Report query form

To create new report 

In order to create a statistic report go to the Statisctics and open the Summary Report section. 

Then you need to fill out the form with next parameters: 

SectionField Description
Filters

On the Filters menu, select convenient parameters for the report. To cancel any filter, click the delete sign  next to the filter.

You can start a quick search by typing filters' names in the bar at the top of drop-down menu with filters.
It will display all filters that have specified letters. If you enter more letters, fewer filters will result

Period 1

Specify the first interval for the report. Please note, that the "Period" field is mandatory.

Period 2

Accessible when you enable the "Compare Period" option by clicking the plus sign  next to the "Period". Specify the second interval for the report.

When you select one of Time parameters for Group By, the end date of the Period 2 will be set automatically to make equal intervals of Period 1 and Period 2.


Group By

Select a grouping option, here you can choose and swap columns, change its order. There are following accessible options to group the data in reports:

  • Time: Year, Month, Date, Time.
  • Clients: Client Type/ Client/ Account/ Cards Serial/ Owner/ Package Name.
  • Calls: Code/Code Name/Currency/Rate/Additive Rate/Call Origin/ Disconnect Code/ VoIP Gateway.
  • Extras: VoIP Tag

    Please note, the "Group By" field is mandatory, it couldn't be empty in order to generate the report. It's intended to simply grouping option, the system groups data in specified columns.

    Please note, that if there is the Client or CC serial specified, it is not possible to group by default anymore. 

Additional Filters

There are following accessible additional filters:
 

  • By clients: Client Type, Client, Account, Tag, Cards Serial, Package.
  • By calls: Code, Code Name, Cost Total, Call Origin, Disconnect Code, VoIP Gateway.
  • Extras: Owner/Time Total/ Calls Total/ Calls Not Zero/ ASR Current/ ACD Current.
 
Client TypeSelect a client's type for report (Client, Reseller, Calling card or Call shop)
Client Define a client for the report
AccountEnter an account for the report
TagDefine a client's tag
Cards Serial Indicate cards serial for the report
PackageEnter a package for the report
CodeSpecify a code of needed destination
Code NameSpecify a code name of a desired destination
Cost Total Enter the range of total call cost
Call OriginIndicate call origination/termination
Disconnect CodeDefine a disconnect code as a filtering parameter
VoIP GatewaySpecify a VoIP host as filtering criteria
OwnerIndicate the owner
Time Total Enter the range of total calls duration in minutes
Calls TotalEnter the range of  total calls
Calls Not ZeroDefine the range of calls, that have duration equal to or more than 1 second
ASR CurrentSpecify the range of "ASR Cur" for calls you would like to display
ACD CurrentSpecify the range of "ACD Cur" for calls  you would like to display
Output



This form contains settings of the output data of the report.

Click plus sign  near the "Columnsand select columns to output a report data. Also, you can cancel any chosen item.

Accessible columns in the report

There are following columns to add at the report:

Columns for main period:

Average Rate, Cost Total, Calls Not Zero, Calls Success, Calls Busy, Calls No Channel, Calls Error, ASR Std, ASR Cur, ACD Std, ACD Cur, SCD Avg, CDRs List, Time Total, Time Billed, Time Package, PDD Avg, SCD Avg.
 

Columns for comparative period:

Cost Total, Time Total , Time Billed , Time Package, Cost Total , Calls Not Zero , Calls Success , Calls Busy, Calls No Channel, Calls Error, Average Rate, CDRs list, ASR Std, ASR Cur, ACD Std, ACD Cur, PDD Avg, SCD Avg. And it's possible to choose each parameter expressed as percentage.

Rate

The call rate

Avg. Rate - an average call rate that is used

Cost

The cost of the call

  • Cost Total - Full price of calls
  • Setup Fee Cost - Price of an initial fee that is charged.
    Please note, the amount of setup fee is displayed in the reports and invoices no matter if calls were charged by the package or via balance. 
Time

The time of the call

  • Time Total- the whole time of the calls in minutes
  • Time Billed-  the whole billed time
  • Time Package- the time within respective package
Calls

Quantity of calls in database

  • Calls Total- Entire quantity of calls
  • Calls Not Zero - Quantity of calls, that have a duration equal to or more than 1 second
  • Calls Success - Quantity of calls, that have a duration equal to or more than 1 second and successful end code, calls with Q.931, disconnect cause 16 or 31
  • Calls Busy - “Busy” calls quantity
  • Calls No Channel - No circuit / channel available
  • Calls Error - Quantity of declined calls
Statistics

ASR - Average successful rate (successful calls percentage)

  • Std - Number of calls with status "success" divided by the total number of calls minus all calls with “no channel available” status
  • Cur - Number of calls with duration > 0 divided by total number of calls

ACD, min - Average call duration

  • Std - Sum of all call duration divided by number of calls with status "success"
  • Cur - Sum of all call duration divided by number of calls with duration > 0

PDD Avg - Average post dial delay

SCD Avg - Average session connect delay

Extras

CDRs List - list of detailed calls statistics

Other output settings
Order By

Select parameters to sort already grouped data in columns. Here you can sort data from highest to lowest values (or vice versa) and select different values.

Type

Choose a format of the report from a drop-down list: Web/CSV/Excel XLS/Excel XLSx.

Please note, that Grouped type of table view is available only for Excel XLSx and Web formats, it doesn't work with CSV.

Also, select next to the "Type" field a look of table view:

  • Plain - a simple table view
  • Grouped - a table view with grouped data and possibility to collapse it
LimitDetermine the number of rows that will be visible in the report. It is useful for displaying some top positions by chosen parameter. It is available only for plain type of the report. 
Send to

You can send generated reports via e-mail.

For example, it is useful when it takes a lot of time to run the report. Also, it is possible to specify several e-mails.

This feature is available only for CSV/Excel XLS/Excel XLSx formats of the report, it doesn't work with Web.

Currency

Specify a currency for the report. And all values will be automatically converted in the report to the specified currency.

Code Deck

Select a code deck from a drop-down list. All codes in the following report will be presented according to the specified code deck.


After selecting all needed parameters, click “Query” button and the system will generate a report:
 

Screenshot: Summary Report window

If the data is grouped in the report, it will be shown initially collapsed. To expand or collapse data in your report, click the  plus or minus signs.

To expand all data in the report, please press Ctrl + the icon.

Please note, the system shows rounded values in the reports. But while calculating the system takes an exact value. Hence, the procedure of the rounding is following:

  • system rounds currency values according to the settings of a respective currency;
  • the parameters of the time are rounded to the nearest hundredth. For example, 4.8763 to 4.88;
  • and others are rounded to the nearest ten thousandth. For example, 3.879256 to 3.8793.

Simple scheme: how to generate a summary report

In order to create a simple summary report you need to:

  • On the Filters menu, select convenient parameters for the report.
  • Enter the period. 
  • Select some parameters in the "Group By" field, for example, Currency, Leg Origin.
  • Then choose "Columns" in the Output form, for example, Average Rate, ASR Std, ASR Cur, ACD Std, ACD Cur, Calls Total.
  • Leave "Type" Web/Grouped settings by default. 
  • Specify the currency and choose the code deck (if applicable). 
  • Click the "Query" button. 

If you want to sort already grouped data in columns, select respective parameters in "Order By" Also, you can sort from highest to lowest values (or vice versa).

Please note, the "Order By" option is active when the "Type" of the Output form is Plain. When it is Grouped, the data is only sorting by values specified in the "Group By" field.

To create query template

Also, you can create a template for reports and save specified parameters by clicking "Save Query" button.  A pop-up window with settings will appear and you need to fill out the following form:
 

Screenshot: New Template form

SectionDescription
Summary reportHere you can specify parameters for the template that will be used while running reports
TitleSpecify a name of the template
ResellerIndicate a Reseller for the report template
Visibility

It allows controlling visibility of respective reports templates. Whether you want to keep templates private or leave them visible for users under specified Reseller. 

To enable this option, select one parameter from the drop-down list:

  • Public - available for users according to the settings of the "Reseller" field; 
  • Private - accessible strictly for creator.
Watch

This tool allows to generate reports at the appropriate time and send results to the list of e-mails

Please note, that this tool is not available for Web output type, only for CSV/Excel XLS/Excel XLSx.

RecipientsSpecify recipients, you can indicate your own e-mail or other users of the system, or even 3rd parties
Run TimeMention an appropriate time to automatically generate a report, it could be several times, for example: "10:00, 12:00, 18:00"
Days of WeekMention days of a week to automatically generate a report. For example, you can run a report only on Monday or each day of week
Report Query

Here you need to specify filters that will be used for generating correct report and choose the output type to view the report

To load already existed templates while generating statistic reports click "Load Query" button in the Summary Report section

Summary Report toolbar: reports, export, chart.

You can export data to a CSV and XLSx file which contains only currently presented data, no automatic request to update data while exporting. Also, it is possible to create charts for easily illustrating a crucial information. And you can generate a report using the same criteria in the Orig-Term report and the CDRs list sections. 

 1.  To download a report in .csv, click the "Export to CSV"  button on the toolbar.

Please note, this button will be visible only when the "Type" of the output is "Plain". For the"Grouped" output type it is not available.

2. To download a .xlsx fileclick the "Export to XLSx"  button on the toolbar. 

3. To create a visual chart, click the "Show Chart"  button on the toolbar. There is more information available on this topic in the article "How to create a statistic chart?" at our Knowledge Base

4. You can generate a detailed report using the same criteria in the CDRs list by clicking the CDRs list icon  on the toolbar.  

When you make a report based on two periods, two CDRs list icons  appears on the toolbar:

  • the first CDRs list icon  allows to generate a CDR's report based on the first period;
  • the second CDRs list icon  allows to generate data based on the second period in the CDRs list.

When you make a report and filter data by Client/ Client Tags/ Account/ Code/ Code Name/ Owner parameters, two Orig-Term icons  appears on the toolbar. 
They allows to generate reports with origination and termination data separately.

  • this Orig-Term icon  allows to generate a report based on origination data;
  • this Orig-Term icon  allows to generate a report based on termination data.

5. And it is possible to generate a report using the same criteria in the Orig-Term report by clicking the Orig-Term icon  on the toolbar. 

6. You can check an actual date interval by clicking the Info icon  and it could be different from the Interval specified above if there is no date for the period.
 

Screenshot: Summary Report section

 

Side-by-side report

This tool allows building a report with side-by-side sub-reports. Use it to run a comparative analysis on the same page. It's helpful for reviewing multiple parameters, totals and compare results at different time intervals. The "Compare Period" option is designed to create a report that shows two sub-reports side-by-side.

To enable this option, click the plus sign next to the "Period" and specify both intervals (Period 1/Period 2) for the report.

 

Screenshot: Summary Report section

After, choose columns for main and comparative period in the report output form. When all required parameters are specified, click the "Query" button. 

To remove this filter, please click the delete icon 

You can modify a comparative mode by changing periods and columns. For example, to compare how different the cost total of the two periods is in percentage terms. To do this, choose the "Cost Total (%)" value from the Columns. Therefore, the final report splits Cost Total (%) into separate columns (see screenshot below). 
 

Screenshot: Summary Report section

When you select one of Time parameters for Group By, the end date of the Period 2 will be set automatically to make equal intervals of Period 1 and Period 2.

When you use "Compare Period" option in the Summary Report and Orig-Term Report sections, default chart templates will not be accessible.

Knowledge Base Articles


  • No labels