Airlines (component)

From UG

(Difference between revisions)
Jump to: navigation, search
(→Technical Specification)
(→History)
 
(65 intermediate revisions not shown)
Line 2: Line 2:
-
== Prerequisites, Classified As, Parent Mantis ==
+
== Classified As, Parent Mantis, Prerequisites ==
* Classified As:  (large) [[component]]   
* Classified As:  (large) [[component]]   
-
* Parent Mantis: [http://mantis.jaguarfreight.com/mantis/view.php?id=606 606]
+
* Parent Mantis: [http://mantis.jaguarfreight.com/mantis/view.php?id=1728 1728]
* Prerequisites: none
* Prerequisites: none
== Business Needs and Requirements ==
== Business Needs and Requirements ==
 +
 +
{| {{table}} border="1"
 +
| '''Section maintained by:''' || '''In completed state?:''' 
 +
|-
 +
|  [[User:Alex|Alex]]          || Yes       
 +
|}
We need a place in the system where we manage Airlines. This is to be used on CT record, reports, pdfs, etc.
We need a place in the system where we manage Airlines. This is to be used on CT record, reports, pdfs, etc.
Required functionality: list, add, edit, delete, archive.
Required functionality: list, add, edit, delete, archive.
-
 
-
''Section last updated by/on:'' --[[User:Alex|Alex]] 18:50, 23 January 2010 (UTC)
 
== Technical Notes from Systems Architect ==
== Technical Notes from Systems Architect ==
-
This is a typical Admin component. Please apply standard patterns.
+
{| {{table}} border="1"
 +
| '''Section maintained by:''' || '''In completed state?:''' 
 +
|-
 +
|  [[User:Alex|Alex]]          || Yes       
 +
|}
-
''Section last updated by/on:'' --[[User:Alex|Alex]] 18:47, 23 January 2010 (UTC)
+
This is a typical Admin component. Please apply standard patterns.
-
== Technical Specification (TS) Summary ==
+
== Technical Specification (TS) ==
-
== TS: Objects and Fields ==
+
{| {{table}} border="1"
 +
| '''Section maintained by:''' || '''In completed state?:''' 
 +
|-
 +
|  [[TBD]]        || Yes       
 +
|}
-
=== Airline ===
+
=== TS: Summary ===
-
'''Name'''
+
=== TS: User Interface ===
-
:* ''type/format:''  alphanumeric; max=30 chars
+
-
 
+
-
'''Airline 2 Letter Code'''
+
-
:* ''type/format:''  alphanumeric; max=30 chars; all caps
+
-
+
-
'''Airline 3 Letter Numeric Code'''
+
-
:* ''type/format:'' positive integer; max=3 digits
+
-
 
+
-
 
+
-
== TS: User Interface ==
+
Consists of the following components - see below.
Consists of the following components - see below.
-
 
+
==== List All Airlines Panel ====
-
=== List All Airlines Panel ===
+
See [[#Figure 1: List Airlines ]]
See [[#Figure 1: List Airlines ]]
Line 51: Line 52:
* [[Button]]s: Add, Edit, Remove.
* [[Button]]s: Add, Edit, Remove.
-
* [[Listbox]]  with properties defined below:
+
* [[Listbox]]: with properties defined below:
 +
** '''Columns:''' one per each field for object [[#Airline]]
 +
** '''Sort:''' every column, alphabetical
 +
** '''Paging:''' none
 +
** '''Default sorting order:''' [[TBD]]
-
* '''Columns:''' one per each field for object [[#Airline]]
+
==== Edit Airlines Window ====
-
* '''Sort:''' every column, alphabetical
 
-
* '''Paging:''' none
+
{| {{table}} border="1"
 +
| '''Attribute:''' || '''Value:'''
 +
|-
 +
| widget type:        || [[Window#Edit]]
 +
|-
 +
| caption:        || Edit Airline
 +
|-
 +
| see Figure:    || [[#Figure 2: Edit Airline]]
 +
|-
 +
|}
-
* '''Default sorting order:''' [[TBD]]
+
This window hosts the widgets below:
-
=== Add Airlines Window ===
+
===== Name =====
-
Component type: [[Window#Edit]]
+
{| {{table}} border="1"
 +
| '''Attribute:''' || '''Value:'''
 +
|-
 +
| widget type:       || [[Textbox]]
 +
|-
 +
| adjusent label:        || ''Name:''
 +
|-
 +
| default:      || pull from selected object
 +
|-
 +
| type/format/DB:  || see [[Tbl Airline#Name]]
 +
|-
 +
| required?:    || Y
 +
|-
 +
| validation type:  ||  zk standard / on submit  // [[TBD]]
 +
|}
-
See [[#Figure 2: Edit Airlines ]]
+
===== Airline 2 Letter Code ===== 
-
See list of widgets below:
+
{| {{table}} border="1"
 +
| '''Attribute:''' || '''Value:'''
 +
|-
 +
| widget type:        || [[Textbox]]
 +
|-
 +
| adjusent label:        || ''2 Letter Code:''
 +
|-
 +
| default:      || pull from selected object
 +
|-
 +
| type/format/DB:  ||  see [[Tbl Airline#TwoLetterCode]]
 +
|-
 +
| required?:    || Y
 +
|-
 +
| validation type:  || stop on max / zk standard / on submit  // [[TBD]]
 +
|}
 +
===== Airline 3 Letter Numeric Code: =====
-
=== Edit Airlines Window ===
+
{| {{table}} border="1"
 +
| '''Attribute:''' || '''Value:'''
 +
|-
 +
| widget type:        || [[Textbox]]
 +
|-
 +
| adjusent label:        || ''Numeric Code:''
 +
|-
 +
| default:      || pull from selected object
 +
|-
 +
| type/format/DB:  || see [[Tbl Airline#NumericCode]]
 +
|-
 +
| required?:    || Y
 +
|-
 +
| validation type:  || stop on max / zk standard / on submit  // [[TBD]]
 +
|}
-
This is the same component as [[#Add Airlines Panel]] but with values pre-filled from selected Airline.
 
-
=== Warning and Error Windows ===
+
===== Carrier's headquarter address  ===== 
-
See Use Cases.
+
 +
{| {{table}} border="1"
 +
| '''Attribute:''' || '''Value:'''
 +
|-
 +
| widget type:        || [[Textbox]]
 +
|-
 +
| adjusent label:        || ''Carrier's headquarter address:''
 +
|-
 +
| default:      || pull from selected object
 +
|-
 +
| type/format/DB:  ||  see [[Airline_bo#Carrier.27s_headquarter_address]]
 +
|-
 +
| required?:    || N
 +
|-
 +
| validation type:  || stop on max / zk standard / on submit  // [[TBD]]
 +
|}
-
== TS: Functionality ==
+
===== Agent's IATA code ===== 
 +
 
 +
{| {{table}} border="1"
 +
| '''Attribute:''' || '''Value:'''
 +
|-
 +
| widget type:        || [[Textbox]]
 +
|-
 +
| adjusent label:        || ''Agent's IATA code:''
 +
|-
 +
| default:      || pull from selected object
 +
|-
 +
| type/format/DB:  ||  see [[Airline_bo#Agent.27s_IATA_code]]
 +
|-
 +
| required?:    || N
 +
|-
 +
| validation type:  || stop on max / zk standard / on submit  // [[TBD]]
 +
|}
 +
 
 +
===== Carrier's account number ===== 
 +
 
 +
{| {{table}} border="1"
 +
| '''Attribute:''' || '''Value:'''
 +
|-
 +
| widget type:        || [[Textbox]]
 +
|-
 +
| adjusent label:        || ''Agent's IATA code:''
 +
|-
 +
| default:      || pull from selected object
 +
|-
 +
| type/format/DB:  ||  see [[Airline_bo#Carrier.27s_account_number]]
 +
|-
 +
| required?:    || N
 +
|-
 +
| validation type:  || stop on max / zk standard / on submit  // [[TBD]]
 +
|}
 +
 
 +
==== Add Airlines Window ====
 +
 
 +
This is the same component as [[#Edit Airlines Window]] but with all values defaulted to blank.
 +
 
 +
==== Warning and Error Windows ====
 +
 
 +
These are standard windows. See Use Cases.
 +
 
 +
=== TS: Functionality ===
See below a list of Use Cases (UC) and Test Cases (TC).
See below a list of Use Cases (UC) and Test Cases (TC).
-
=== UC: Find Airline ===
+
==== UC1: Find Airline ====
# scroll up / down
# scroll up / down
# click several times on table headers to sort up and down; scroll
# click several times on table headers to sort up and down; scroll
-
=== UC: Edit Airline. All fields are entered in a valid format ===
+
==== UC2: Edit Airline. All fields are entered in a valid type/format. Click on "OK" ====
-
# Select airline from the list
+
1/ Select airline from the list
-
# Click on *Add* button
+
2/ Click on *Add* button
-
# [[#Add Airlines Window]] appears
+
3/ [[#Add Airlines Window]] appears
-
# Edit all fields
+
4/ set all fields in a valid type/format
-
# click on "OK" or "Cancel"
+
5/ click on "OK"
-
# system silently closes the window; user can see that fields on [[#Add Airlines Window]]  are updated  
+
6/ system silently closes the window; user can see that fields on [[#Add Airlines Window]]  ARE updated  
-
=== UC: Edit Airline. Some fields are entered in invalid format ===
+
==== UC3: Edit Airline. All fields are entered in a valid format. Click on "Cancel" ====
-
=== UC: Edit Airline. Some required fields are blank ===
+
1-4/ as in above UC
 +
5/ click on "Cancel" 
 +
6/ system silently closes the window; user can see that fields on [[#Add Airlines Window]]  ARE NOT updated
-
==== Use Case: Archive and Unarchive ====
+
==== UC4: Edit Airline. Some fields are entered in invalid type/format ====
 +
 
 +
1-3/ as in UC2
 +
# set some fields in invalid type/format
 +
# click on "OK" 
 +
# system gives [[Window#Error]]. Message specify WHAT filed and WHAT is the problem.
 +
 
 +
==== UC: Archive and Unarchive ====
* Apply standard archive functionality: [[Archive (Feature)]] .
* Apply standard archive functionality: [[Archive (Feature)]] .
* List ALL archived on [[#List All]]
* List ALL archived on [[#List All]]
 +
 +
==== UC: TBD ====
 +
[[TBD]]
 +
 +
==== TC: Set 2 airlines with the same code ====
 +
System must give [[Window#error]] saying: "Airline with this code already exists."
 +
 +
==== TC: TBD ====
 +
[[TBD]]
 +
 +
==== TC: Misc ====
 +
 +
Here is the list of Standard TCs that can be applied for this component:
 +
 +
[[TBD]]
=== Special Cases and Misc ===
=== Special Cases and Misc ===
Line 109: Line 246:
== Quality Assurance  ==
== Quality Assurance  ==
-
See list of [[Use Case]]s and [[Test Case]]s below.
+
{| {{table}} border="1"
 +
| '''Section maintained by:''' || '''In completed state?:''' || '''Last updated by/on:'''
 +
|-
 +
|  [[TBD]]         || Yes      || --[[User:Alex|Alex]] 20:29, 23 January 2010 (UTC)
 +
|}
-
* see [[#Use Case: Find Airline]]
+
 
-
* see [[#Use Case: Edit Airline]]
+
See list of major [[Use Case]]s and [[Test Case]]s defined in section [[#TS: Functionality ]].
-
* see [[#Use Case: Add Airline]]
+
 
-
* see [[#Use Case: Delete Airline]]
+
Additional cases defined below:
-
* see [[#Use Case: Archive Airline]]
+
 
-
* see [[#Use Case: UnArchive Airline]]
+
[[TBD]]
== Look And Feel ==
== Look And Feel ==
Line 122: Line 263:
''This section is to be written / defined by [[Graphic Designer]] and [[UI Designer]].
''This section is to be written / defined by [[Graphic Designer]] and [[UI Designer]].
 +
{| {{table}} border="1"
 +
| '''Section maintained by:''' || '''In completed state?:''' || '''Last updated by/on:'''
 +
|-
 +
|  [[TBD]]          || Yes      || --[[User:Alex|Alex]] 20:29, 23 January 2010 (UTC)
 +
|}
== Figures ==
== Figures ==
Line 131: Line 277:
[[File:Airlines Edit.JPG]]
[[File:Airlines Edit.JPG]]
-
== Questions and RFC ==
+
=== Figure 2: Edit Airline Local info  ===
 +
[[File:Airline.JPG]]
-
== Known Non Critical Bugs ==
+
== Questions  ==
 +
== RFC and Ideas for Future ==
-
== Links to Archived / Old specs ==
+
== Known Non Critical Bugs ==
== History ==
== History ==
 +
{| {{table}} border="1"
 +
| '''Section maintained by:''' || '''In completed state?:'''
 +
|-
 +
|  [[TBD]]          || Yes       
 +
|}
-
=== This doc has been created ===
+
=== Links to Archived / Old specs ===
-
 
+
None.
-
--[[User:Alex|Alex]] 18:51, 23 January 2010 (UTC)<date/signat>
+
=== Re-design (Tweak) (Spec Update): ..... <summary> ..... ===
=== Re-design (Tweak) (Spec Update): ..... <summary> ..... ===
Line 153: Line 305:
* Tech Spec updated? N/Y
* Tech Spec updated? N/Y
-
== DB ==
+
=== 0002658: (Carriers) Add archive option for duplicate carriers that are already used in the system ===
 +
 
 +
*Currently there are only options to Add Edit and Remove a carrier.  We need options to be able to archive a carrier that's no longer being used in transportation.
 +
 
 +
*WU: ?
 +
 
 +
== Implementation ==
 +
{| {{table}} border="1"
 +
| '''Section maintained by:''' || '''In completed state?:''' 
 +
|-
 +
|  [[TBD]]          || Yes       
 +
|}
 +
 
 +
=== DB ===
* see [[Tbl Airline]]
* see [[Tbl Airline]]
-
== Code ==
+
=== Front End Code ===
http://mantis.jaguarfreight.com/svn/repo2/cybertrax/trunk/java/CyberTrax/proto2.0.1f/admin/carriers/
http://mantis.jaguarfreight.com/svn/repo2/cybertrax/trunk/java/CyberTrax/proto2.0.1f/admin/carriers/
 +
 +
=== Back End Code ===
 +
 +
...

Current revision as of 16:41, 26 September 2011


Contents

[edit] Classified As, Parent Mantis, Prerequisites

  • Prerequisites: none

[edit] Business Needs and Requirements

Section maintained by: In completed state?:
Alex Yes

We need a place in the system where we manage Airlines. This is to be used on CT record, reports, pdfs, etc.

Required functionality: list, add, edit, delete, archive.

[edit] Technical Notes from Systems Architect

Section maintained by: In completed state?:
Alex Yes

This is a typical Admin component. Please apply standard patterns.

[edit] Technical Specification (TS)

Section maintained by: In completed state?:
TBD Yes

[edit] TS: Summary

[edit] TS: User Interface

Consists of the following components - see below.

[edit] List All Airlines Panel

See #Figure 1: List Airlines

It has the following components:

  • Buttons: Add, Edit, Remove.
  • Listbox: with properties defined below:
    • Columns: one per each field for object #Airline
    • Sort: every column, alphabetical
    • Paging: none
    • Default sorting order: TBD

[edit] Edit Airlines Window

Attribute: Value:
widget type: Window#Edit
caption: Edit Airline
see Figure: #Figure 2: Edit Airline

This window hosts the widgets below:

[edit] Name
Attribute: Value:
widget type: Textbox
adjusent label: Name:
default: pull from selected object
type/format/DB: see Tbl Airline#Name
required?: Y
validation type: zk standard / on submit // TBD
[edit] Airline 2 Letter Code
Attribute: Value:
widget type: Textbox
adjusent label: 2 Letter Code:
default: pull from selected object
type/format/DB: see Tbl Airline#TwoLetterCode
required?: Y
validation type: stop on max / zk standard / on submit // TBD


[edit] Airline 3 Letter Numeric Code:
Attribute: Value:
widget type: Textbox
adjusent label: Numeric Code:
default: pull from selected object
type/format/DB: see Tbl Airline#NumericCode
required?: Y
validation type: stop on max / zk standard / on submit // TBD


[edit] Carrier's headquarter address
Attribute: Value:
widget type: Textbox
adjusent label: Carrier's headquarter address:
default: pull from selected object
type/format/DB: see Airline_bo#Carrier.27s_headquarter_address
required?: N
validation type: stop on max / zk standard / on submit // TBD
[edit] Agent's IATA code
Attribute: Value:
widget type: Textbox
adjusent label: Agent's IATA code:
default: pull from selected object
type/format/DB: see Airline_bo#Agent.27s_IATA_code
required?: N
validation type: stop on max / zk standard / on submit // TBD
[edit] Carrier's account number
Attribute: Value:
widget type: Textbox
adjusent label: Agent's IATA code:
default: pull from selected object
type/format/DB: see Airline_bo#Carrier.27s_account_number
required?: N
validation type: stop on max / zk standard / on submit // TBD

[edit] Add Airlines Window

This is the same component as #Edit Airlines Window but with all values defaulted to blank.

[edit] Warning and Error Windows

These are standard windows. See Use Cases.

[edit] TS: Functionality

See below a list of Use Cases (UC) and Test Cases (TC).

[edit] UC1: Find Airline

  1. scroll up / down
  2. click several times on table headers to sort up and down; scroll

[edit] UC2: Edit Airline. All fields are entered in a valid type/format. Click on "OK"

1/ Select airline from the list 2/ Click on *Add* button 3/ #Add Airlines Window appears 4/ set all fields in a valid type/format 5/ click on "OK" 6/ system silently closes the window; user can see that fields on #Add Airlines Window ARE updated

[edit] UC3: Edit Airline. All fields are entered in a valid format. Click on "Cancel"

1-4/ as in above UC 5/ click on "Cancel" 6/ system silently closes the window; user can see that fields on #Add Airlines Window ARE NOT updated

[edit] UC4: Edit Airline. Some fields are entered in invalid type/format

1-3/ as in UC2

  1. set some fields in invalid type/format
  2. click on "OK"
  3. system gives Window#Error. Message specify WHAT filed and WHAT is the problem.

[edit] UC: Archive and Unarchive

[edit] UC: TBD

TBD

[edit] TC: Set 2 airlines with the same code

System must give Window#error saying: "Airline with this code already exists."

[edit] TC: TBD

TBD

[edit] TC: Misc

Here is the list of Standard TCs that can be applied for this component:

TBD

[edit] Special Cases and Misc

None.

[edit] Quality Assurance

Section maintained by: In completed state?: Last updated by/on:
TBD Yes --Alex 20:29, 23 January 2010 (UTC)


See list of major Use Cases and Test Cases defined in section #TS: Functionality .

Additional cases defined below:

TBD

[edit] Look And Feel

This section is to be written / defined by Graphic Designer and UI Designer.

Section maintained by: In completed state?: Last updated by/on:
TBD Yes --Alex 20:29, 23 January 2010 (UTC)

[edit] Figures

[edit] Figure 1: List Airlines

File:Airlines.JPG

[edit] Figure 2: Edit Airline

File:Airlines Edit.JPG

[edit] Figure 2: Edit Airline Local info

File:Airline.JPG

[edit] Questions

[edit] RFC and Ideas for Future

[edit] Known Non Critical Bugs

[edit] History

Section maintained by: In completed state?:
TBD Yes

[edit] Links to Archived / Old specs

None.

[edit] Re-design (Tweak) (Spec Update): ..... <summary> .....

<wiki date/signature>

  • mantis: <link>
  • Biz Req updated? N/Y
  • Tech Spec updated? N/Y

[edit] 0002658: (Carriers) Add archive option for duplicate carriers that are already used in the system

  • Currently there are only options to Add Edit and Remove a carrier. We need options to be able to archive a carrier that's no longer being used in transportation.
  • WU: ?

[edit] Implementation

Section maintained by: In completed state?:
TBD Yes

[edit] DB

[edit] Front End Code

http://mantis.jaguarfreight.com/svn/repo2/cybertrax/trunk/java/CyberTrax/proto2.0.1f/admin/carriers/

[edit] Back End Code

...

Retrieved from "https://wiki.jaguarfreight.com/Airlines_(component)"
Personal tools