Tool Search: Batch Queue
The Batch Queue tool allows districts/states to generate large, system-intensive reports. It helps prevent report time-out errors and/or system performance issues. General system usage can continue while complex reports are generated within the Batch Queue.
Users with the appropriate tool rights should refer to Batch Queue Admin for the System Administrator version of this tool.
Batch Queue Detail Editor
See the Batch Queue Tool Rights article for information about rights needed to use Batch Queue.
See the Tool Rights article for more information about Tool Rights and how they function.
Submit a report to the Batch Queue
The Batch Queue and Admin Queue tools do not allow users to select a report to generate. Specific reports are generated in the Batch Queue and configured for this option. End users cannot designate which reports include the option to submit to the Batch Queue.
Submitting a Report to the Batch Queue
- Enter all required and desired fields for the report.
- Click Submit to Batch (instead of Generate Report).
- In Batch Queue Reporting Options, select the appropriate options.
- Click OK.
- A Success dialog box appears.
- Click OK to confirm submission.
Result
- The report is added to the Batch Queue and waits until its scheduled date and time.
- The report appears in both the Batch Queue and Admin Queue tools.
- When the report runs, the system distributes the workload across available application servers to maintain performance.
Batch Queue Reporting Field Descriptions
The Batch Queue Reporting Options dialog box contains the following report configuration options:
Field | Description |
|---|---|
High Priority | Mark this checkbox if running this report is considered a high priority. Reports designated as "high priority" by this checkbox will take precedence over other reports in the Batch Queue that are not designated as such. |
Keep Until I Delete | Mark this checkbox if the completed report results should continue to appear on the Batch Queue and Admin Queue tools until manually deleted by a user. If this checkbox is not marked, the completed report will be cleared from the Batch Queue and Admin Queue tools based on the frequency for the Batch Queue Maintenance task set within the Task Scheduler. This checkbox can only be marked if a user has the proper tool right access (i.e., at least Read rights to the Set Task Expiration sub-right located in the Tool Rights index under Ad hoc Reporting > Batch Queue). |
Start Date/Time | Indicate the date and time at which the Batch Queue should begin generating the report. These fields auto-populate with the current date and time. Click in either field to enter a new date. A calendar displays when choosing a new date. Time must be entered in HHMM format, either standard time format (e.g., 2:15 pm) or military time (e.g., 14:15). |
Filter and sort reports in the Batch Queue list
Use these steps to filter and sort reports in the Batch Queue list editor:
Filter reports
- Open the Batch Queue List editor.
- Set the number of tasks to display.
- Specify a date range.
The editor updates to show only reports that match your criteria.
Sort reports
- Click a column header to sort by that field:
- Queued Time
- Report Title
- Username
- Status
- Start Time
- End Time
The list is sorted by the selected column.
View report requests in the Batch Queue
Use these steps to view details for queued and completed reports:
- Open the Batch Queue.
- Locate the report in the list.
You can view details for:
- Completed reports
- Scheduled (future) reports
- Reports currently in progress
Select a report to see its details in the editor.
Users can view details of reports generated by Batch Queue, including completed, scheduled, and currently generating reports.
Batch Queue Detail Field Descriptions
Field | Definition |
|---|---|
Report Title | Name of the report assigned to the Batch Queue. |
Queued Time | Date and time the report was assigned to the Batch Queue. |
Scheduled Time Required | Date and time the report is/was scheduled to begin generation. This field can be modified as necessary. |
Expires After | Last date on which the report is guaranteed to display in the Batch Queue. After this date, the report will be deleted the next time the Batch Queue Maintenance task of the Task Scheduler runs. When a report is deleted from the Batch Queue / Admin Queue, its details will be preserved on the History tab for tracking purposes. |
File Name | Name of the file associated with the report. |
Status | Stage of report completion:
|
Start Time / End Time | When the Status field value is either "Completed" or "Canceled," the time the report began (Start Time) and ended (End Time). |
High Priority | If marked, this checkbox indicates that this report's completion will take priority over other reports scheduled for or occurring simultaneously. This checkbox may be flagged directly on this editor, or it may have been previously flagged on the Batch Queue Options dialog box when the user assigned the report to the Batch Queue. |
Never Expires | If marked, this checkbox indicates that the report will not be automatically deleted from the Batch Queue List editor when it reaches the (crossed-out) date in the Expires After field. This checkbox may be flagged directly on this editor, or it may have been previously flagged on the Batch Queue Options dialog box when a user assigned the report to the Batch Queue. |
Content Type | This field indicates the format of the report:
This field may not appear for all reports. |
User Name | Name of the user who assigned the report to the Batch Queue. |
Download a completed report
Use these steps to download a finished report from the Batch Queue:
- Open the Batch Queue List or Batch Queue Detail editor.
- Locate the completed report.
- Click Get the Report.
The report is available for download to view or save.
The report will be named and formatted as indicated in the File Name field of the Batch Queue Detail editor.
Sample Batch Queue Reports
Delete Reports
The Admin Queue allows a system administrator to delete reports.
- Select the report to be deleted from the Batch Queue List editor.
- Click the Delete or Delete All button from the action bar.
- Click OK.
The report will be removed from the Batch Queue and Batch Queue Admin tools, but will remain with a "Deleted" status in the History tool.
