Grouper: Door Access

Last updated: October 5, 2026

Housing.Cloud is capable of generating a Door Access CSV file with the intent of being consumed by Grouper. The CSV transmission process will follow Housing.Cloud's standard SFTP process.

Configuration

  1. Institution will specify the transfer cadence of the file (e.g. every 30 minutes)
    1. The cadence can be any value supported by a Cron string, but it must be equal to or greater than every 10 minutes

File Format

Column Header Data Type Description
ix_Student_Number string A Resident's sisId in Housing.Cloud
pk_Community string Building Type name in Housing.Cloud
fk_Building_ID string Building id in Housing.Cloud
SuiteName string Suite name in Housing.Cloud
fk_Room_No string Room name in Housing.Cloud
fk_MOVE_IN_DATE date string The date in which a Resident checked in
ROOM_PERSON_MOVE_OUT_DATE date string The date of the Occupancy end, or the date when a Resident checked out *

 

Data Type Clarifications:

  • Date String will be an ISO date string using the format: yyyy-mm-ddTHH:MM:SS.MSZ
  • It is possible that SuiteName and pk_Community are empty strings, as those Inventory Levels are not required in Housing.Cloud. If the level exists in Housing.Cloud, those fields will be populated in the file

Notes:

  • By default, an Occupancy will appear in the file as soon as the Resident is checked in
    • A configuration such that an Occupancy will appear in the file as soon as the Occupancy is created in Housing.Cloud
  • By default OCCUPANCY_END will be set to the Occupancy end date, until the Resident is checked out. As soon as the Resident is checked out, the OCCUPANCY_END date will be the check out date *
  • If your institution utilizes Ethos to connect Housing.Cloud to your SIS, the inventory naming pattern in Grouper must match the inventory naming pattern in your SIS. This is not an issue if your institution utilizes SFTP.