Overview
KorWeb now provides the ability to run reports in two different ways: Asynchronous Reporting and Scheduled Reporting. These options provide users the ability to run reports in an efficient, reliable manner, and better maintain oversight into their operations.
This guide will provide an overview of using Asynchronous Reporting and Scheduled Reporting. We will walk through how to run a report asynchronously, where to expect notifications when the report has finished running, and where to access the results of the report once available. We will also walk through using Scheduled Reporting, including scheduling a report to run and accessing results when available.
Asynchronous Reporting
An asynchronous report is run and compiled separately from a user’s KorWeb session, meaning that users will be able to continue to work in KorWeb without having to wait for the report to finish running.
To run a report asynchronously, navigate to the Reports section on the left-hand menu, then choose the report you would like to run from the list of available options.
Once you have identified and selected the report you would like to run, fill out the Report Parameters as desired, and select the green ‘Run Report’ option at the bottom of the screen.
After clicking ‘Run Report’, you will be transferred to the Report History page. This is where you can review reports that are currently processing, as well as download the results of recently run reports.
Once at the Report History page, you can choose to remain on this page and wait for the report to finish processing or continue working in KorWeb and wait to be notified that the results are ready to download. Either way, when the report is ready to be downloaded, you will receive two notifications:
The first notification (pictured above) will be available under the Calendar icon to the left of the Ticket Search bar at the top of the screen. It will appear as a flashing red icon indicating the number of non-acknowledged notifications. Clicking on the Calendar icon will reveal the list of non-acknowledged notifications. You can click on ‘View Report History’ at the top of the notification to be taken to the Report History screen to download the report or you can manually navigate to Report History via the Reports section on the left-hand menu. To clear/acknowledge the Calendar notification simply click on the green ‘Done’ button in the bottom-right corner.
The second notification (pictured above) will appear in the top-right corner of the browsing window and remain until acknowledged using either the ‘View’ button at the bottom of the notification or the ‘X’ button in the top-right corner to close the notification. You can click on ‘View’ at the bottom of the notification to be taken to the Report History screen to download the report.
Once you see these notifications, return to the Report History Screen (either through the notifications as described above or through Reports -> Report History). The Status of your Report will have updated from ‘Processing’ to ‘Succeeded’, and your report will be available for download using the green button on the right side of the record in the list.
Recently run report results will be available for download through the Report History screen. For information on how long these results will be available for download, please contact the KorTerra customer experience team at support@korterra.com or (952) 368-1911 ext. 1.
Scheduled Reporting
Scheduled Reporting allows users to set reports to run on a recurring schedule, allowing for regular delivery of report results to specified users.
To configure a scheduled report, navigate to the Reports section of KorWeb through the left-hand menu. Select the Report you would like to schedule and scroll down to below the Report Criteria and select the “Schedule Report” button.
Once you have clicked the “Schedule Report” button, the “Add Report Schedule” screen will open. Fill out the information at the top of the screen, using a Name and Description to ensure that you’ll be able to identify this report schedule in a list of scheduled reports.
Then, scroll down and fill out the Report Criteria section to filter unwanted results out of the report. Note: The criteria section of the report you are scheduling may appear different than the example used in this guide.
Next, fill out the “Recurrence” section. This will allow you to set how frequently this report is run and controls the date range of the results of the report. For example, a report scheduled to repeat weekly on Mondays will include data from the previous Monday through Sunday, the day before the report is run.
Finally, fill out the Notifications section. This will allow you to set which operators in KorWeb have access to the results of the report and which users or email addresses will receive notification that the reports are ready for download. Please note that you can select multiple values here. For Email addresses, you can use a comma or semi-colon to delineate between the addresses. Once all users and email addresses have been entered, hit the green “Add” button to save the notifications.
Finally, scroll down and select the green “Save” button to schedule the report. Once saved, the Report Schedule will be accessible in Reports -> Report Schedule.
When the report has run and results are ready to be downloaded, you will receive a notification as described above to access and download the report. You can also manually navigate to Reports through the Report History screen or the Report Scheduling screen.
If Email notifications are configured, you can also download the report results by clicking the ‘Here’ link in the email (pictured below).
If you need to edit the report schedule in any way you can do so by going to Reports -> Report Schedule. Find the report in the list and click on the blue edit button on the right:
This will bring you to the Add Report Schedule page described above. You can also access the Report History from the Report Schedule page by clicking the greed schedule button on the right:
Then find the run of the report which has the ‘Scheduled For’/ ‘Completed On’ Dates you are interested in seeing, and click the green Download button at the right of the record: