Versions Compared

Old Version 2

changes.mady.by.user Anastasiia Kovalinas

Saved on

compared with

New Version 3

changes.mady.by.user Anastasiia Kovalinas

Saved on

Key

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

...

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, Time Profile
  • Totals: Setup Fee
  • Extras: Gateway Tag, Service Name.

(warning) Attention

TheGroup by field is mandatory, it couldn't be empty in order to generate the report. By default, there must be at least two options: Origin and Service Name.
  • If you group by Client and his/her Timezone differs from the system Timezone, the latter will be used in the respective report.
    • Information block Field Description
    Filters

    On the Filters menu, select the required parameters for the report. To cancel any filter, click on the delete  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 icon next to the Period. Specify the second interval for the report:

    • Previous Period
    • Previous Day
    • Previous Week
    • Previous Month
    • Previous Year
    Tip
    titleHow does the Compare Period work?

    Please make sure you are defining the periods for comparison adequately. That is, for a period of a 'day', select the comparison of a 'day', for a 'month' - a 'month', etc. The general logic of the system in comparison more would be as follows:

    Example 1:

    If you select the Period to be Today 00:00:00 til 23:59:59, the Previous Period and Previous Day values would be the same and show yesterday. The Previous Week option would display the same day last week (i.e., Monday for Monday), the Previous Month option would show the same date last month, and the Previous Year will display the same date last year.

    Example 2:

    If you select the Period to be This Week, the system will take the period starting Monday 00:00:00 and up to 23:59:59 on the current day. That is if your current day is Thursday, This Week would be Monday to Thursday. The comparative periods will work accordingly, selecting the same periods from the past week, month, year. Only the Previous Day option will result in offsetting a period one day behind (if a period is Monday to Thursday, comparative would be Sunday to Wednesday).

    		Group by
    Panel
    borderColor#ffffb3
    bgColor#ffffb3
    borderWidth2px
    Note
    titleNote

    if you select the current month compare to previous
    and group by year
    there will be a strange result - make note "work logically"
    if the grouping is longer than the analysis period, it will be strange
    "when you are grouping by year, it is recommended to indicate the calendar year in the period"
    even without comparison is stupid

    Additional Filters

    The accessible additional filters are:

    • Clients: Client 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 or Call ShopClient Define a client for the reportAccountEnter an account for the reportClient/Account TagsDefine a client's or account's tagCards Serial Indicate cards serial for the reportPackageEnter a package for the reportCodeSpecify a code of the needed destinationCode NameSpecify a code name of the desired destinationCost Total Enter the range of total call costOriginIndicate an origin - origination or termination of the eventResult CodeDefine a result code as a filtering parameterGatewaySpecify a gatewayTime ProfileSpecify the time profile of the eventOwnerIndicate the ownerTotal VolumeEnter the range of total duration Total RecordsEnter the range of total recordsNot Zero RecordsDefine the range of records that have a duration equal to or more than 1 unitASR CurrentSpecify the range of ASR Cur for records you would like to displayACD CurrentSpecify the range of ACD Cur for records you would like to displayService NameDetermine the name of service for the reportOutput

    This form contains settings of the report output data.

    Click the plus Image Removed icon next to Columns and select the required columns 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 - 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 - the entire quantity of events
    • Not Zero Records - the number of records that have the volume equal to or more than 1
    • Success Records - the number 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 records quantity with Q.931 disconnect cause 17
    • No Channel Records - no circuit/channel available, records quantity with Q.931 disconnect cause 34
    Statistics

    ASR - average success rate (successful records percentage)

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

    ACD - average call duration in minutes

    • Std - the sum of all records duration divided by the number of records with "success" status
    • Cur - the 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 settingsOrder 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

    Also, 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 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. 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 to the specified currency in 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 a generated summary report is presented on a screenshot below:

    Screenshot: Summary Report section

    Image Removed

    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 Image Removed plus or Image Removed minus icons. To expand all data in the report, please click Ctrl + the Image Removed icon.

    Panel
    borderColor#FFBABA
    bgColor#FFBABA
    borderWidth2px
    borderStylesolid

    Image Removed 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 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

    To create a simple summary report, you need to:

    • Select desired parameters for the report on the Filters menu
    • Enter the interval and specify a timezone
    • Select parameters in the Group by field, for example, Currency, Origin, etc.
    • 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 select a code deck (if applicable). 
    • Click the Query button. 
    Panel
    borderColor#ccffcc
    bgColor#ccffcc
    borderWidth2px
    borderStylesolid
    Image Removed Tip
    • If you want to sort already grouped data in columns, select respective parameters in the Order by field. 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 sorted by values specified in the Group by field.

    Creating a Query Template

    Also, you can create a template for reports and save specified parameters by clicking 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

    Image Removed

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

    Panel
    borderColor#ccffcc
    bgColor#ccffcc
    borderWidth2px
    borderStylesolid
    Image Removed Tip

    To find more details about templates, please refer to the Report Templates article in our User Guide.  

    Summary Report buttons: reports, export, chart.

    You can export data to a CSV 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 illustrating crucial information easily. You can generate a report using the same criteria in the Orig-Term report and the xDRs list sections. 

    1.  To download a report in .csv, click on the Export to CSVImage Removed button above the report.

    Panel
    borderColor#ffffb3
    bgColor#ffffb3
    borderWidth2px

    (warning)  Attention

    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 report file, click the Export to XLSx Image Removed button above the report.

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

    4. You can generate a detailed report using the same criteria in the xDRs list section by clicking the xDRs list Image Removed icon above the report.  

    ...

    borderColor#ccffcc
    bgColor#ccffcc
    borderWidth2px
    borderStylesolid

    ...

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

    ...

    Group by

    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, Time Profile
    • Totals: Setup Fee
    • Extras: Gateway Tag, Service Name.
    Panel
    borderColor#ffffb3
    bgColor#ffffb3
    borderWidth2px

    (warning) Attention

    • TheGroup by field is mandatory, it couldn't be empty in order to generate the report. By default, there must be at least two options: Origin and Service Name.
    • If you group by Client and his/her Timezone differs from the system Timezone, the latter will be used in the respective report.
    • When you are grouping by year, it is recommended to indicate the calendar year in the period. Same goes for other period types.


    Additional Filters

    The accessible additional filters are:

    • Clients: Client 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 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 the needed destination
    Code NameSpecify a code name of the 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
    Time ProfileSpecify the time profile of the event
    OwnerIndicate the owner
    Total VolumeEnter the range of total duration
    Total RecordsEnter the range of total records
    Not Zero RecordsDefine the range of records that have a 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 Image Added icon next to Columns and select the required columns 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 - 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 - the entire quantity of events
    • Not Zero Records - the number of records that have the volume equal to or more than 1
    • Success Records - the number 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 records quantity with Q.931 disconnect cause 17
    • No Channel Records - no circuit/channel available, records quantity with Q.931 disconnect cause 34
    Statistics

    ASR - average success rate (successful records percentage)

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

    ACD - average call duration in minutes

    • Std - the sum of all records duration divided by the number of records with "success" status
    • Cur - the 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 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

    Also, 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 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. 
    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 to the specified currency in 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 a generated summary report is presented on a screenshot below:

    Screenshot: Summary Report section

    Image Added


    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 Image Added plus or Image Added minus icons. To expand all data in the report, please click Ctrl + the Image Added icon.

    Panel
    borderColor#FFBABA
    bgColor#FFBABA
    borderWidth2px
    borderStylesolid

    Image Added 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 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

    To create a simple summary report, you need to:

    • Select desired parameters for the report on the Filters menu
    • Enter the interval and specify a timezone
    • Select parameters in the Group by field, for example, Currency, Origin, etc.
    • 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 select a code deck (if applicable). 
    • Click the Query button. 
    Panel
    borderColor#ccffcc
    bgColor#ccffcc
    borderWidth2px
    borderStylesolid
    Image Added Tip
    • If you want to sort already grouped data in columns, select respective parameters in the Order by field. 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 sorted by values specified in the Group by field.

    Creating a Query Template

    Also, you can create a template for reports and save specified parameters by clicking 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

    Image Added

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

    Panel
    borderColor#ccffcc
    bgColor#ccffcc
    borderWidth2px
    borderStylesolid
    Image Added Tip

    To find more details about templates, please refer to the Report Templates article in our User Guide.  

    Summary Report buttons: reports, export, chart.

    You can export data to a CSV 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 illustrating crucial information easily. You can generate a report using the same criteria in the Orig-Term report and the xDRs list sections. 

    1.  To download a report in .csv, click on the Export to CSVImage Added button above the report.

    Panel
    borderColor#ffffb3
    bgColor#ffffb3
    borderWidth2px

    (warning)  Attention

    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 report file, click the Export to XLSx Image Added button above the report.

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

    4. You can generate a detailed report using the same criteria in the xDRs list section by clicking the xDRs list Image Added icon above the report.  

    Panel
    borderColor#ccffcc
    bgColor#ccffcc
    borderWidth2px
    borderStylesolid
    Image Added Tip

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

    • the first xDRs list Image Addedicon allows generating an xDRs report based on the first period;
    • the second xDRs listImage Added icon allows 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 Image Added appear. 
    They allow generating reports with origination and termination data separately.

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

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

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

    Screenshot: Summary Report section

    Image Added 

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

    Screenshot: Summary Report section

    Image Added

    Then, choose columns for a 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 Image Added 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

    Image Added

    ...

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

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

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

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

    Screenshot: Summary Report section

    Image Removed 

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

    Screenshot: Summary Report section

    Image Removed

    Then, choose columns for a 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 Image Removed 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

    ...

    Tip
    titleHow does the Compare Period work?

    Please make sure you are defining the periods for comparison adequately. That is, for a period of a 'day', select the comparison of a 'day', for a 'month' - a 'month', etc. The general logic of the system in comparison more would be as follows:

    Example 1:

    If you select the Period to be Today 00:00:00 til 23:59:59, the Previous Period and Previous Day values would be the same and show yesterday. The Previous Week option would display the same day last week (i.e., Monday for Monday), the Previous Month option would show the same date last month, and the Previous Year will display the same date last year.

    Example 2:

    If you select the Period to be This Week, the system will take the period starting Monday 00:00:00 and up to 23:59:59 on the current day. That is if your current day is Thursday, This Week would be Monday to Thursday. The comparative periods will work accordingly, selecting the same periods from the past week, month, year. Only the Previous Day option will result in offsetting a period one day behind (if a period is Monday to Thursday, comparative would be Sunday to Wednesday).



    Panel
    borderColor#ffffb3
    bgColor#ffffb3
    borderWidth2px

    (warning) Attention

    • When you 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 the Time parameters (Year, Month, Week) for the Group by 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 field of Period 2 becomes noneditable.

    ...