Orig-Term Report
Section overview​
This section is designed to provide a user with a possibility to generate a report and trace all call routes from a Client to any Provider with orig-term cost and profit. Here you can create a report based on an existing template or generate a new one. Also, you can get the information sorted by Clients, Events, Profit, etc.
Creating a new Orig-Term Report​
To create a new Orig-Term report, you need to fill in the following parameters in the form and click the "Query" button:
Filters​
On the Filters menu, select the required parameters for the report. To cancel any filter, click 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.
| Field | Description |
|---|---|
| Interval | Specify the time interval for the report and a timezone. Please note that the Interval field is mandatory. |
| Compare to | Accessible when you enable the Compare to option by clicking on the plus icon next to the Interval. Specify the second interval for the report. |
| Group by | There are the following accessible options to group the data in reports: - Time: Year, Month, Date, Hour - Clients: Orig Company, Orig Legal Entity, Orig Owner User, Orig Client, Orig Client Type, Orig Account, Term Company, Term Legal Entity, Term Owner User, Term Client, Term Client Type, Term Account - Events: Orig Code, Orig Code Name, Orig Code Country, Orig Origin Name, Orig Rate, Term Code, Term Code Name, Term Code Country, Term Origin Name, Term Rate, Service, Orig Time profile, Term Time profile |
When you select one of the Time parameters for Group by, the end date of Interval 2 will be set automatically to make equal intervals.
Please note that the Group by field is mandatory; it cannot be empty when generating the report.
Additional filters​
The following additional filters are available:
Clients​
| Field | Description |
|---|---|
| Orig Company | Define an origination Reseller for the report. Accepts multiple values. |
| Orig Legal Entity | Define an origination Legal Entity for the report |
| Orig Owner User | Define a User who owns origination Clients |
| Orig Client | Define an origination Client for the report |
| Orig Client Type | Determine the type of origination client: Client, Reseller, Calling Card, Call Shop |
| Orig Client Tags | Determine tags that belong to an origination client |
| Orig Account | Enter an origination account for the report |
| Orig Account Tags | Specify tags determined for an origination account |
| Term Company | Define a Reseller for the report. Accepts multiple values. |
| Term Legal Entity | Define a termination Legal Entity for the report |
| Term Owner User | Define a User who owns termination Clients |
| Term Client | Define a termination client for the report |
| Term Client Type | Determine the type of termination client: Client, Reseller, Calling Card, Call Shop |
| Term Client Tags | Determine tags that belong to a termination client |
| Term Account | Enter a termination account for the report |
| Term Account Tags | Specify tags determined for a termination account |
Events​
| Field | Description |
|---|---|
| Service | Determine the name of service for the report |
| Match Orig Client | Search for matched/mismatched origination clients |
| Match Orig Rate | Search for matched/mismatched origination rates |
| Orig Dst Code | Specify an origination code for the report |
| Orig Dst Code Name | Indicate an origination code name |
| Orig Dst Code Country | Indicate an origination country name |
| Orig Src Code | Specify an origination source code for the report |
| Orig Src Code Name | Indicate an origination source code name |
| Orig Src Code Country | Indicate an origination source country name |
| Orig Origin Name | Indicate an origination origin name |
| Orig Rate (avg) | Enter the range of average call rate for origination |
| Orig Time Profile | Select an orig time profile that will be used as filter criteria |
| Match Term Client | Search for matched/mismatched termination clients |
| Match Term Rate | Search for matched/mismatched termination rates |
| Term Dst Code | Specify a termination code for the report |
| Term Dst Code Name | Indicate a termination code name |
| Term Dst Code Country | Indicate a termination country name |
| Term Src Code | Specify a termination source code for the report |
| Term Src Code Name | Indicate a termination source code name |
| Term Src Code Country | Indicate a termination source country name |
| Term Origin Name | Indicate a termination origin name |
| Term Rate (avg) | Enter the range of average call rate for termination |
| Term Time Profile | Specify a term time profile that will be used as filter criteria |
Statistics​
| Field | Description |
|---|---|
| ASR Std | Specify the range of ASR Std for events you would like to display |
| ASR Current | Specify the range of ASR Cur for events you would like to display |
| ACD Std | Specify the range of ACD Std for events you would like to display |
| ACD Current | Specify the range of ACD Cur for events you would like to display |
Totals​
| Field | Description |
|---|---|
| Volume Total | Enter the range of total volume of services |
| Orig Volume Billed | Enter the range of orig volume of billed services |
| Term Volume Billed | Enter the range of term volume of billed services |
| Profit (abs) | Enter the absolute profit range |
| Profit (rel) | Enter the relative profit range |
| Margin | Enter the margin range |
| Total Records | Enter the range of total events |
| Not Zero Records | Define the range of events, that have a duration greater than 0 |
| Success Records | Define the range of successful events |
| Busy Records | Define the range of busy events |
| No Channel Records | Define the range of no channel events |
| Error Records | Define the range of error events |
Output​
This section contains settings of the output data of the report.
Click the plus icon near the Columns to select respective columns to output a report data. Also, you can cancel any chosen item.
Accessible columns in the report​
Columns for the main interval are: ASR Std, ASR Cur, ACD Std, ACD Cur, Total Volume, Profit (abs), Profit (rel), Orig Billed Volume, Orig Cost, Orig Rate (avg), Term Billed Volume, Term Cost, Term Rate (avg), Total Events, Not Zero, Busy, No Channel, Success, Error, Margin.
Columns for the comparative interval are the same as for the main period. Moreover, all parameters could be selected expressed in percentage.
| Column | Description |
|---|---|
| Orig Billed Volume | Billed event volume (origination) |
| Orig Cost | Price of the event (origination) |
| Orig Rate (avg) | Average event rate (origination) |
| Term Billed Volume | Billed event volume (termination) |
| Term Cost | Event cost (termination) |
| Term Rate (avg) | Average event rate (termination) |
| Profit (abs) | Revenue in respective currency, for example, USD (in fact, any system currency can be specified here) |
| Profit (rel) | Revenue in percent value |
| Total Volume | The total volume of services |
| Margin | The absolute value of profit divided by volume billed (orig and term) |
| ASR Std | Average successful rate: number of events with success status divided by the total number of events minus all events with no channel available status |
| ASR Cur | Average successful rate: number of events with duration > 0 divided by the total number of events |
| ACD Std | Average call duration: sum of all event duration divided by the number of events with success status |
| ACD Cur | Average call duration: sum of all event duration divided by the number of events with a duration > 0 |
| Total Events | Total events quantity |
| Not Zero | Quantity of events that have a duration equal to or more than 1 second |
| Success | Quantity of events that have a duration equal to or more than 1 second and a successful end code, events with Q.931, disconnect cause 16 or 31 |
| Error | Quantity of declined events |
| Busy | Busy events quantity |
| No Channel | No circuit/channel available. Events with Q.931, disconnect cause 34 |
Other output settings​
| Field | Description |
|---|---|
| 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: - Grouped - a table view with grouped data and possibility to collapse it - Plain - a simple table view - Plain with total - a simple table view with an additional Total row at the beginning of the report |
| Limit | Determine 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 plain and plain with total types of the report. |
| Send to | You can send generated reports via email. Also, it is possible to specify several emails. Available only for CSV/Excel XLS/Excel XLSx formats; it doesn't work with Web. |
| Currency | Specify a currency for 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. |
Please note, that the Grouped type of table view is available only for Excel XLSx and Web formats; it doesn't work with CSV.
A generated orig-term report is demonstrated on a screenshot below:
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 icon. To expand all data in the report, please click Ctrl and plus icon.
Please note, the system shows rounded values in the reports. However, 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 Orig Avg Rate, Term Avg Rate, Profit, Term Cost 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 an orig-term report​
An easy way to generate a simple orig-term report is:
- Select the desired parameters for the report on the Filters menu.
- Enter the period.
- Select some parameters in the Group by field, for example, Orig Client, Service.
- Select Columns in the Output form, for example, ASR Std, ASR Cur, ACD Std, ACD Cur, Success, Error, Profit (%).
- Specify the Type field or leave its default settings (Web/Grouped).
- 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 the 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 or Plain with Total. When it is Grouped, the data is only sorting by values specified in the Group by field.
You can also sort data in a report manually using special arrows next to the name of the respective columns.
Creating reports templates​
You can also create a template for reports and save specified parameters by clicking the "Save Query" button. A pop-up window with settings will appear and you will need to fill out the following form:
To find more details about templates, please refer to the Report Queries article in our User Guide.
Orig-Term report buttons - reports, export, chart​
You can export data to a CSV or XLSx file, which contains only currently displayed data, no automatic request to update data while exporting. Also, it is possible to create charts for illustrating crucial information easily. And you can generate a report using the same criteria in the Summary report and the xDRs list sections.
- To expand/collapse all the data for the Grouped output, click on the plus icon above the report.
- To download a report in .csv, click on the Export to CSV
button above the report.
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.
- To download a .xlsx file, click on the Export to XLSx
button above the report. - To create a visual chart, click on the Show Chart
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. - You can generate a detailed report using the same criteria in the xDRs list section by clicking the xDRs list
icon above the report. - And it is possible to generate a report using the same criteria in the Summary report section by clicking the Summary
icon on the toolbar. - You can check an actual date interval by clicking on the Info
icon. The displayed data could be different from the Interval specified above if there is no data for the period.
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 to option is designed to create a report that shows two sub-reports side-by-side.
To enable this option, click the plus icon next to the Interval field and specify both intervals for the report.
Afterwards, choose columns for the 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).
Sharing a report​
Each time you get a report output, the system generates a unique link in the format of /view?id=<uniq-string>. It allows sharing data between the users, even if they belong to different resellers (the feature works similarly to Share by Link in Google Drive).
The link refers to the report data valid for a specific moment.
When you send a link to a report, you ensure the recipient would see the same data as you do. If you change data in the system (for example, perform rerating), the previously copied link to the report will display data valid for the moment of generation (even though the actual data is now different).
You can also view the additional information about the generated report by hovering over the Info icon, which is located under the Output section:
| Title | Description |
|---|---|
| Data Interval | States the period set for a report |
| Generated by | Indicates the Role of the user who generated a report and specifies a generation time |
| Duration | Time spent to generate a report |