Files
apollinare-catering-software/docs/apex/README.md
2025-12-17 13:02:12 +01:00

196 lines
5.7 KiB
Markdown

# APEX Application Documentation
## Application Overview
| Property | Value |
|----------|-------|
| **Application ID** | 112 |
| **Application Name** | APCB Project |
| **Application Alias** | F_110112 |
| **APEX Version** | 21.1.0 |
| **Owner/Schema** | APOLLINARECATERINGPROD |
| **Language** | Italian (it) |
| **Date Format** | DD-MM-YYYY |
| **DateTime Format** | DD-MM-YYYY HH24:MI:SS |
| **Logo Text** | Apollinare Catering & Banqueting - Management Software |
| **Last Updated By** | MONIA |
| **Last Update** | 2025-11-24 14:06:02 |
## Application Statistics
| Component | Count |
|-----------|-------|
| **Pages** | 56 |
| **Items** | 302 |
| **Processes** | 98 |
| **Regions** | 151 |
| **Buttons** | 119 |
| **Dynamic Actions** | 62 |
| **LOVs** | 12 |
| **Authorization Schemes** | 5 |
| **Computations** | 2 |
| **Breadcrumb Entries** | 22 |
| **List Entries** | 2 |
| **Templates** | 64 |
| **Plug-ins** | 2 |
| **Messages** | 464 |
## Navigation Structure
### Desktop Navigation Menu
```
Home (Page 1)
├── Articoli (Page 2)
│ └── Impegni Articoli (Page 39)
├── Categorie (Page 4)
├── Tipi (Page 6)
├── Clienti (Page 17)
├── Location (Page 15)
├── Risorse (Page 31)
├── Permessi (Page 47) [Admin Only]
├── Gestione Dati (Page 45) [Admin Only]
├── Job Schedulati (Page 49)
├── Mail Inviate (Page 50)
└── Mail In Attesa (Page 51)
Eventi
├── Tipi Evento (Page 13) [Admin Only]
├── Nuovo Evento (Page 22) [Admin Only]
├── Schede/Schede Confermate (Page 35)
├── Liste (Page 9) [Admin Only]
├── Calendario Eventi (Page 12)
├── Degustazioni (Page 27)
└── Template Eventi (Page 48) [Admin Only]
Riepiloghi/Report
├── Griglia (Page 16) [Admin Only]
├── Riepilogo Cucina (Page 25)
├── Torte e Costi Extra (Page 28) [Admin Only]
├── Riepilogo Allestimenti (Page 30)
└── Riepilogo Risorse (Page 38)
```
## Page Categories
### Master Data Pages
| Page ID | Name | Description |
|---------|------|-------------|
| 2 | Articoli Rpt | Article list report |
| 3 | Articoli | Article detail form |
| 4 | Categorie Rpt | Categories list report |
| 5 | Categorie | Category detail form |
| 6 | Tipi Rpt | Types list report |
| 7 | Tipi | Type detail form |
| 17 | Clienti Rpt | Clients list report |
| 18 | Clienti | Client detail form |
| 15 | Location Rpt | Locations list report |
| 20 | Location | Location detail form |
| 31 | Risorse | Resources (staff) management |
### Event Management Pages
| Page ID | Name | Description |
|---------|------|-------------|
| 1 | Home | Dashboard |
| 8 | Nuovo Evento Wizard | Event creation wizard |
| 9 | Lista Eventi | Event list |
| 12 | Calendario | Event calendar |
| 13 | Tipi Evento Rpt | Event types list |
| 14 | Tipi Evento | Event type detail form |
| **22** | **Nuovo Evento** | **Main event form (most complex)** |
| 27 | Lista Degustazioni | Tastings list |
| 32 | Degustazione | Tasting detail |
| 35 | Schede/Schede Confermate | Event cards |
| 48 | Template Eventi | Event templates |
### Report Pages
| Page ID | Name | Description |
|---------|------|-------------|
| 16 | Griglia | Grid view |
| 25 | Riepilogo Cucina | Kitchen summary |
| 28 | Torte e Costi Extra | Cakes and extra costs |
| 30 | Riepilogo Allestimenti | Setup summary |
| 38 | Riepilogo Risorse | Resources summary |
| 39 | Impegni Articoli | Article commitments |
### Administration Pages
| Page ID | Name | Description |
|---------|------|-------------|
| 45 | Gestione Dati | Data management |
| 46 | Max Eventi | Max events configuration |
| 47 | Permessi | Permissions management |
| 49 | Job Schedulati | Scheduled jobs |
| 50 | Mail Inviate | Sent emails |
| 51 | Mail In Attesa | Pending emails |
## Page 22 (Nuovo Evento) - Most Complex Page
Page 22 is the main event management page with the highest complexity:
| Component | Count |
|-----------|-------|
| Items | 108 |
| Regions | 33 |
| Buttons | 32 |
| Processes | 32 |
| Dynamic Actions | Multiple |
### Key Features:
- Multiple Interactive Grids (master-detail)
- Guest type management with quantity recalculations
- Resource assignments
- Pick list management with coefficient-based calculations
- Event status workflow management
- Template support
- Versioning system
## Documentation Structure
```
docs/apex/
├── README.md (this file)
├── pages/ # Individual page documentation
├── processes/ # Process documentation
├── lovs/ # List of Values documentation
├── javascript/ # JavaScript libraries
├── authorization/ # Authorization schemes
├── dynamic-actions/ # Dynamic actions
├── items/ # Shared items
├── regions/ # Shared regions
└── navigation/ # Navigation components
```
## Key Files
- [LOVs Documentation](lovs/README.md) - List of Values definitions
- [Processes Documentation](processes/README.md) - PL/SQL processes
- [JavaScript Libraries](javascript/README.md) - Custom JavaScript
- [Authorization Schemes](authorization/README.md) - Security settings
- [Page 22 Documentation](pages/PAGE_022.md) - Main event form
## Event Status Workflow
```
100 (Preventivo/Quote)
↓ [Continue Event]
200 (Scheda/Preparazione)
↓ [Return to Preparazione]
300 (Confermata/Quasi)
↓ [Almost Continue Event]
350 (Quasi Confermato)
↓ [Confirm Event]
400 (Confermato/Confirmed)
↓ [Set Obsoleto]
900 (Superato/Expired)
```
## Authorization Schemes
| Scheme Name | Description |
|-------------|-------------|
| Admin_auth_schema | Full admin access |
| User Read/Write | Controlled by USERS_READONLY table |
| Consuntivi | Financial summaries access |
| Gestori | Manager-level permissions |
| Solo Admins | Highest level (admin, monia only) |