When initiating a process in AWARDS that doesn't happen instantly (for instance, running a long report or generating a large ReportBuilder report, sending a report to Messages, importing or exporting data, or transmitting a message to a RHIO), that process is sent to a queue.  The Queue ReportBuilder, located in the Reports module, enables you to monitor the status of and manage these processes.  While such management is not necessary - all queued items are set to complete without oversight - using this ReportBuilder tool can be helpful when, for example, you'd like to confirm whether or not a report you are running is still in process.

  NOTE: All users have access to the Queue ReportBuilder by default; however, each user can only see processes/reports that they themselves set to the queue.  In order to see and manage processes/reports sent to the queue by any user, you must be granted additional authority by Foothold Technology.  If you require this level of access, please contact the Help Desk for assistance.

To use the Queue ReportBuilder to generate a report of queued items, complete the following steps:

  TIP: Know how to run this report but looking for details on the information it contains?  Skip down to A Closer Look @ Queue ReportBuilder Contents at the bottom of this page.

1. From the navigation bar, click Reports (or click the Reports icon).  The Reports index is displayed.

2. If you previously bookmarked the Queue ReportBuilder it is displayed on the reports index by default; otherwise, from the left-hand menu bar, click ReportBuilders or All under "Show Reports."
3. Use the navigation features in the bottom-right corner to locate the Queue ReportBuilder in the index, or enter "queue" in the Search field in the upper-right corner.
4. Click Queue ReportBuilder from the reports index.  The Queue ReportBuilder Settings page is displayed.

5. Report contents are limited to records for items active in the queue at some point during the date range specified using the Queue Date Range fields on this page.  By default, the date range is set for today.  If necessary, make changes to that default date range by using the available From and To fields/date pickers.  When doing so please keep in mind that a two year period of your choosing is the maximum length of time for which the report can be run.

  TIP: If a process starts running before the From date, but it was still active during the date range, that process will be included in the report.

  NOTE: In the event that you are creating a new report that will be saved, or if you will be using an existing report format that was saved previously, please be aware that the date range set here is not saved with reports.  You must specify one each time the report is run. 

6. Leave the Provide ExportBuilder Options checkbox unchecked.  It is NOT relevant to report generation.

  NOTE: This option is used to provide access to an ExportBuilder corresponding to the ReportBuilder with which you are working.  AWARDS ExportBuilders - which are designed for use by individuals who are familiar with export files and formats, their design, and setup - harness the power of ReportBuilder functionality and take it a step further to meet a variety of outside reporting needs.  With ExportBuilders users can create customized data reports as they would with the ReportBuilder itself, and from those reports generate export files of a number of different types - CSV, TXT, XLS, or XML.  Exported files can be saved to your computer, then uploaded into other data collection systems and/or worked with in other applications as needed.  Additionally, as can be done with ReportBuilders, ExportBuilder formats can be saved and shared for future use.

The instructions provided in this portion of Online Help detail use of the Queue ReportBuilder only, not the corresponding ExportBuilder.  For more information on using ExportBuilders, please refer to the corresponding portion of Online Help.

7. If you would like the report (both its content and an Excel file version) to be sent to your AWARDS Messages module upon its completion, click the Send in AWARDS Message checkbox.  When this option is selected, you need not wait for the report to generate, and can navigate away from the ReportBuilder after finishing the configuration process.  This can be a time-saver, especially when working with reports containing large amounts of data that might otherwise take a while to display in AWARDS.

  NOTE: When using this option the report will remain in your messages for one month, after which time it will be deleted.  (The exact date of deletion will be displayed in red at the top of the report message for your reference.)  If you know you will need the report content after that time, be sure to download the Excel file (Excel File.zip) or HTML content (Report Content.html) attached to the report message.  If you don't download one of these attachments before the message is deleted, you will need to manually re-generate the report if you need access to it in the future. 

8. Use the Select a saved report format drop-down options at the bottom of the page to specify whether you will be generating the report from scratch or using a previously saved format.  Available choices are to:

  Use a previously saved report format - To generate the report using a previously created and saved format, select that format from this drop-down.  When using this method, you can immediately generate the report without changing any settings.  Alternately, you can first review and modify the settings of the format by checking off the available "Provide option to modify settings of saved report format" checkbox.

  TIP: A Foothold-created saved report format - "Foothold Queue Report" - is available in this selection list to provide quick and easy access to queue management.

  Start from scratch, without using a previously saved report format - To create your own report format for single-time use or for saving and later re-use, leave the saved report format drop-down blank.

9. Click CONTINUE.

If you are using an existing report format and have NOT chosen to view/modify the settings of that format, you are now taken directly to the report page.  Continue with step 17.

  NOTE: If you chose to send the report to yourself via the Messages module (in step 7), a notice is first displayed on the page to let you know that report generation is in process and that the report will be sent to your Messages module upon completion.  You can then navigate away from the page, or wait for the report to complete and then proceed with step 17. If you did NOT set that option, you can do so now by clicking Send to AWARDS Messages.

In all other instances, the Options page is displayed.  Continue with step 10.

10. Click the checkbox next to each data variable to be included in the report, and/or use the available Check All options as needed.
11. Click CONTINUE.  The Report Options - Continued page is displayed.
12. Configure or make changes to the options in the "Filter Options" portion of the page as necessary to adjust the scope of the report contents.  Set the "Show Individual Detail" and/or "Summary Tables" options to adjust the way in which the contents are displayed.

  TIP: Individual detail report options and/or summary table selections must be set before the report can be generated.  For more information on using the various report options, please click here.

13. To save the settings made on this and the previous pages so that the report can easily be re-generated in the future, click SAVE REPORT FORMAT.  The Save Report Format dialog box is displayed.

  TIP: If it is not necessary to save the report format and you only want to generate the report itself, skip to step 16.

14. Configure the fields and options on this dialog box to indicate the specifics of how the format should be saved.

  TIP: For more information on using the save report format options, please click here.

15. Click Save Report Format.  The report format is saved and the Report Options - Continued page is re-displayed.
16. Click DISPLAY REPORT.  The report is generated and displayed on the ReportBuilder page.

  NOTE: If you chose to send the report to yourself via the Messages module (in step 7), a notice is first displayed on the page to let you know that report generation is in process and that the report will be sent to your Messages module upon completion.  You can then navigate away from the page, or wait for the report to complete and then proceed with step 17. If you did NOT set that option, you can do so now by clicking Send to AWARDS Messages.

17. At this time, as with all ReportBuilders, the individual detail and/or summary table content can be hidden or sorted as needed.  The report can also be printed or exported to Microsoft Excel. 

  TIP: For more information on working with ReportBuilder report contents, please click here.

  TIP: For more information on the specific contents of the Queue ReportBuilder, click here.

In addition, if there is a report or process with a Status of "Waiting" or "Running," that item can be canceled if needed.  To do so, click Cancel in the far right column of the report.  A confirmation pop-up is displayed.  Click Yes to proceed with the cancel, or No to return to the queue.  If an item is canceled, the page is refreshed to reflect the new status of "Canceled."

The process of generating a Queue ReportBuilder report is now complete.

A Closer Look @ Queue ReportBuilder Contents

The following is an alphabetical list of the data variables available for inclusion in Queue ReportBuilder reports, providing a detailed look at what each variable reports on and where the corresponding information is pulled from.

Create Date and Create Time

The date and time at which the worker sent the report/process to the queue.

Duration

The length of time between when the report/process started running and completed, if applicable.

End Date and End Time

The date and time at which the report/process completed, if applicable.

Name (Last First)

The name of the AWARDS user who ran the report/process.

Queue ID

A unique number assigned to each item in the report, for reference purposes.

Start Date and Start Time

The date and time at which the report/process started running, if applicable.

Status

Each process/report has a status listed for it - Completed, Unexpected Termination, Running, Waiting, or Canceled - reflecting the status at the time the Queue ReportBuilder was run.  Please keep in mind that the report contents are not automatically refreshed to show status changes (for example, that a running report has completed); instead, you will need to re-run the Queue ReportBuilder to check for updated status information.

If there is a report or process with a Status of "Waiting" or "Running," that item can be canceled if needed.  To do so, click Cancel in the far right column of the report.  A confirmation pop-up is displayed.  Click Yes to proceed with the cancel, or No to return to the queue.  If an item is canceled, the page is refreshed to reflect the new status of "Canceled."

Title

The report name and parameters for hard-coded reports.  For ReportBuilders, this includes the type of ReportBuilder and the name of the saved report (if applicable).

Type

Reflects the type of report/process in the queue - either Personal or System Wide.

  Personal Types:

- On screen report - When a report is run and the user waits for it to display on the page

- Email output - When the "Send to Messages" option is used for a report

  System Wide Types:

- Email output (database wide) - When the "Send to Messages" option is used for a report that is restricted to run one at a time in the database (applies only to the HMIS LSA)

- Import tools

- HMIS export

- HMIS import

- HMIS upload validation

- HMIS upload export

- HMIS upload import

For each queue type, each user can have one instance of each report/ReportBuilder/process running at a time; all others that the user has submitted that are of the same queue type will wait for the previous one to finish before running.  For example, if a user runs a Demographics ReportBuilder using the "Send to Messages" option, and the runs another Demographics ReportBuilder and waits for the content to display on the screen, starting them one after another, both will run simultaneously.  If, however, a user runs a Demographics ReportBuilder using the "Send to Messages" option, and then runs Progress Notes ReportBuilder using the "Send to Messages" option, starting them one after the other, the second ReportBuilder will have a status of "Waiting" until the first one completes because they are of the same queue type.

Additionally, for system wide types, the system will only have one instance of each report/process running at a time.  If a user starts a report that is email output (database wide), and then another worker submits a report of the same type, the system waits for the first to finish before starting the second.  The same rule applies to import tools and the HMIS export, import, and upload queue types; the process of those specific queue types run by one worker must finish before the same queue type of another worker will start.

Wait Time

The amount of time between when the worker set the process/report to the queue, and when it started running.

  https://demodb.footholdtechnology.com/help/?12250