Gustaffo Reservations System Documentation¶
Overview¶
The Gustaffo Reservations System is a comprehensive hotel management platform designed to streamline the guest booking journey, from initial inquiry to confirmation and payment processing. This documentation provides detailed information about the system architecture, features, and technical implementation.
Key Features¶
1. Offers Management¶
The Offers module enables hotels to create, send, and track personalized offers to potential guests. Key capabilities include:
- Multi-channel offer creation via website widget, agent interface, or quick offer forms
- Customized vs. standard rate offers to accommodate specific guest requests
- Automated email delivery with tracking and engagement monitoring
- Offer microsite for guest review and sharing
- 24-hour reminder system for increased conversion rates
2. Reservation Confirmations¶
The Confirmations module processes incoming reservations from multiple channels and manages guest communications:
- Multi-source integration with Travelclick (email) and Phobs (API)
- Automated email notifications for confirmations, modifications, and cancellations
- Payment policy application based on property-specific rules
- PMS integration with Apaleo for reservation synchronization
- Reminder system for payment deadlines
3. Manual Payments¶
The Manual Payments feature allows staff to create custom payment links for any purpose:
- Flexible payment amount and description for various scenarios
- Property-specific accounting separation
- Secure payment link delivery via email
- Apaleo integration for automatic payment posting when CRS ID is provided
- Comprehensive payment tracking
4. Deposits, Vouchers, and Point Redemption¶
The system processes various financial transactions related to reservations:
- Daily report processing via dedicated email inbox
- AWS Lambda automation for immediate processing
- Property filtering (currently Austrian properties)
- Apaleo integration for payment posting
- Accounting reconciliation
5. Role-Based Access Control¶
The RBAC system ensures secure, granular access to system features:
- Hierarchical role structure from System Administrator to Read-Only User
- Feature and property-level permissions
- Operation-specific access control (create, read, update, delete)
- JWT-based authentication flow
- Spring Security implementation
6. Property Configuration¶
Comprehensive property management capabilities:
- Property settings management
- Taxonomy configuration with tags for property categorization
- Salutation configuration for consistent guest communication
- Language preferences for multi-lingual support
- Integration settings for external systems
7. Ticket Management¶
The Tickets module handles guest inquiries and internal tasks:
- Quick Offer functionality for rapid response to inquiries
- Automated ticket creation from incomplete website forms
- Task assignment to appropriate staff members
- Status tracking from creation to resolution
- Integration with offer system for seamless conversion
Documentation Sections¶
- API Documentation - Comprehensive API reference
- System Architecture - Technical architecture overview
- Feature Documentation - Detailed feature specifications
- Modules - Core system module documentation
- Development Guide - Information for developers
- Operations Guide - Deployment and maintenance
Getting Started¶
To get started with the Gustaffo Reservations System, please refer to the following resources:
- System Overview - High-level system introduction
- Development Setup - Development environment setup
- Configuration Guide - System configuration
- API Reference - API documentation for integration Welcome to the technical documentation for the Gustaffo Reservations Application. This documentation provides comprehensive information about the system architecture, APIs, integrations, and operational procedures.
Documentation Structure¶
API Documentation¶
- Offers API - Endpoints for managing hotel offers, inquiries, and reservations
- Payment Processing API - Endpoints for handling payment transactions, deposits, and integrations
- Apaleo PMS Integration - Details about integration with Apaleo Property Management System
- Payment Workflow - Workflow diagrams and process flows for payment handling
- Payment Integration Guide - Guide for integrating with the payment system
- Policy Types - Documentation for payment policy types and behavior
System Documentation¶
- Architecture Overview - High-level system architecture
- Database Schema - Database tables and relationships
- Security - Security measures and practices
- Deployment - Deployment process and environments
Operations Documentation¶
- Monitoring - Monitoring and alerting setup
- Troubleshooting - Common issues and their solutions
- Backup and Recovery - Backup procedures and disaster recovery
Getting Started¶
To get started with the documentation:
- Browse the documentation structure above to find the information you need
- Use the search function to find specific topics
- Follow links within the documentation to navigate between related topics
Contributing to Documentation¶
To contribute to this documentation:
- Clone the repository
- Create or edit Markdown files in the
/docs
directory - Add new pages to the navigation in
mkdocs.yml
- Submit a pull request with your changes
For more information, see the README file.
Overview¶
The Gustaffo Reservations Application is a Spring Boot-based hotel reservation system that allows users to search for room availability, manage bookings, and process payments. It provides a comprehensive solution for hotel management with features for administrators, hotel staff, and end users.
Key Features¶
- Real-time room availability checking using Server-Sent Events (SSE)
- Reservation management with custom offers
- Integration with external booking systems
- Secure payment processing
- User and role-based access control
- Multi-language support
- Email notifications and confirmations
Technology Stack¶
- Java 17
- Spring Boot 2.5.15
- Spring Security with OAuth2
- Spring Data JPA
- Hibernate with JCache
- PostgreSQL & H2 Databases
- Flyway for database migrations
- Server-Sent Events for real-time updates
Documentation Structure¶
This documentation is organized into the following sections:
- Architecture: System design, components, and data models
- API: API documentation and usage examples
- Features: Detailed explanation of application features
- Operations: Deployment, configuration, and monitoring
- Development: Getting started, testing, and contributing guidelines