Data Integration and Migration

Importing data using the Data Import Tool (DIT), exporting data in CSV and XML formats, and the SQL data model.

Importing Data

  • FY 2020 Updates to Data Import Tool

    Purpose This document describes the changes to the Data Import Tool to incorporate the changes outlined in the 2020 HMIS Data Dictionary. Resources The updated CSV specifications and updated XML schema detail the structural requirements for the new data elements, as well as changes to existing data elements. When importing a HUD XML file, make sure to update the schema references in the hmis:Sources tag to use the...

  • Deleting Data with the DIT

    Overview The HMIS XML and CSV data formats allow the inclusion of a DateDeleted property on certain data elements to indicate if records have been deleted in the source system. The Data Import Tool (DIT) will use DateDeleted to determine if the data should be deleted in Clarity. This article describes the process the DIT goes through to determine if data should be deleted. Deletable Data Types Clients, Enrollments...

  • Introduction to Using the Data Import Tool (DIT)

    This article explains how to access and configure the Clarity Data Import Tool (DIT). Accessing the Data Import Tool To access the Data Import Tool (DIT), your Clarity user account must be assigned a role that has been configured to allow access.  To use the DIT for importing data, click the Launchpad icon  and select Data Import.   Advanced Options Once the user has accessed the Data Import Tool, there are a num...

    label_outline For Agency Managers label_outline For System Administrators label_outline Publish label_outline XML label_outline Import label_outline DIT label_outline Client Matching label_outline Custom Fields label_outline Validation label_outline Rejected Clients label_outline CSV
  • Importing Data Using the Data Import Tool (DIT)

    This article walks the user through the steps of importing a file using the Data Import Tool (DIT). For a high level walkthrough of the Data Import Tool, including settings and descriptions of the various screens, please review the Introduction to Using the Data Import Tool article. Performing an Import The Clarity Data Import Tool (DIT) will accept data in the 6.1 version of HMIS CSV or XML.  For further document...

    label_outline XML label_outline DIT label_outline Validation label_outline CSV label_outline Imports label_outline Mapping label_outline Data Integration
  • Importing Data Using the XML API Import Tool

    Welcome to our RESTful XML API Import tool. This tool has been developed to allow importing of household information, client demographics, program participation, and service transactions. The HUD XML FY2020 Schema Documentation can be found at: Additional Resources can be found at:  HMIS XML Schema Overview (pdf)

  • API Credentials

    This section discusses API Credentials in the context of sharing client information with other agencies and providers. API Credentials are used for security purposes. API Credentials are auto-generated, and assigned separately to each staff member. To manage API Credentials, click the Launchpad icon , and select Manage.  Click on the Sharing tab, and scroll down to the API Credentials section. API Credentials can...

    label_outline Security label_outline For Agency Managers label_outline For System Administrators

Exporting Data

  • [HUDX-111] HUD CSV / XML Program Data Export

      Exporting data from the Clarity system is accomplished using the [HUDX-111] HUD CSV / XML Program Data Export report available in the reporting area.  The exported data is formatted in HUD CSV or XML.  For more information on the specifications of these data formats, review the HMIS Data Exchange Resources.   Accessing the Export To access the [HUDX-111] HUD CSV / XML Program Data Export report, click the Launch...

    label_outline HUD XML label_outline XML label_outline Export label_outline HUD CSV label_outline HUDX-111
  • Customer SQL Data Model

    Welcome to the Clarity Human Services Data Schema Information Page. The Customer SQL Data Model provides restricted access to the MariaDB Database to customers who have licensed access to the Model.  Fields in the CSDM are restricted via Views, as to not explore the full proprietary database. Table Names clarity_access_roles clarity_access_role_categories     clarity_agencies clarity_agency_assessmen...

    label_outline Schema label_outline Table label_outline Data Model label_outline Import label_outline Foreign Key label_outline Primary Key label_outline Export label_outline SQL