Reports are a very useful feature of our System, however, to work comfortably with them, you need to know the basic principles of how reports work.
Each report is a script that helps to communicate with the database and receive information directly from there. In many cases, some data is unattainable through a separate interface and can only be obtained using reports. It is recommended to use reports rationally in order to avoid emergency load on the database during reports execution.
For example, some of the most popular reports are EDR export reports, which take data from a DB table with raw EDRs. This table contains all attempts for the time period determined by the system setting Active EDR day count, most often it is 180 days. As you can understand, working with it takes a high load on the System, since the amount of data in the table is extremely huge. Therefore, running these types of reports should be limited to time periods of no more than 1 week. This is the most basic export filter.
Reports may not display all the data, since the report results are limited according to the following System settings:
Report task results rows - defines amount of the rows to be displayed when you are exporting results in the web-interface:
- Max number of rows to export in CSV/Excel (null - without limit) - defines amount of the rows to be exported when you are exporting results in the file
It is important to avoid “cross-running” high-load tasks. That is, for example, if you need to export records for a certain partner for a month, it is better to do this by dividing the interval into smaller periods (weeks) and running tasks sequentially (waiting as soon as the previous one is successfully exported). If you plan to run such uploads regularly, it is better to set up regular exports for which you will need to provide the support team with an FTP source where we will upload data, for example, for the past day every day on an agreed schedule. If you are our hosting client, you can simply create a ticket, and we can set up this regular export for you. For non-hosting client, a confirmation from the account manager is needed before creating the ticket.
Starting from version 3.5.27, when the overall System load is high, in order to prevent task overload, report tasks can be “buffered” and launched as soon as the load subsides. Such queued tasks can be determined by the value “queued due to high load” or “queued due to critical load” in the Task results field. The threshold for this behavior (queuing tasks based on the current load) is configurable only via Alaris support team. Therefore, if it is required to increase them, please reach us, and we'll analyze the possibility of increasing these values.
If you notice issues with the performance of a particular report, for example, a long time to launch a report even for a short-period export, or the web interface freezes when selecting a report, please contact us.
And finally, our team is always happy to help you with the implementation of the required report. Therefore, if you could not find a suitable report on the system, please let us know the expected logic of this report, and we will try to implement it.
Descriptions of almost all the most popular system reports are available in our manual via the following link. To view it, you need to open the Reports submenu:
Conclusion
- specify as many report filters as possible (a period filter should not cover more than a week) in order to export only relevant data and reduce the load on the System;
- for data exports over a long period, please split the report execution into several tasks over smaller time periods and run tasks sequentially, preventing the simultaneous execution of several "heavy" tasks;
- for regular exports of a high-load report, you can contact the support team to set up automatic FTP exports;
- with a high load on the System, report tasks are queued until the load is reduced, you can change the load indicators according to which tasks are queued through the support team.
AKBSMS - Alaris Knowledge Base
How to use reports?
What to do if the report takes a long time to download?
Report queued due to the high load.
What to do if the report results were truncated?
I need information about the report, where can I find it?
What should I do if I haven’t found a suitable report on the system?
Link to this Article: https://helpdesk.alarislabs.com/en/knowledge_base/article/307/category/143/