System Requirements Document

Project Overview

Project Name: Dispatch
Domain: Delivery Management
Purpose: The Dispatch system is designed to manage delivery schedules, track changes, and identify issues before they reach the site. It supports loading reports, comparing data, and analyzing risks associated with delivery schedules.

Features

General Features

• File Upload: Supports uploading delivery reports in Excel (.xlsx, .xls) or CSV formats.
• Data Visualization: Provides calendar, table, and list views for visualizing delivery schedules.
• User Management: Allows users to select their identity and manage deliveries assigned to them.
• Search and Filter: Offers search functionality and various filters to refine delivery data.
• Risk Analysis: Analyzes delivery schedules to identify risks and overdue tasks.

Specific Features

• Calendar View: Displays delivery schedules on a calendar with day-specific details.
• Table View: Provides a tabular representation of delivery data with sorting and filtering capabilities.
• List View: Offers a list-based view of deliveries with detailed information.
• Compare Reports: Allows comparison between two delivery reports to identify changes.
• Risk Tracker: Loads forecast reports to analyze CSMR status and measure deadlines.
• Column Mapping: Auto-detects and maps columns from uploaded files, with manual mapping support if needed.

Technical Specifications

Tech Stack

• Frontend: HTML, CSS, JavaScript
• Libraries and Frameworks:
  • DataTables: For tabular data representation.
  • FullCalendar: For calendar view and event management.
  • XLSX.js: For reading Excel files.
  • jQuery: For DOM manipulation and event handling.

Design Tokens

• Theme: Dark Premium Operations
• Primary Colors: Navy, Accent Blue, Green, Red, Amber, Purple
• Fonts: 'Outfit', sans-serif; 'JetBrains Mono', monospace

APIs and Integrations

• FileReader API: For reading uploaded files.
• IndexedDB: For persisting session data.

User Interface

Navigation

• Top Navigation: Includes brand logo, title, and mode switcher (Viewer, Compare, Risk).
• Bottom Navigation (Mobile): Provides quick access to Viewer, Compare, and Risk modes.

Components

• Drop Zone: For file uploads with drag-and-drop support.
• Toolbar: Contains view toggles, search, filter, and print options.
• Sidebar Panel: Displays filters for user, site, plot, and delivery type.
• Stats Bar: Shows delivery statistics and week breakdowns.
• Modals: Used for detailed views, column mapping, and print previews.

Constraints

• File Size Limit: Maximum file size for uploads is 30 MB.
• Supported Formats: Only .xlsx, .xls, and .csv files are supported.
• Browser Compatibility: Designed for modern browsers with support for HTML5 and JavaScript.

Deliverables

• Initial Setup: Basic file upload and data visualization.
• Feature Enhancements: Implement compare and risk analysis features.
• User Management: Develop user identity and alias system.
• Testing and Deployment: Ensure cross-browser compatibility and performance optimization.

Timeline

• Phase 1: Initial setup and basic features - 4 weeks
• Phase 2: Advanced features and user management - 6 weeks
• Phase 3: Testing, optimization, and deployment - 2 weeks

Conclusion

The Dispatch system aims to streamline delivery management by providing comprehensive tools for data visualization, comparison, and risk analysis. By leveraging modern web technologies and intuitive design, it enhances operational efficiency and decision-making in delivery management.