Report Purpose and Summary

ESG CAPER uploads are required at regular intervals set by the Department of Housing and Urban development. This guide will show you the steps to follow in HMIS to retrieve the file to upload to your SAGE.


Make sure you are operating in Clarity under the agency you are running the report for. You can check and change this under your name in the top right corner.

Step 1: Click on the Launchpad, then click on the Reports icon. 

Step 2: In the Report Library, click the down arrow next to the HUD Reports folder to expand the section.  

Step 3: Click the Run button next to [HUDX-228] ESG Caper.

Reporting Parameters

Step 4: Enter the following parameters. The following parameters apply to both RHY and SSVF requests.

Switch Access Agency(-ies) Select your agency
CoC Filter Category Select ‘Agency CoC’
CoC(s) Select CoC(s) the program is in (hold either control/command/shift button to select multiple)
Program Type(s) Choose the Program Type(s) to include (hold either control/command/shift button to select multiple)
Program Status Select ‘Active Programs’
Program(s) Choose Program(s) to include (hold either control/command/shift button to select multiple)
Apply Client Location Filter Select ‘No’
Federal Funding Source Criteria Choose Based on Federal Fund Source (for ESG programs) / Active Fundings / HUD: ESG [funding type] or
Choose Not Based on Federal Fund Source for any project
Funding Criteria Choose ‘Not Based on Federal Fund Source’
Report Date Range Choose Start Date and End Date of reporting period
Report Output Format Select *Web Page, PDF, Excel, or CSV-Upload; Choose CSV-Upload for upload to SAGE
Report Drilldown Output Format Select Web Page, PDF or CSV

*Drilldown Functionality is available when run in Web Page Format

Step 5: Click submit

The file will be sent to the  Report Queue. Once the report is processed, you will receive a notification that the report is ready.

To open the report, either select  Open on the popup or click the Queue icon and then click Open.

Step 6: Save the .csv file on your computer and upload the file to the appropriate repository.

Important Note: Do not open or alter any of the information in the .csv file.

Reporting Details

Submitting the Report to Sage

Once the report has been cleared of all errors that can be cleared, you are ready to submit the report in SAGE.

To submit the report to SAGE:

  1. Reporting date ranges for Sage Uploads
    1. State ESG: 4/1 - 3/31
    2. City ESG: 1/1 - 12/31
  2. Choose CSV-Upload as the Report Output
  3. Click download and save report to a folder you will be able to retrieve it from.
  4. The report downloads to a CSV file that is required for upload to SAGE. 

If you'd like to save the report as you see on the screen for other purposes, right click and click print.  You will be able to change the printer option to Save As PDF.

Recorded Training:

Password: Clarity

Related Resources: 

ESG Street Outreach Data Entry Workflow

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.