Table of Contents

1.0	Introduction
2.0	Requirements

1.0	Introduction

Questo documento è il risultato dell'analisi e della discussione della collezione di requisiti emersi nell'implementazione della logica dell'applicazione phpMyHotels. Lo scopo del documento stesso è quello di documentare i requisiti raccolti e i rispettivi elementi logici associati (es. pagine web). I moduli coperti da questo documento sono: Logica pubblica Logica pannelli Logica affiliazione Questo documento nella sua versione più aggiornata è situato in http://phpmyhotels.sourceforge.net/requirements.html Per un panoramica completa della logica dell'applicazione, comprensiva di tutti i suoi elementi, si rimanda al documento wireframe situato in http://phpmyhotels.sourceforge.net/wireframe

2.0	Requirement Detail

2.1	Requirements/

2.1.1

Resource type choice  Element Detail Description Choice possible (Hotels, Restaurants, Car rental, etc etc)  Directory Requirements/  A single form should perform search over different kind of resources. Not simultaneousely, but with quick switch. Maybe a multi layered form...

2.1.2

Valid resource id  Element Detail Description A valid resource id must be provided  Directory Requirements/  Every resource has a unique id  Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 PropertyReport  A mini-report about a given property  Screen 2 ResourceReview  Reviews and rankings about the given resource  Screen

2.2	Requirements/Admin/

2.2.1

Booking history  Element Detail Description   Directory Requirements/Admin/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 User report  User activity summary  Screen

2.2.2

No show alarm  Element Detail Description Admin gets a mail if a web user gets over a 10% no show rate  Directory Requirements/Admin/  10% could be a parametric value  Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 AdminPanel  Administration Control Panel  Screen

2.2.3

No show history  Element Detail Description An history of 'no show's  Directory Requirements/Admin/  It will be featured either for Affiliates and Web users (respectively notified and caused 'no show's  Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 User report  User activity summary  Screen

2.2.4

User type  Element Detail Description Different info based on different type of users (affiliate or web user)  Directory Requirements/Admin/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 User report  User activity summary  Screen

2.2.5

Valid admin user ID  Element Detail Description User must be authenticated as 'Admin user'  Directory Requirements/Admin/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 User freezed  Confirms user 'freeze' operation  Screen 2 OperationConfirmation  Summuary of operation requested and request of confirmation  Screen 3 User deleted  Confirms user deletion  Screen 4 Users list  A full list showing all registered users   Screen 5 AdminPanel  Administration Control Panel  Screen 6 User report  User activity summary  Screen 7 PendingProperties  Shows a list of pending added properties waiting to be authorized  Screen 8 AddNotaCredito  Let Admin user add a nota di credito for a given Affiliate  Screen

2.2.6

Valid user id  Element Detail Description A valid user id must be specified to operate uniquely against him  Directory Requirements/Admin/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 User freezed  Confirms user 'freeze' operation  Screen 2 OperationConfirmation  Summuary of operation requested and request of confirmation  Screen 3 User deleted  Confirms user deletion  Screen 4 User report  User activity summary  Screen 5 AddNotaCredito  Let Admin user add a nota di credito for a given Affiliate  Screen

2.3	Requirements/Admin/Affiliate report/

2.3.1

Date to date transactions  Element Detail Description   Directory Requirements/Admin/Affiliate report/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 User report  User activity summary  Screen

2.3.2

Flag di storno  Element Detail Description   Directory Requirements/Admin/Affiliate report/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 User report  User activity summary  Screen

2.3.3

Invoice number default overridable  Element Detail Description   Directory Requirements/Admin/Affiliate report/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 User report  User activity summary  Screen

2.3.4

Monthly transactions  Element Detail Description   Directory Requirements/Admin/Affiliate report/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 User report  User activity summary  Screen

2.3.5

PDF invoices  Element Detail Description   Directory Requirements/Admin/Affiliate report/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 User report  User activity summary  Screen

2.4	Requirements/Admin/Users list/

2.4.1

Activation control  Element Detail Description Toggle active/freezed  Directory Requirements/Admin/Users list/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 Users list  A full list showing all registered users   Screen

2.4.2

First name  Element Detail Description   Directory Requirements/Admin/Users list/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 Users list  A full list showing all registered users   Screen

2.4.3

Nome  Element Detail Description   Directory Requirements/Admin/Users list/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 Users list  A full list showing all registered users   Screen

2.4.4

State  Element Detail Description Active/Freezed  Directory Requirements/Admin/Users list/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 Users list  A full list showing all registered users   Screen

2.4.5

Type  Element Detail Description Web user / Affiliate  Directory Requirements/Admin/Users list/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 Users list  A full list showing all registered users   Screen

2.4.6

User ID  Element Detail Description   Directory Requirements/Admin/Users list/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 Users list  A full list showing all registered users   Screen

2.5	Requirements/Admin/Web user report/

2.5.1

No show rate  Element Detail Description No shows / bookings rate  Directory Requirements/Admin/Web user report/  It express in a percentile the quality of the web user  Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 User report  User activity summary  Screen

2.5.2

No shows total  Element Detail Description Historical sum of all no shows caused by the web user  Directory Requirements/Admin/Web user report/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 User report  User activity summary  Screen

2.6	Requirements/Affiliate/

2.6.1

Administrative contact  Element Detail Description   Directory Requirements/Affiliate/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 AffiliationForm  A form to fill to become an affiliate user  Screen

2.6.2

Chain name  Element Detail Description   Directory Requirements/Affiliate/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 ChainForm  Let user add/edit a properties chain  Screen

2.6.3

Commercial contact  Element Detail Description   Directory Requirements/Affiliate/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 AffiliationForm  A form to fill to become an affiliate user  Screen

2.6.4

Company name  Element Detail Description   Directory Requirements/Affiliate/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 AffiliationForm  A form to fill to become an affiliate user  Screen

2.6.5

General contact  Element Detail Description   Directory Requirements/Affiliate/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 AffiliationForm  A form to fill to become an affiliate user  Screen

2.6.6

No show button  Element Detail Description A control to notify 'no show's  Directory Requirements/Affiliate/  This link/checkbox/button will appear next to every active booking whose deadline will be past, to let affiliate user notify a 'no show' about a given booking.  Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 BookingReport  A list of all active bookings  Screen

2.6.7

Partita IVA - Cod.Fisc  Element Detail Description   Directory Requirements/Affiliate/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 AffiliationForm  A form to fill to become an affiliate user  Screen

2.6.8

Valid affiliate ID  Element Detail Description User must be authenticated as 'affiliate user'.  Directory Requirements/Affiliate/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 PropertyConfirmation  Summary and confirmation of property data  Screen 2 AffiliateProfileForm  A form to edit info about the affiliate  Screen 3 AffiliatePanel  Affiliates control panel  Screen 4 EditProperty    Screen 5 ResourceForm  A form to add a resource to a property  Screen 6 ProfileConfirmation  Summary of profile data and request for confirmation  Screen 7 DeletePropertyConfirmation  Asks for confirmation to delete a property  Screen 8 PropertyForm  A form to add a property  Screen 9 ResourceConfirmation  Summary and confirmation of resource data  Screen 10 ConfirmResourceDeletion  Asks for confirmation to delete a resource  Screen 11 BookingReport  A list of all active bookings  Screen 12 ChainForm  Let user add/edit a properties chain  Screen

2.7	Requirements/Affiliate/Property/

2.7.1

Chain id  Element Detail Description   Directory Requirements/Affiliate/Property/  Optional: a property can even be a stand-alone one.  Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 PropertyForm  A form to add a property  Screen

2.7.2

City zone  Element Detail Description   Directory Requirements/Affiliate/Property/  Optional  Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 AdvancedSearchForm  More refined search  Screen 2 PropertyForm  A form to add a property  Screen

2.7.3

Credit cards  Element Detail Description Accepted credit cards  Directory Requirements/Affiliate/Property/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 PropertyForm  A form to add a property  Screen

2.7.4

Currency  Element Detail Description   Directory Requirements/Affiliate/Property/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 PropertyForm  A form to add a property  Screen

2.7.5

Extra info  Element Detail Description   Directory Requirements/Affiliate/Property/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 PropertyForm  A form to add a property  Screen

2.7.6

Opening  Element Detail Description   Directory Requirements/Affiliate/Property/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 PropertyForm  A form to add a property  Screen

2.7.7

Property ID  Element Detail Description A valid property ID must be specified  Directory Requirements/Affiliate/Property/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 PropertyConfirmation  Summary and confirmation of property data  Screen 2 EditProperty    Screen 3 DeletePropertyConfirmation  Asks for confirmation to delete a property  Screen 4 ResourceConfirmation  Summary and confirmation of resource data  Screen

2.7.8

Property name  Element Detail Description Property public name ('Hotel majestic', 'Chez Hugo' etc etc)  Directory Requirements/Affiliate/Property/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 PropertyForm  A form to add a property  Screen

2.7.9

Property specific info  Element Detail Description Plug-in based extra info  Directory Requirements/Affiliate/Property/  Plug-in oriented infos will be different across different kinds of properties  Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 PropertyForm  A form to add a property  Screen

2.8	Requirements/Affiliate/Resource/

2.8.1

Closing time  Element Detail Description   Directory Requirements/Affiliate/Resource/  No comments exist for this requirement.

2.8.2

Opening time  Element Detail Description   Directory Requirements/Affiliate/Resource/  No comments exist for this requirement.

2.8.3

Resource capacity  Element Detail Description   Directory Requirements/Affiliate/Resource/  No comments exist for this requirement.

2.8.4

Resource ID  Element Detail Description A valid resource ID must be specified  Directory Requirements/Affiliate/Resource/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 ResourceConfirmation  Summary and confirmation of resource data  Screen 2 ConfirmResourceDeletion  Asks for confirmation to delete a resource  Screen

2.8.5

Resource name  Element Detail Description   Directory Requirements/Affiliate/Resource/  No comments exist for this requirement.

2.8.6

Resource specific info  Element Detail Description Plug-in based extra info  Directory Requirements/Affiliate/Resource/  Plug-in oriented infos will be different across different kinds of resources  Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 ResourceForm  A form to add a resource to a property  Screen

2.8.7

Resource type  Element Detail Description A resource type must be specified to manage specific fields and info  Directory Requirements/Affiliate/Resource/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 ResourceForm  A form to add a resource to a property  Screen

2.8.8

Resources closing criteria  Element Detail Description How an affiliate can choose which resources in a given property close  Directory Requirements/Affiliate/Resource/  - One specific resource - All free resources - Close by capacity - Close by plug-in specific value  Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 ConfirmResourcesClosing  It asks for confirmation while closing one or more resources  Screen

2.9	Requirements/Articles/

2.9.1

Article choosen  Element Detail Description An article must be choosen to view one  Directory Requirements/Articles/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 View article  View the extended version of the article.  Screen

2.9.2

Category list  Element Detail Description A list of all categories must be provided  Directory Requirements/Articles/  All categories are in the database. A query should extract all the categories.  Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 CategoryList  List of all categories  Screen

2.9.3

Category selection  Element Detail Description A category has to be selected in order to have an article list  Directory Requirements/Articles/  Since articles are subdivided in categories, to get a list of a category a category must be choosen  Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 ArticlesList  List of all articles in a given category  Screen

2.9.4

Extra info form  Element Detail Description Optional contact form below an article to get more info about the specific subject  Directory Requirements/Articles/  Admin user will be able to set a checkbox to let the form appear below an article. This form will send info about the user and (hidden) the article id to let admin understand which service the user is asking info about.  Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 View article  View the extended version of the article.  Screen

2.10	Requirements/Editor/

2.10.1

Article owner  Element Detail Description Editor user must own this article to edit it  Directory Requirements/Editor/  When editing articles editor user must be owner of the articles he's editing/freezing/deleting  Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 SubmitConfirmation  Ask for confirmation from the user to submit new/modified article  Screen 2 ConfirmAction  Asks for user confirmation  Screen 3 EditorPanel  Article editor main screen  Screen 4 ArticleForm  Form to submit a new article or to edit an existing one.  Screen

2.10.2

Authenticated editor user ID  Element Detail Description User must be authenticate as 'editor' to be here  Directory Requirements/Editor/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 SubmitConfirmation  Ask for confirmation from the user to submit new/modified article  Screen 2 ConfirmAction  Asks for user confirmation  Screen 3 EditorPanel  Article editor main screen  Screen 4 ArticleForm  Form to submit a new article or to edit an existing one.  Screen 5 ArticlePreview  Shows the final rendering of the article  Screen

2.11	Requirements/Form frequent fields/

2.11.1

Administrative address  Element Detail Description   Directory Requirements/Form frequent fields/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 AffiliationForm  A form to fill to become an affiliate user  Screen 2 PropertyForm  A form to add a property  Screen

2.11.2

City  Element Detail Description   Directory Requirements/Form frequent fields/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 AffiliationForm  A form to fill to become an affiliate user  Screen 2 PropertyForm  A form to add a property  Screen

2.11.3

Country  Element Detail Description   Directory Requirements/Form frequent fields/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 AffiliationForm  A form to fill to become an affiliate user  Screen 2 PropertyForm  A form to add a property  Screen

2.11.4

E-mail address  Element Detail Description Needed to send confirmation code  Directory Requirements/Form frequent fields/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 AffiliationForm  A form to fill to become an affiliate user  Screen

2.11.5

Fax  Element Detail Description   Directory Requirements/Form frequent fields/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 AffiliationForm  A form to fill to become an affiliate user  Screen

2.11.6

First name  Element Detail Description   Directory Requirements/Form frequent fields/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 AffiliationForm  A form to fill to become an affiliate user  Screen

2.11.7

Last name  Element Detail Description   Directory Requirements/Form frequent fields/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 AffiliationForm  A form to fill to become an affiliate user  Screen

2.11.8

Operative address  Element Detail Description   Directory Requirements/Form frequent fields/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 AffiliationForm  A form to fill to become an affiliate user  Screen

2.11.9

Phone number  Element Detail Description   Directory Requirements/Form frequent fields/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 AffiliationForm  A form to fill to become an affiliate user  Screen 2 PropertyForm  A form to add a property  Screen

2.11.10

Province  Element Detail Description   Directory Requirements/Form frequent fields/  No comments exist for this requirement. Related Elements This requirement is associated with the following design elements: Related Elements # Name Description Type 1 AffiliationForm  A form to fill to become an affiliate user  Screen 2 PropertyForm  A form to add a property