Housing Cluster
Manage the residential clusters in your portfolio — their location, cover image, siteplan, and public visibility.
What it’s for
A Cluster is the top-level grouping everything else in this app hangs off — units, residents, bills, all of it. This page is where clusters themselves are created and configured.
Where to find it
Sidebar → Housing → Housing Cluster, at /admin/housing/housing-cluster.
Who can use it
- See the menu item and open the page — needs view.
- See the cluster list and summary — needs get.
- Create, edit, delete — each needs its own permission.
On this screen
Summary cards for total clusters, cities covered, and provinces. Below that, a searchable table of clusters, with create/edit/delete.
How to…
Add a cluster
- Click Add Cluster.
- Fill in the name, city, and province.
- Optionally upload a cover image (shown as the dashboard hero for this cluster) and a siteplan image (used on the public marketplace listing and by the Siteplan page).
- Optionally mark it published on the public marketplace.
- Save.
Edit or delete a cluster
- Open the edit or delete action on its row.
- For edit, change any field and save. For delete, confirm.
Field reference
| Field | Required | Notes |
|---|---|---|
| Name, city, province | Yes | |
| Cover image | No | Falls back to default artwork if left empty |
| Siteplan image | No | Required before the Siteplan page can place any units |
| Published | No | Gates public marketplace visibility for this cluster and everything listed under it |
| Resident payment method | No | A toggle for online vs. offline resident payment — present in the form, but not yet connected to anything else in the app |
Rules & statuses
Publication is a gate, not a switch. A unit’s listing can only appear on the public marketplace if both the listing itself is published and this cluster is published. Unpublishing the cluster hides every listing under it at once, regardless of each listing’s own state.
The resident payment method toggle is worth calling out specifically: turning it off is what makes a resident’s bill payment show manual bank transfer instructions (configured on Payment) instead of the online gateway — but nothing on this dashboard itself reflects that back to you. You won’t see a preview or confirmation here; the effect only shows up in the resident-facing app.
Related pages
- Units — the units that belong to a cluster.
- Siteplan — uses the siteplan image uploaded here.