Module Research Notes
Evidence gathered from the current module files before writing the user guide pages.
Research Sources Inspected
Source path
modules/Hotel
Feature flags marked true
- Controllers
- Models
- Views
- Language
- Permissions
- Left Menu
- Default Menu
- Routes
- Migrations
- Helpers
Evidence Summary
Manifest
module.json defines slug hotel, version 1.0.0, category Operations, and the module capability flags used in this guide.
Runtime surface
11 controller file(s), 74 view file(s), and 32 route mapping(s) were found.
Data surface
21 model file(s), 21 declared table(s), and 4 migration file(s) were found.
Operations surface
39 permission key(s), 0 job(s), 1 seeder(s), and 1 test file(s) were found.
Detailed File Evidence
Controllers and methods
HotelHotel_bookingsHotel_channelsHotel_financeHotel_guestsHotel_housekeepingHotel_maintenanceHotel_reportsHotel_roomsHotel_settingsHotel_staff
Jobs and schedules
No scheduled module jobs were found.
Routes sampled
| Route | Target |
|---|---|
hotel | Hotel/index |
hotel/(:any) | Hotel/$1 |
hotel_rooms | Hotel_rooms/index |
hotel_rooms/(:any) | Hotel_rooms/$1 |
hotel_rooms/(:any)/(:any) | Hotel_rooms/$1/$2 |
hotel_bookings | Hotel_bookings/index |
hotel_bookings/(:any) | Hotel_bookings/$1 |
hotel_bookings/(:any)/(:any) | Hotel_bookings/$1/$2 |
hotel_guests | Hotel_guests/index |
hotel_guests/(:any) | Hotel_guests/$1 |
hotel_guests/(:any)/(:any) | Hotel_guests/$1/$2 |
hotel_housekeeping | Hotel_housekeeping/index |
hotel_housekeeping/(:any) | Hotel_housekeeping/$1 |
hotel_housekeeping/(:any)/(:any) | Hotel_housekeeping/$1/$2 |
hotel_maintenance | Hotel_maintenance/index |
hotel_maintenance/(:any) | Hotel_maintenance/$1 |
hotel_maintenance/(:any)/(:any) | Hotel_maintenance/$1/$2 |
hotel_staff | Hotel_staff/index |
hotel_staff/(:any) | Hotel_staff/$1 |
hotel_staff/(:any)/(:any) | Hotel_staff/$1/$2 |
| 12 additional route(s) omitted for readability. | |
README topics
- Overview
- Purpose
- Who This Module Is For
- Problems This Module Solves
- Key Features
- How It Works in ERPat
- Common Use Cases
- User Roles and Access
- Permissions
- Related Modules
- Important Notes
- Data Handled by This Module
Operating Implications
- Permission coverage is part of the module contract, so every workflow should be tested with a role-limited user and an administrator.
- The module has migrations, so fresh installs and tenant databases need migration validation before go-live.
- The module has a public or portal-facing surface, so privacy review and logged-out testing are required.
- Seeders exist for sample or starter data; operators should know whether seeded records are demo-only or operational defaults.
Known Risks from the Manifest
- OTA channel connectors are groundwork stubs - channel accounts store credentials (write-only, masked) but no external synchronization runs yet; sync logs record local actions only.
- Night audit posts room charges idempotently per business date (one audit row per date); re-running an already-closed business date does not duplicate charges.
- Staff roster/attendance, invoicing and asset tracking deliberately reuse core modules (hrs/attendance, hrs/schedule, core Sales Invoices, ams/assets) - this module links to them instead of duplicating them.