To generate and save a Residence Units ReportBuilder report that can be re-run in the future, to generate a single-use report, or to use and/or update an existing report format to generate a report, complete the following steps from the AWARDS Home screen:

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

2. Click the Program drop-down arrow in the upper-right corner of the page and select the individual program for which the report is to be run, or select a group of programs using one of the available "All" or "Custom Grouping" selections.
3. If you previously bookmarked the Residence Units ReportBuilder it is displayed on the reports index by default; otherwise, from the left-hand menu bar, click ReportBuilders or All under "Show Reports."
4. Use the navigation features in the bottom-right corner to locate the Residence Units ReportBuilder in the index, or enter "unit" in the Search field in the upper-right corner.
5. Click Residence Units ReportBuilder from the reports index.   The ReportBuilder Settings page is displayed.

6. Report contents are limited to records for residence units that were available (based on First and Last Available Dates within individual residence unit records) at some point during the date range specified using the Availability Date Range on this page.  By default, the availability date range is set for today so that only currently active units are included in the report content.  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.

  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.

7. 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 here detail use of the Residence Units ReportBuilder only, not the corresponding ExportBuilder.  For more information on using ExportBuilders, please click here.

8. 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.

9. 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.

  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.

10. 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 18.

  NOTE: If you chose to send the report to yourself via the Messages module (in step 8), 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 18.

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

11. The Options page contains lists of residence units information and record (data entry) variables grouped by type.  Click the checkbox next to each variable to be included in the report, and/or use the available Check All options as needed.
12. Click CONTINUE.  The Report Options - Continued page is displayed.
13. Configure 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.

14. To save the report settings so that this report can easily be re-run 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 wish only to view the report contents, please skip to step 18.

15. 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.

16. Click Save Report Format.  The report format is saved and the Report Options - Continued page is re-displayed.
17. 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 8), a notice is first displayed on the page to let you know that the 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 18.

18. At this time 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.  For more information on working with ReportBuilder report contents, please click here.

The process of generating a Residence Units ReportBuilder report is now complete.

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