Search

What is a Queued Report and how do I use them?

Environment:

Analytics, Queued Reports

Resolution:

Reports may require a great deal of time to run depending on the amount of data that they search and subsequently return. To help you better manage reports which operate on large data sets, there is an option to queue reports. Report queuing allows you to begin running a report and come back later to receive the results.

Note: Once a report has been designated to run as a queued report, all future runs of that report will run in a queued fashion until a user edits the report and changes it to run immediately.

Using Queued Reports:

If you would like to manually queue a report, simply right click on the report and choose “Queue.”

Reports which take a long time to return data will automatically present you with the option to queue the report. If your report exceeds a configured time limit (default is 60 seconds) to return data, or if the results exceed a configured size limit for the data set, you will be presented with a message allowing you to queue the report:

Once you have chosen to queue the report, you will be asked for the parameters to run the queued report with.

Once the parameters are selected, you will be presented with an estimate of the time it will take to run the query.

Once the report is ready you will receive a notification if they are enabled. For more information on Notifications, please see Answer ID 1835: Staff notifications and email sent to staff.

Pop up or Toast Notification:

You can view your notifications:

You can right-click on the row in the notification and select Open > Queued Report to open the report:

The report data is then displayed:

You can also open queued reports using the “My Queued Reports” report, which is a standard report found in Common > Site Administration > Reports > My Queued Reports:

You can right-click on a row and select “Open” to open the queued report:

Other notes on queued reports

Keep in mind that when you open a queued report, you are looking at a stored snapshot of the data. If changes happen to the data after it has been stored, you will need to run the report again to see those changes.

If your site is configured to use the replication server, please keep the following considerations in mind when running and queuing reports:

• Any reports you queue will automatically run on the report server unless the report is always configured to run on the production server.  You can configure this option by editing the report and selecting Home tab > Options drop-down > More options… > Data Source option:  Report Database or Operational (production) database.
  
  
• When you attempt to run a report, the Oracle B2C Service application checks the database query generated by the report.  If it is determined the query will take longer than ten seconds to run, the report will run on the report server unless the report is configured to run on the production server.  If the query will take longer than sixty seconds to run, you will be given the option to queue the report or run the report again using different search parameters.
  
  
• If your report has previously exceeded the configured time limit and been queued, it will automatically be queued unless it processes only a small number of rows. If you edit the report, you will clear this and queuing will be based on the time limit again.

It is possible that a report you queue will not run successfully.  There are several reasons why this might happen:

• You already queued the report using the same search parameters and the first queued report has not yet run.
  
  
• The original report you queued was deleted after you queued it and before the queued report could be processed.
  
  
• The report is deleted from the queue by another staff member before the report can be run and you can view it.  However, only the staff member who queues the report and staff members with the Analytics Administrator profile permissions can remove reports from the queue.
  
  
• The queued report processes, but is not opened within the number of days specified within the PURGE_QUEUED_REPORT_DAYS configuration setting.  Queued reports and dashboards that have been run but not opened within this time period are automatically removed.  The default value for this setting is seven days.
  
  
• You manually queue a report or dashboard that cannot run due to the query surpassing a limit on the number of database rows that can be accessed.
  
  

For more information, refer to the 'Queuing reports' section in online documentation for the version your site is currently running.  To access Oracle B2C Service manuals and documentation online, refer to the Documentation for Oracle B2C Service Products.