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
- This is a list of all Countries, Airports, Ports/Terminals according to the accepted industry standards. It also contains an area for Admin users to define a list of Regions and Busiest Ports/Terminals according to the business processes.
Business Requirements
- Rather than just ensure there are no duplications, we need to upload, and be working from, universally accepted airport codes (from IATA), as well as Country names (United Nations), Sea Port Codes (International Maritime Organization).
- Plus provide some sort of a solution for updating, should a port be retired/no longer used, or a new port is created or an existing port needs editing.
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. See Figure_1
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 needed validation and prevent the existing of several countries with the same name:
- 1) validation executes on the Countries Tab upon saving data in "Add Country" window.
- 2) when Country with Printable Name already exists in DB:
- - System shows warning message window with text "Country with this Printable Name already exists"
- - and doesn't save data.
- 3) user ought to correct the entered name or stop adding this country.
Figures
Figure 1
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.
