System Requirements Document (SRD)

Project Name: EnergiTek Map Automation

1. Introduction

The EnergiTek Map Automation project is a full-stack SaaS web application designed for automated PDF network map comparison and annotation. This document outlines the system requirements for the application, ensuring it meets the needs of its intended users: Admins and Designers.

The system will allow users to upload "Before" and "After" PDF network maps, process these files using AI/ML pipelines to detect differences, and generate annotated PDFs. The application is tailored for non-technical users, ensuring ease of use and accessibility.

This document has been prepared for Aanal Trivedi, based in India, and reflects locale-specific considerations such as timezone (IST) and currency (INR) where applicable.

2. System Overview

The EnergiTek Map Automation application will consist of the following core functionalities:

1. Authentication & User Management: Secure access with role-based permissions.
2. Create Project: Guided input flow for creating projects with node selection and specific workflows for coax and fiber.
3. Projects Listing: Simple table format for viewing project details and statuses.
4. Queue System: Reliable background job processing for scalable operations.
5. AI Processing Pipeline: Modular design for future AI integrations.
6. Dashboard UI: Unified interface for both Admins and Designers.
7. Notifications: Email alerts for key events like job completion or failure.
8. Selective Re-run Capability: Users can manually trigger SRD regeneration for specific projects.

The system will cater to two user roles: Admins and Designers. Admins will manage users and projects, while Designers will focus on uploading and working with PDFs.

3. Functional Requirements

Authentication & User Management

• As Admin, I should be able to invite Designers via email.
• As Admin, I should be able to manage user roles and permissions.
• As Designer, I should be able to sign up, log in, and access my assigned projects.
• As Designer, I should be able to reset my password if forgotten.

Create Project

• As Designer, I should be able to select a node type (1x1, 2x2, 3x3, 4x4).
• As Designer, I should be able to provide common input details such as Instance Name, Prism Image, PID(s), and Node Name(s).
• As Designer, I should be guided through specific workflows for coax and fiber inputs.
• As Designer, I should be able to upload required files (e.g., PDFs, BOMs, schematics).

Projects Listing

• As Admin, I should be able to view all projects in a table format with statuses and outputs.
• As Designer, I should be able to view only my assigned projects in a table format with statuses and outputs.

Queue System

• As System, I should process uploaded PDFs asynchronously using a job queue.
• As System, I should handle tasks like PDF ingestion, AI processing, and annotation generation.

AI Processing Pipeline

• As System, I should detect differences between "Before" and "After" PDFs.
• As System, I should generate annotated PDFs highlighting detected changes.

Dashboard UI

• As Designer, I should see a summary of my projects and their statuses on the dashboard.
• As Admin, I should see an overview of all projects, including in-progress and completed jobs.

Notifications

• As Admin, I should receive email notifications when a Designer is invited.
• As Designer, I should receive email notifications when a job is completed or fails.

Selective Re-run Capability

• As Designer, I should be able to manually trigger SRD regeneration for specific projects.
• As Admin, I should be able to view and approve selective re-run requests.

4. User Personas

Admin

• Role: Manages users and projects.
• Responsibilities: Inviting Designers, assigning projects, overseeing progress.
• Technical Skill Level: Moderate.

Designer

• Role: Uploads PDFs and works on annotations.
• Responsibilities: Uploading files, tracking processing, downloading results.
• Technical Skill Level: Low (non-IT users).

5. Visuals Colors and Theme

Color Palette

The EnergiTek Map Automation application will use the specified color palette for a cohesive and professional look:

• Background: #F5F9FF (soft blue-gray for a clean workspace)
• Surface: #FFFFFF (neutral white for clarity)
• Text: #1954BF (deep blue for readability and branding)
• Accent: #F0B70F (vibrant yellow for highlights and buttons)
• Muted Tones: #C4D3E0 (light steel blue for secondary elements)

6. Signature Design Concept

Simplified Project Creation Flow

The homepage will feature a clean and modern dashboard tailored for non-technical users.

Key Features:

• Streamlined Navigation: Only essential options like "Dashboard," "Create Project," "Projects," and "Logout" are visible.
• Guided Project Creation: A step-by-step flow for selecting node types and uploading required files.
• Table-Based Project Listing: Projects are displayed in a simple table format with statuses and outputs.
• Color-Coded Status Badges: Visual indicators for project statuses (e.g., Pending, Processing, Completed, Failed).
• Micro-Interactions: Smooth transitions and hover effects for buttons and table rows.

This design ensures ease of use while maintaining a professional aesthetic.

7. Non-Functional Requirements

• Scalability: Support for hundreds of concurrent users and projects.
• Reliability: Ensure async job processing is robust and fault-tolerant.
• Security: Implement secure file handling and role-based access control.
• Performance: Optimize AI pipelines for fast processing of large PDFs.
• Accessibility: Design UI for non-technical users with intuitive navigation.

8. Tech Stack

Frontend

• React for Web

Backend

• FastAPI

Database

• PostgreSQL

Queue System

• Celery + Redis

AI Models

• GPT 5.4 for user-friendly responses
• PyMuPDF for PDF processing

Local Orchestration

• Docker + docker-compose

Server-Side Orchestration

• Kubernetes

9. Assumptions and Constraints

Assumptions

• Users will primarily access the system via web browsers.
• Designers are non-technical and require a simple, intuitive interface.
• Admins will manage user invitations and project assignments.

Constraints

• Processing large PDFs may require significant computational resources.
• AI pipeline integration will initially use mock endpoints.

10. Glossary

• PDF Network Map: A visual representation of network connections in PDF format.
• Annotated PDF: A PDF file with added highlights, comments, or graphical annotations.
• Async Job Queue: A system for processing tasks asynchronously in the background.
• Celery: A Python-based task queue system.
• Redis: An in-memory data structure store used for caching and message brokering.
• PyMuPDF: A Python library for PDF processing.
• FastAPI: A modern web framework for building APIs with Python.

This document ensures the EnergiTek Map Automation application is designed to meet the needs of its users while maintaining scalability, reliability, and ease of use.