Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This section is designed to help users create a report that would contain summary information regarding all exsiting services existing services from the perspective of both origination and termination sides. Not only can it provide a general overview of total services cost and billed volumes of service units, but it can be customized to outline even more detailed information regarding different client types, ASR / ACD Current, etc. 

Screenshot: Summary Report query form

Creating a New Summary Report 

To create a new summary report, you need to fill in the following parameters in the form and press click the Query button:

Information block Field Description
Filters

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

You can start a quick search by typing filters' names in the field at the top of a drop-down menu with filters.

Period (1)

Specify the time interval for the report and a timezone. Please note that the Period field is mandatory.

Period 2

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

Group Byby

Select from the list of the following accessible options to group the data in reports:

  • Time: Year, Month, Day, Hour
  • Clients: Client Type, Client, Account, CС Series, Owner, Package Name
  • Events: Code, Code Name, Currency, Rate, Additive Rate, Origin, Result Code, Gateway
  • Totals: Setup Fee
  • Extras: Gateway Tag, Service Name.
Panel
borderColor#ffffb3
bgColor#ffffb3
borderWidth2px

(warning) Attention

  • TheGroup Byby field is mandatory, it couldn't be empty in order to generate the report.
  • If you group by Client, and his/her Timezone differs from the system Timezone, the latter will be used in the respective report.


Additional Filters

The accessible additional filters are:

  • ClientsClient Tags, Client Type, Client, Account, Account Tags, Cards Serial, Package.
  • Events: Code, Code Name, Cost Total, Origin, Result Code, Gateway.
  • Extras: Owner, Total Volume, Total records, Not Zero Records, ASR Current, ACD Current, Service Name.
 
Client TypeSelect a client's type for the report: Client, Reseller, Calling card Card or Call shop
Client Define a client for the report
AccountEnter an account for the report
Client/Account TagsDefine a client's or account'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
OriginIndicate an origin - origination or termination of the event
Result CodeDefine a result code as a filtering parameter
GatewaySpecify a gateway
OwnerIndicate the owner
Total VolumeEnter the range of total duration
Total RecordsEnter the range of  of total records
Not Zero RecordsDefine the range of records that have duration equal to or more than 1 unit
ASR CurrentSpecify the range of ASR Cur for records you would like to display
ACD CurrentSpecify the range of ACD Cur for records you would like to display
Service NameDetermine the name of service for the report
Output



This form contains settings of the report output data.

Click the plus sign next icon next to Columns and select the required columns in order to add them to the Output information block. Also, you can cancel any chosen item.

Accessible columns in the report

The list of additional columns include:

Columns for the main period:

Cost Total, Average Rate, Package Credit, Total Volume, Billed Volume, Package Volume, Total Records, Not Zero Records, Success Records, Busy Records, No Channel Records, Error Records, ASR Std, ASR Cur, ACD Srd, ACD Cur, PDD Avg, SCD Avg, xDRs List.

Columns for the comparative period are the same as for the main period. Moreover, all parameters could be selectedexpressed in percentage.

Rate

Avg. Rate - an average cost calculated

Totals
  • Cost Total - Full  the full price of all services including additional services
  • Total Volume - a whole volume of the events in units (specified in the Services settings → "Reports" field)
  • Billed Volume -  a whole billed volume of events. It could differ from the total volume due to the rates settings, for example, grace volume, min volume, and interval.
  • Package Volume - a volume within a respective package that is billed according to the package limits
  • Package Credit - a volume of credit that has been charged within the respective package
  • Total Events - Entire  the entire quantity of events
  • Not Zero Records - Quantity  the quantity of records , that have the volume equal to or more than 1
  • Success Records - Quantity  the quantity of records , that have a duration equal to or more than 1 and a successful end code, records with Q.931 disconnect cause 16 or 31
  • Busy Records  - Busy  busy records quantity with Q.931 disconnect cause 17
  • No Channel Records - No  no circuit/channel available, records quantity with Q.931 disconnect cause 34
Statistics

ASR - Average success rate (successful records percentage)

  • Std - value calculated on the base of records with status "success" divided by the total number of records minus all records with “no channel available” status
  • Cur - value calculated on the base records with volume > 0 divided by total number of records

ACD - Average call duration in minutes

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

PDD Avg - Average post-dial delay in seconds

SCD Avg - Average session connect delay in seconds

Extras

xDRs List - list of detailed records statistics

Other output settings
Order Byby

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

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

  • Plain - a simple table view
  • Grouped - a table view with grouped data and possibility to collapse it
Panel
borderColor#ffffb3
bgColor#ffffb3
borderWidth2px

(warning) Attention

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


LimitDetermine the number of rows that will be visible in the report. It is useful for displaying some top positions by the chosen parameter. It is available only for the Plain report type of the report
Send to

You can send generated reports via email. Also, it is possible to specify several emails.

Panel
borderColor#ffffb3
bgColor#ffffb3
borderWidth2px

(warning) Attention

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 of the report. All values will be automatically converted in the report to the specified currencyin the report.

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.

The example of the a generated summary report is presented on a screenshot down below:

Screenshot: Summary Report section


If the data is grouped in the report is grouped, it will be shown initially collapsed. To expand or collapse data in your report, click the the Image Modified plus or or Image Modified minus signs minus iconsTo expand all data in the report, please press Ctrl click Ctrl + the icon.

Panel
borderColor#FFBABA
bgColor#FFBABA
borderWidth2px
borderStylesolid

Warning

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 as follows:

  • the system rounds currency values according to the settings of a respective currency
  • all types of events (e.g., not zero, success, busy, as well as total quantity) are not rounded
  • such parameters as Setup Fee Cost, Package Credit, Average Rate, Cost Total are rounded to the nearest ten-thousandth. For example, 3.879256 to 3.8793
  • others are rounded to the nearest hundredth. For example, 4.8763 to 4.88

Simple scheme: how to generate a summary report

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

  • On the Filters menu, select Select desired parameters for the report .on the Filters menu
  • Enter the interval and specify a timezone
  • Select parameters in the Group Byby field, for example, Currency, Origin, etc.
  • Then choose Select Columns in the Output form, for example, Average Rate, ASR Std, ASR Cur, ACD Std, ACD Cur, Total Records, etc.
  • Specify the Type field or leave its default settings (Web/Grouped) 
  • Specify the currency and choose the select a code deck (if applicable). 
  • Press Click the Query button. 
Panel
borderColor#ccffcc
bgColor#ccffcc
borderWidth2px
borderStylesolid
Tip
  • If you want to sort already grouped data in columns, select respective parameters in in the Order Byby field. Also, you can sort from highest to lowest values (or vice versa).
  • Please note, the Order By by option is active when the Type of the Output form is Plain. When it is Grouped, the data is only sorting sorted by values specified in the Group Byby field.

Creating a Query Template

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

...

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

...

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

...

2. To download an .xlsx report file, press click the Export to XLSx  button above the report.

...

Panel
borderColor#ccffcc
bgColor#ccffcc
borderWidth2px
borderStylesolid
Tip

When you make a report based on two periods, two xDRs list icons appear:

  • the first xDRs list icon allows to generate a generating an xDR's report based on the first period;
  • the second xDRs list icon allows to generate generating data based on the second period in the xDRs list.

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

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

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

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

Screenshot: Summary Report section

...

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 on the plus  sign icon next to the Period field and specify both intervals (Period 1/Period 2) for the report.

Screenshot: Summary Report section

Then, choose columns for a main and comparative period in the report Output form. When all required parameters are specified, click the Query button. 

...

Panel
borderColor#ffffb3
bgColor#ffffb3
borderWidth2px

(warning) Attention

  • When you use use the Compare Period option in the Summary Report and Orig-Term Report sections, default chart templates will not be accessible.
  • When you select one of of the Time parameters (Year, Month, Week) for for the Group Byby field, the End date of the Period 2 will be set automatically to make intervals of Period 1 and Period 2 equal. Moreover, the End date Date field of Period 2 becomes non editable.


Knowledge Base Articles

Content by Label
showLabelsfalse
spaces+KB
showSpacefalse
sortmodified
reversetrue
cqllabel = "stats_summary" and space = "KB"
labels+stats_summary