Skip to content
  • There are no suggestions because the search field is empty.

[GNRL-411] Clarity CSV Export

The Clarity CSV Export report lets users generate filtered, access-controlled data extracts in the Clarity CSV format.

The functionality described in the article will be available on training sites on June 2, 2026, and on production sites on June 16, 2026.

Table of Contents

Purpose

The Clarity CSV Export report generates bulk data extracts in the Clarity CSV format, aligned with the latest fully published Clarity CSV on the Web (CSVW) metadata schema. Users can filter the export by Date Range and Program, with row‑level access controls ensuring only data they are authorized to view is included.

This report is designed to replace the legacy Clarity XML export, supporting downstream DIT import and other interoperability workflows on the standardized Clarity CSV specification.

Running the Report

Who Can Run the Report

This report is available to System Administrators and Agency Administrators. Row-level access controls are applied to ensure users only export data they are authorized to view.

Report Location

This report can be found in the following locations in the Report Library:

      Parameters

      The following parameters are required to run this report.

      Parameter Description
      Switch Access Agency(-ies)

      This option allows a user to generate this report for programs from multiple agencies.

      Some community initiatives require this capability. The ability is dependent on the access rights of the user. In other words, the user must have access to more than one agency.

      The list of agencies will include the user's primary or home agency, followed by other agencies to which the user has access.

      CoC Filter Category

      There are four levels of CoC filtering available. Only one option may be selected for each report:

      • Agency CoC: The report will only pull from Agencies with the selected CoC 
      • Program CoC: The report will only pull from Programs/Projects with the selected CoC
      • Site CoC: The report will only pull from Sites with the selected CoC
      • Inventory CoC: The report will only pull from Bed Inventories with the selected CoC(s). Note: Choosing this option will limit the report to only those projects with Bed Inventories.
              CoC(s)

              Choose which CoC(s) to include:

              All, Single Select, or Multi-Select (Hold Control/Command or Hold Shift to select multiple options sequentially.)

              Project Type(s)

              Choose which project type(s) to include:

              None, All, Single Select, or Multi-Select (Hold Control/Command or Hold Shift to select multiple options sequentially.)

              Note: Selecting None allows users to select No Project Type, resulting in no program-based enrollment information being exported.

              Program Status
              • All Programs
              • Active Programs
              • Inactive Programs
                    Program(s)

                    Choose which program(s) to include:

                    None, All, Single Select, or Multi-Select (Hold Control/Command or Hold Shift to select multiple options sequentially.)

                    Note: Selecting None allows users to select No Programs, resulting in no program-based enrollment information being exported.
                    Include CSV File(s)

                    Choose which CSV File(s) to include:

                    • None
                    • All
                    • ClarityClient.csv
                    • ClarityEnrollment.csv
                    • ClarityClientAssessment.csv
                    • ClarityClientService.csv
                    • ClarityClientExpense.csv
                    • ClarityServiceAttendance.csv

                                    Note: The ClarityExport.csv file will always generate and return in the [GNRL-411(-AD)] Clarity CSV Export Report Output.
                                        Apply Enrollment CoC Filter

                                        The Enrollment CoC Filter defaults to No. If 'Yes', the data export will exclude client project stays that do not align with the Enrollment CoC Code(s) and the selected CoC(s).

                                        Note: The Enrollment CoC applies only to valid Heads of Household; this report will process this information even when the HoH is not included in the Report Universe, ensuring that Household Members who qualify for the Report Universe are included with the applicable information.
                                        Client ID Selection

                                        Select Clarity Client ID (default) or HUD Unduplicated Personal ID. To learn more about the impacts of this parameter, review the Parameter Spotlight: Client ID Selection article.

                                        The PersonalID column will capture the selected prompt from the Client ID Selection parameter (PersonalID will return Client ID if Clarity Client ID  is selected. The 32-character Personal ID will be returned in the PersonalID column if HUD Unduplicated Personal ID is selected.)

                                        Note: If using the report for integration/import, ensure the correct Client ID is selected, and that the source mapping aligns for accurate data matching. 

                                        Include Deleted Data

                                        If Yes, the export process includes deleted Clarity records in the exported data.

                                        Include Standalone Client Records (non-Enrollment)

                                        If Yes, the export process includes non-Enrollment Linked, or Global records.

                                        Report Date Range

                                        Choose the date range of data to include.

                                        Note: The Report Date Range is restricted to a length of time no longer than 10 years.

                                        Additional Admin Parameters

                                        Parameter Description
                                        Agency Filter Category See CoC Filter Category above.
                                        Agency Status
                                        • All Agencies
                                        • Active Agencies
                                        • Inactive Agencies
                                              Agency(-ies)

                                              Choose which agencies to include:

                                              All, Single Select, or Multi-Select (Hold Control/Command or Hold Shift to select multiple options sequentially.)

                                              Report Details

                                              Specifications

                                              The report generates a ZIP file containing the selected CSV data and a mandatory ClarityExport.csv index file. To ensure data integrity and schema alignment, the export strictly adheres to the latest Clarity CSVW schema, which defines the field output, data types (e.g., Dates as YYYY-MM-DD), and picklist integers. For a deep dive into the file structure and schema details, refer to the [Customer Facing Specifications] and the [CSVW Schema] documentation.

                                              The export dynamically appends custom Client, Enrollment, Service, and Assessment fields to the end of the files based on the latest metadata.json from the DIT Schema Editor.

                                              Processing & Delivery

                                              This report runs asynchronously. Once submitted, you can monitor the status (Pending, Processing, or Processed) and download the final ZIP file directly from the Export Tasks screen. For detailed instructions on the import process, see the [PTR-1707 documentation].

                                              Universe

                                              The export processes data across core Clarity modules, including Client Profiles, Program Enrollments (Entry, Exit, and Annual Assessments), Client Assessments, and Client Services. To be included in the report universe, a client must have activity within the report date range, utilizing Information Date, Date Created, and Date Updated for included data.

                                              Report Output

                                              The report will produce a Zipped CSV file dependent on the established latest published schema. The generated export may include the following tables based on user selection in the Include CSV Files parameter:

                                              • ClarityExport.csv: The index/header file for the export set. This file will always return when running this report.
                                              • ClarityClient.csv: Client Profile and custom Client Profile elements.
                                              • ClarityEnrollment.csv: Program enrollment data collection stages and related custom elements.
                                              • ClarityClientAssessment.csv: Standard and custom client assessment questions.
                                              • ClarityClientService.csv: General service provision data.
                                              • ClarityServiceExpense.csv: Financial service details.
                                              • ClarityServiceAttendance.csv: Service attendance and tracking records.

                                              Note: When the Include Standalone Client Records (non-Enrollment) parameter is set to Yes, the ClarityClientAssessment.csv, ClarityClientService.csv, ClarityServiceExpense.csv, and ClarityServiceAttendance.csv will also include Standalone records that are not linked to enrollments. When Project Type(s) and/or Program(s) parameters are set to None, only Standalone records will be returned.

                                                           

                                                          Published: 05/31/2026