HeaderSIS.jpg

Difference between revisions of "IS480 Team wiki: 2012T1 Bumblebee Project Documentation"

From IS480
Jump to navigation Jump to search
Line 56: Line 56:
 
|-
 
|-
 
| style= "background:#000000; color: #ffffff; padding: 10px 4px 0 15px; width: 20%; font-size: 13px;" valign="top"  | <b>Brief Description</b>
 
| style= "background:#000000; color: #ffffff; padding: 10px 4px 0 15px; width: 20%; font-size: 13px;" valign="top"  | <b>Brief Description</b>
| style= "background:#ffffff; color: #000000; padding: 10px 4px 0 15px; font-size: 13px;" valign="top"  |User can import flight arrival schedule.csv, flight departure schedule.csv, flight requiremenrs.csv, staff record.csv and staff roster.csv. System will store information in database.
+
| style= "background:#ffffff; color: #000000; padding: 10px 4px 0 15px; font-size: 13px;" valign="top"  |User can import flight_arrival_schedule.csv/txt, flight_departure_schedule.csv/txt, flight_requirements.csv/txt, staff_record.csv/txt and staff_roster.csv/txt. System will store information in database.
  
 
|-
 
|-
 
| style= "background:#000000; color: #ffffff; padding: 10px 4px 0 15px; font-size: 13px;" valign="top"  |<b>Flow of Events</b>
 
| style= "background:#000000; color: #ffffff; padding: 10px 4px 0 15px; font-size: 13px;" valign="top"  |<b>Flow of Events</b>
| style= "background:#ffffff; color: #000000; padding: 10px 4px 0 15px; font-size: 13px;" valign="top"  |  1) User clicks “Browse” and selects targeted file -  flight arrival schedule.csv, flight departure schedule.csv, flight requiremenrs.csv, staff record.csv and staff roster.csv.
+
| style= "background:#ffffff; color: #000000; padding: 10px 4px 0 15px; font-size: 13px;" valign="top"  |  1) User selects “Browse” and selects targeted file -  flight_arrival_schedule.csv/txt, flight_departure_schedule.csv/txt, flight_requirements.csv/txt, staff_record.csv/txt and staff_roster.csv/txt.
  
2) User clicks on “Bootstrap” button.
+
2) User selects “Bootstrap” button.
  
3) System will load the data from the CSV files into corresponding tables in the database.
+
3) System will load the data from the csv or txt files into corresponding tables in the database.
  
 
4) System will direct user to “Manage Simulation Parameters” page.
 
4) System will direct user to “Manage Simulation Parameters” page.
Line 70: Line 70:
 
|-
 
|-
 
| style= "background:#000000; color: #ffffff; padding: 10px 4px 0 15px; font-size: 13px;" valign="top"  |<b>Alternate Flows</b>
 
| style= "background:#000000; color: #ffffff; padding: 10px 4px 0 15px; font-size: 13px;" valign="top"  |<b>Alternate Flows</b>
| style= "background:#ffffff; color: #000000; padding: 10px 4px 0 15px; font-size: 13px;" valign="top"  | 1) User selects file with wrong file type (e.g. .txt instead of .csv). System will prompt user to re-select file.
+
| style= "background:#ffffff; color: #000000; padding: 10px 4px 0 15px; font-size: 13px;" valign="top"  | NA
 
 
2) User does not select any file. System will prompt user to select file before bootstrap.
 
 
 
3) User selects file with wrong format. System will prompt user which file format is wrong and request user to re-select file.
 
  
 
|-
 
|-
 
| style= "background:#000000; color: #ffffff; padding: 10px 4px 0 15px; font-size: 13px;" valign="top"  |<b>Special Requirements</b>
 
| style= "background:#000000; color: #ffffff; padding: 10px 4px 0 15px; font-size: 13px;" valign="top"  |<b>Special Requirements</b>
| style= "background:#ffffff; color: #000000; padding: 10px 4px 0 15px; font-size: 13px;" valign="top"  | User must select the right csv files with the right formats.
+
| style= "background:#ffffff; color: #000000; padding: 10px 4px 0 15px; font-size: 13px;" valign="top"  | User must select the right csv/txt files with the right formats.
 
 
User must select the right csv files with the right formats.
 
  
 
Data format is ignored if irrelevant
 
Data format is ignored if irrelevant
 
  
 
'''Flight Schedule Format - Departure'''
 
'''Flight Schedule Format - Departure'''
Line 136: Line 129:
  
 
Column Y: Rem. DEP Daily
 
Column Y: Rem. DEP Daily
 
  
 
'''Flight Schedule  Format - Arrival'''
 
'''Flight Schedule  Format - Arrival'''
Line 188: Line 180:
 
Column X: Rem. ARR Daily
 
Column X: Rem. ARR Daily
  
 +
'''Flight Requirements Format'''
  
'''Flight Requirements Format'''
+
'''Gate Departure'''
  
 
Column A: Airline (Text)
 
Column A: Airline (Text)
  
Column B: No_of_Narrowed_Flights (Number)
+
Column B: Aircraft Type (Text)
 +
 
 +
Column C: CSO at Gate (Number)
  
Column C: No_of_Wide_Flights (Number)
+
Column D: CSA at Gate (Number)
  
Column D: Ctr_Required_CSO (Number)
+
Column E: Gate Opening Hours (Number)
  
Column E: Ctr_Required_CSA (Number)
+
'''Counter Departure'''
  
Column F: Gate_Required_CSO (Number)
+
Column G: Airline (Text)
  
Column G: Ctr_Required_CSA (Number)
+
Column H: No of Narrow Aircraft (Number)
  
 +
Column I: No of Wide Aircraft (Number)
 +
 +
Column J: CSO at Counter (Number)
 +
 +
Column K: CSO at Counter (Number)
 +
 +
Column L: Counter Opening Hours(Number)
 +
 +
'''Gate Arrival'''
 +
 +
Column N: Airline (Text)
 +
 +
Column O: CSO at Gate (Number)
 +
 +
Column P: CSO at Gate (Number)
  
 
'''Staff Record Format'''
 
'''Staff Record Format'''
Line 214: Line 224:
 
Column C: STF NO. (Text)
 
Column C: STF NO. (Text)
  
Column D:  
+
Column D: NA
  
Column E:  
+
Column E: NA
  
 
Column F: DOJ (d-mmm-yy)
 
Column F: DOJ (d-mmm-yy)
Line 271: Line 281:
  
 
Column AB: Kriscom - SQ (Text)
 
Column AB: Kriscom - SQ (Text)
 
  
 
'''Staff Roster Format'''
 
'''Staff Roster Format'''
Line 281: Line 290:
 
Column C: RosterCycle (Text)
 
Column C: RosterCycle (Text)
  
Column D: Mon (Normal shift - Row [2]: Start Time, Row [3]: End Time, Split Shift – Row[2]: 1st Start Time – End Time, Row[3] 2nd  
+
Column D: Mon (Normal shift - Row [2]: Start Time, Row [3]: End Time, Split Shift – Row[2]: 1st Start Time – End Time, Row[3] 2nd Start Time – End Time) (Text)
Start Time – End Time) (Text)
 
  
Column E: Tue (Normal shift - Row [2]: Start Time, Row [3]: End Time, Split Shift – Row[2]: 1st Start Time – End Time, Row[3] 2nd  
+
Column E: Tue (Normal shift - Row [2]: Start Time, Row [3]: End Time, Split Shift – Row[2]: 1st Start Time – End Time, Row[3] 2nd Start Time – End Time) (Text)
Start Time – End Time) (Text)
 
  
 
Column F: Wed (Normal shift - Row [2]: Start Time, Row [3]: End Time, Split Shift – Row[2]: 1st Start Time – End Time, Row[3] 2nd Start Time – End Time) (Text)
 
Column F: Wed (Normal shift - Row [2]: Start Time, Row [3]: End Time, Split Shift – Row[2]: 1st Start Time – End Time, Row[3] 2nd Start Time – End Time) (Text)
Line 296: Line 303:
  
 
Column J: Sun (Normal shift - Row [2]: Start Time, Row [3]: End Time, Split Shift – Row[2]: 1st Start Time – End Time, Row[3] 2nd Start Time – End Time) (Text)
 
Column J: Sun (Normal shift - Row [2]: Start Time, Row [3]: End Time, Split Shift – Row[2]: 1st Start Time – End Time, Row[3] 2nd Start Time – End Time) (Text)
 
  
 
|-
 
|-

Revision as of 14:41, 9 August 2012

BumbleBee logo.jpg
Home Project Overview Project Documentation Project Management Learning and Growth
Diagrams User Interface User Manual User Acceptance Test Meeting Minutes Presentations

Use Case

Use Case
Use Case Diagram v4.jpg


Use Case Description

Use Case Description

Bootstrap Data

Name Bootstrap Data
Brief Description User can import flight_arrival_schedule.csv/txt, flight_departure_schedule.csv/txt, flight_requirements.csv/txt, staff_record.csv/txt and staff_roster.csv/txt. System will store information in database.
Flow of Events 1) User selects “Browse” and selects targeted file - flight_arrival_schedule.csv/txt, flight_departure_schedule.csv/txt, flight_requirements.csv/txt, staff_record.csv/txt and staff_roster.csv/txt.

2) User selects “Bootstrap” button.

3) System will load the data from the csv or txt files into corresponding tables in the database.

4) System will direct user to “Manage Simulation Parameters” page.

Alternate Flows NA
Special Requirements User must select the right csv/txt files with the right formats.

Data format is ignored if irrelevant

Flight Schedule Format - Departure

Column A: Flight (Text)

Column B: C/S (Text)

Column C: DES (Text)

Column D: VIA (Text)

Column E: nVIA (Number)

Column F: A

Column G: Na (Text)

Column H: STD (h:mm)

Column I: ETD (h:mm)

Column J: COB

Column K: OFB (h:mm)

Column L: CTOT

Column M: RWY

Column N: ATD (h:mm)

Column O: POS (Text)

Column P: Gate 1 (Text)

Column Q: Gate 2 (Text)

Column R: CTR (Text)

Column S: REG (Text)

Column T: A/C (Text)

Column U: Date ATD (Text)

Column V: STATE

Column W REM

Column X: Rem. DEP

Column Y: Rem. DEP Daily

Flight Schedule Format - Arrival

Column A: Flight (Text)

Column B: C/S (Text)

Column C: ORG (Text)

Column D: VIA (Text)

Column E: nVIA (Number)

Column F: A

Column G: Na (Text)

Column H: STA (h:mm)

Column I: ETA (h:mm)

Column J: TMO

Column K: ATA (h:mm)

Column L: RWY

Column M: EON (h:mm)

Column N: ONB (h:mm)

Column O: POS (Text)

Column P: Gate 1 (Text)

Column Q: Belt (Text)

Column R: REG (Text)

Column S: A/C (Text)

Column T: Date ATA (Text)

Column U: STATE

Column V: REM

Column W Rem. ARR

Column X: Rem. ARR Daily

Flight Requirements Format

Gate Departure

Column A: Airline (Text)

Column B: Aircraft Type (Text)

Column C: CSO at Gate (Number)

Column D: CSA at Gate (Number)

Column E: Gate Opening Hours (Number)

Counter Departure

Column G: Airline (Text)

Column H: No of Narrow Aircraft (Number)

Column I: No of Wide Aircraft (Number)

Column J: CSO at Counter (Number)

Column K: CSO at Counter (Number)

Column L: Counter Opening Hours(Number)

Gate Arrival

Column N: Airline (Text)

Column O: CSO at Gate (Number)

Column P: CSO at Gate (Number)

Staff Record Format

Column A: Group(Text)

Column B: Function (Text)

Column C: STF NO. (Text)

Column D: NA

Column E: NA

Column F: DOJ (d-mmm-yy)

Column G: Year of Service (as of 2011) (number)

Column H: DCS Trained (number)

Column I: Sabre 9W (Text)

Column J: Sabre IT (Text)

Column K: Sabre BI (Text)

Column L: Sabre VN (Text)

Column M: BABS- BA (Text)

Column O: Travelsky - CA/CZ/HX/MF/MU/NX/ZH (Text)

Column K: Babel - EY (Text)

Column L: Babel - GE (Text)

Column M: Jalpas - JL (Text)

Column N: Topas - KE (Text)

Column O: Pictures - LH (Text)

Column P: Liason - MH (Text)

Column Q: Able- NH (Text)

Column R: Artis II - OZ (Text)

Column S: Smile - PR (Text)

Column T: Jalpas - JL (Text)

Column U: Altea - QF (Text)

Column V: Royal - TG (Text)

Column W: Troya- TK (Text)

Column X: Fastair - UA (Text)

Column Y: Shares - CO (Text)

Column Z: Smile - PR (Text)

Column AA: SITA - AI (Text)

Column AB: Kriscom - SQ (Text)

Staff Roster Format

Column A: StaffNo (Text)

Column B: RosterID (Text)

Column C: RosterCycle (Text)

Column D: Mon (Normal shift - Row [2]: Start Time, Row [3]: End Time, Split Shift – Row[2]: 1st Start Time – End Time, Row[3] 2nd Start Time – End Time) (Text)

Column E: Tue (Normal shift - Row [2]: Start Time, Row [3]: End Time, Split Shift – Row[2]: 1st Start Time – End Time, Row[3] 2nd Start Time – End Time) (Text)

Column F: Wed (Normal shift - Row [2]: Start Time, Row [3]: End Time, Split Shift – Row[2]: 1st Start Time – End Time, Row[3] 2nd Start Time – End Time) (Text)

Column G: Thu (Normal shift - Row [2]: Start Time, Row [3]: End Time, Split Shift – Row[2]: 1st Start Time – End Time, Row[3] 2nd Start Time – End Time) (Text)

Column H: Fri (Normal shift - Row [2]: Start Time, Row [3]: End Time, Split Shift – Row[2]: 1st Start Time – End Time, Row[3] 2nd Start Time – End Time) (Text)

Column I: Sat (Normal shift - Row [2]: Start Time, Row [3]: End Time, Split Shift – Row[2]: 1st Start Time – End Time, Row[3] 2nd Start Time – End Time) (Text)

Column J: Sun (Normal shift - Row [2]: Start Time, Row [3]: End Time, Split Shift – Row[2]: 1st Start Time – End Time, Row[3] 2nd Start Time – End Time) (Text)

Preconditions User wants to load data from CSV to database.
Post Conditions Data from the CSV is loaded to database.

Manage Airline Requirements

Name Manage Airline Requirements
Brief Description This use case allows user to customize (add, edit) the business logic of airline requirements in the simulation.
Flow of Events 1) User clicks on “Manage Airline Requirements”.

2) System will direct user to Manage Airline Requirements page where user can choose to manage counter requirements of airlines.

3) User chooses airlines and the system will displayed the flight requirements of the particular airline.

4a) User may then add on the list of user requirements, by choosing the number of narrow or/and wide body flight(s) and its required number of counter CSA and CSO and gate CSA and CSO.

5a) User clicks “Save” button.

6a) System will save and display user’s inputs and use these criteria to simulate the roster plan.

4b) User select existing flight requirements listed on table and clicks “Edit” button

5b) User changes the value and clicks “Save” button.

6b) System will save and display user’s inputs and use these criteria to simulate the roster plan.

Alternate Flows 1) Some fields such are left empty when user clicks “Save”.

2) System will prompt that there is an incomplete input in the empty field.

Special Requirements All fields must be filled before save.
Preconditions User wants to customize the airline requirements for certain flights.

Bootstrap is completed.

Post Conditions Customise airline requirements will be saved into the database and will be used for simulation.

Manage Simulation Paramaters

Name Manage Simulation Parameters
Brief Description User can input OT Cost per hour, Recall cost per hour for both off day and rest day, MAC Cost per hour for breakfast, lunch and dinner, simulation period, MC rate, ad hoc leave rate, staff resign rate, new staff rate for simulation.
Flow of Events 1) User keys in OT Cost per hour, Recall Cost per hour (off day and rest-day), MAC Cost Per hour (breakfast, lunch and dinner).

2) User keys in simulation period.

3) User keys in mean and standard deviation for uncertainties such as MC rate (person/day), ad-hoc leave rate (person/day), staff resign rate (person/month), and new staff rate (person/month).

4) User clicks “Start Simulation” button.

5) System will generate a normal distribution for each parameter.

6) System will generate a normal distribution for flight delays based on flight arrival schedule.csv and flight departure schedule.csv.

7) System will store the parameters and the generated distribution in the database.

Alternate Flows 1) User inputs a value that is not valid (e.g. empty, negative value or non numerical value for MC rate).

2) System will prompt user to re-enter the value.

Special Requirements User must key in a valid value for the parameters. Entering of OT Cost , Recall cost, MAC Cost and Simulation Period are mandatory Entering of , MC rate, ad hoc leave rate, staff resign rate, new staff rate for simulation are not mandatory but both mean and standard deviation of each parameter are required once it is entered.
Preconditions User wants to input parameters into the database for simulation purpose.

User’s inputs for parameters are valid and correct.

Post Conditions Parameters will be stored into the database according to user’s inputs.

Simulation Parameters.csv, Flight Arrival Simulation Parameters.csv, Flight Departure Simulation Parameters.csv are created.

Simulate Staff Deployment

Name Simulate Staff Deployment
Brief Description Based on input flight schedule and flight requirements, system will allocate tasks to staff based on their qualifications and their corresponding roster.

Based on the given uncertainties, system will apply uncertainties onto a roster plan. Following that, the system mimics action done by Duty Manager such as allocating task to other staff who is free at a particular time.


Flow of Events 1) User clicks “Start Simulation” after manage simulation parameters.

2) System will Start Scheduling Staff Roster (stage 1/2) to fulfill all the flight requirements

3a) If user clicks “Cancel”, system will stop scheduling staff roster immediately.

3b) After scheduling staff roster is successful, system will continue to simulate staff deployment (stage 2/2).

4b) After system finished the deployment, system will direct user to Simulation Result page.

4c) User clicks on “Cancel” button.

5c) System will stop the simulation. Only staff roster schedule will be updated in database.

Alternate Flows NA
Special Requirements Bootstrap is successful.

Manage Simulation Parameters is done. Manage Airline Requirements is done if it is not bootstrapped.

Preconditions User wants to deploy staff based on input flight schedule, flight requirements, staff record and roster plan.

User wants to simulate the current roster plan based on the uncertainties generated. Bootstrap is completed and uncertainties are successfully generated.

Post Conditions Staff_Deployment_Roster is populated.

Simulation result of the planned roster will be generated and displayed on simulation result page.

Manage Result

Name Manage Result
Brief Description This use case allows user to manage the result from the previous simulations. This includes filter function, view and deletes results function. User can choose to export viewed result as PDF. The result includes Total Staff Working Hours, Staff Utilization Rate, Unproductive Hours, OT Hours, OT Cost, Recall Cost, Recall Hours and Meal Allowance Compensation (MAC)
Flow of Events 1) User clicks on ‘Manage Result’ option.

2) User can choose to filter the result specific to certain periods based on dates.

3) System will display the list of past simulation results within the periods specified.

4) User clicks on the result.

5) User can choose to

a.view the result.

b.delete the result(s).

6a) System displays the simulation result.

7a) User clicks on “Export PDF” option.

8a) System organizes the result into report’s structure.

9a) System exports the result as PDF report and prompts user to locate destination to save the PDF report.

10a) User locates destination and saves the file.


6b) System will delete the record of result(s) selected.

Alternate Flows NA
Special Requirements Simulate Staff Deployment is successful.

All uncertainties are mandatory.

Preconditions User has produced simulation result(s).

User wants to export simulation result as PDF file or view the simulation result. Simulate Staff Deployment is completed.

Post Conditions Result is displayed/ viewed, filtered or deleted.

The simulation result is exported into a PDF file.


Sequence Diagram

Sequence Diagram

Bootstrap Data

BootstrapDataSD.jpg

Manage Airline Requirements

ManageAirlineRequirementsSD.jpg

Manage Simulation Parameters

ManageSimulationParametersSD.jpg

Simulate Staff Deployment

SimulateStaffDeploymentSD.jpg

Manage Result

ManageResultSD.jpg

ER Diagram

ER Diagram
Bumblebee ER Diagram.jpg


Logical Diagram

Logical Diagram

BumblebeeLogicalDiagram.jpg