Geography (component)
From UG
Contents |
General Info and Scope
- Classified As: component
- Parent Mantis: 605
- Prerequisites: any articles that must be read before to understand this?
Scope
- List what it covers and what it does not
Business Requirements
- This section is defined by Business Analyst
- In this section this component/feature is defined from the business standpoint. All important points are listed. It could include some design details if business insists on specific design.
Notes from Systems Architect
- This section is defined by Systems Architect. It is written after #Business Requirements are defined.
- The purpose of this section is to give direction to System Analysts who will write detailed specification.
Rapid Design
- In some cases (component is non standard) we need to do preliminary not so detailed design before detailed final. And maybe even code it to create Prototype
- This section does not have to be too detailed or too formalized. We shall not spend too much time on Prototypes - they can change many times.
Detailed Design
- This section is defined by Systems Analyst.
- It contains detailed technical design is written after #Business Requirements and #Technical Requirements are defined.
Summary
Geography component is a part of Admin component of CT2. In the Internal application Geography component presents as the Geography section.
The Geography section stores information what divided to five groups:
- Regions
- Countries
- Airports
- Ports/Terminals
- Busiest Ports/Terminals.
User Interface
Info of each group located in the separate tab of Geography section. The tab names are the same as the group names.
Functionality / Use Cases
- This section you could spit into two. But often it is hard to do since often most of functionality is UI related
Special Cases and Misc
Relationships between Country and Region
- In the CT2 is used the following rules of relations between Countries and Regions:
- 1) One Region can to include many Countries (rule 1: one region -> many countries).
- 2) One Country can only belong to one Region (rule 2: one country -> one region).
- As confirmed in mantis #0002040, CT2 functionality must to provide a validation of the relationship for each pair Country-Region and prevent the belonging of one Country to many Regions:
- 1) validation executes on the Countries Tab upon saving data in "Add/Edit Country" window.
- 2) when Country with entered name already exists in DB and doesn't have an appropriate Region value, System shows warning message window with text "Country already exists in DB and doesn't belong to any Region! Use the entered Region's value?" and offers to save data as changes of already existing record.
- 3) when Country with entered name already exists in DB and has an appropriate Region value, System shows warning message with text "Country already exists in DB and belong to other Region! Change the existing Region's value?" and offers to save data as changes of already existing record.
- 4) warning message window has two buttons - "OK" and "Cancel". After clicking "OK" system saves current Country-Region pair, closes all modal windows and updates table of Countries. After clicking "Cancel" System doesn't save any data and user returns to "Add/Edit Country" window for editing of data or closing the window.
QA
This section is to be written by QA Engineer or QA Manager or Systems Analyst.
Test Cases
- List unusual scenarios - things that user most of the time would not do but system must handle well
- Do not list Common Test Cases - link to them
Look and Feel
- This section is to be written / defined by Graphic Designer and UI Designer.
- This includes: final graphics, final layout
- Layout defined here should refine, provide more detials to "functional definitions" of UI as defined in #Functionality / Use Cases section above
Figures
Figure 1:
Misc
Link to User Guide
Questions
Request For Comments (Suggestions and Ideas)
Known Non Critical Bugs
- Critical bugs must be posted into Mantis
Implementation: Link To DB
Implementation: Link To Front End Code
Implementation: Link To Back End Code
History of Updates
Links to Archived / Old specs
<Update type>:<Update Summary>
Update General Info
- mantis: <link> if applicable
- If Y then remove this link from here --> BR to be updated
- If Y then remove this link from here --> Design to be updated
- If Y then remove this link from here --> QA to be updated
- Update types: Re-design / Tweak / Etc
- Ideally update all sections of spec (see above) right away. If you have no time to update spec now or multiple people have to be involved then define task here and come back to update later. In this case add links from here to "TBU wiki tag articles" - see above.
Update Description
- Briefly explain what was done and list links to updated sections.
