Skip to content

Requirements

Austin edited this page Oct 16, 2017 · 11 revisions

Client’s Requirements

  1. Portable (1.1)
  2. Can run without being installed on a Windows PC (1.1)
  3. Dynamic and customizable schedule and roster output page i.e, headers and footers. (2.1, 2.2)
  4. Can save schedule and roster output in various file types e.g., pdf, html… (4.4)
  5. Can generate XML output for future network extendibility (4.4)

Project Requirements

1.0. Software

  • 1.1. Written in java and distributed as a jar file for portability

2.0. Startup

  • 2.1. Password protected
  • 2.2. Popup startup menu with step by step tutorial with check box to enable/disable startup menu
  • 2.3. The startup menu can be opened later from Tools > Step-by-step tutorial

3.0. Settings

  • 3.1. Custom header and footers for all reports, e.g., rosters, schedules, reports and forms.
  • 3.2. Font options for all reports, e.g., rosters, schedules, reports and forms.

4.0. Main Screen (Roster Editor)

  • 4.1. Menu Bar and Toolbar
  • 4.2. The main screen will consist of tabs containing rosters that will look familiar to original army duty roster form “DA-6.”
    • 4.2.1. Tab order will set roster priority
    • 4.2.2. Create new roster will generate a new tab with “New Roster.”
  • 4.3. Each roster can be toggled between roster editor and schedule view.
    • 4.3.1. Roster Editor:
      • 4.3.1.1. The rows will be a listing of employees, and the columns will be increment start numbers and days of the month from 1 to last day of the month, showing one month’s worth of data at a time.
      • 4.3.1.2. The month and year, and will have a button to shift one month at a time forward or back.
    • 4.3.2. Schedule View:
      • 4.3.2.1. Consists of a calendar control and a itinerary view.
      • 4.3.2.2. Can print and export itinerary based on print start and end dates.
  • 4.4. Export formats will be .txt, .pdf, and .csv

5.0. Add Employees

  • 5.1. Table view of employees who have already been added.
  • 5.2. Tables allows employees to be edited.
  • 5.3. Able to import employee information from .csv.
  • 5.4. Able to manually add employees

6.0. Status Editor

  • 6.1. Able to create reason codes and comments for blockout dates.
  • 6.2. These statuses populate drop-down menus in block date editor.
  • 6.3. The Status editor will start out with the Army’s basic default reason codes.

7.0. Block Date Editor

  • 7.1. Able to block out dates for employees for various reasons, using status codes and comments.
  • 7.2. Uses a calendar control for start and end dates.
  • 7.3. This feature may also be added to the main screen, using a status code toggle and mouse-down in specific dates within the roster editor.

8.0. Roster Editor

  • 8.1. This requirement has been embedded into the main screen, and no longer requires its own screen.

9.0. Print

  • 9.1. Roster (Army Form Da-6 without customizable header and footer), and remarks page listing blockout dates with reasons.
  • 9.2. Schedules:
    • 9.2.1. Itinerary format based on selected state and end dates.
    • 9.2.2. Calendar format based on selected state and end dates.
    • 9.2.3. Employee listing, which can be filtered by 1 one or more rosters.

You can see our designs here: https://github.com/SCCapstone/Code-Commandos/wiki/Design