HLD - Bascula
Documento de diseño de alto nivel
Versión: 1.0
Fecha: 08 Diciembre de 2025
Autor: José Alberto Hernández Galicia
Tabla de Contenido
- Control de Cambios
- Introducción
- Descripción general del contexto y Alcance
- Visión General de la Arquitectura
- 4.2. Capa de la vista física
- 4.3. Capa de la vista lógica
- 4.3.1. Flujo 1
- 4.4. Capa de la vista principal
- Descripción de componentes clave
- 5.2. Atributos de calidad
- 5.3. Restricciones
- Interacciones y flujos de datos
- Decisiones Arquitectónicas y Justificación
- Consideraciones de seguridad y escalabilidad
- Requerimientos no funcionales
- Lineamientos y Estandares de Codificación
1. Control de Cambios
| Versión | Autor | Descripción | Fecha |
|---|---|---|---|
| 1.0 | José Alberto Hernández Galicia | Creación | 09/12/2025 |
2. Introducción
El propósito de este documento de Definición de Arquitectura de Alto Nivel (High-Level Design, HLD) es proporcionar una visión global y comprensiva de la arquitectura del sistema propuesto. Este documento sirve como un puente entre los requisitos del negocio y la implementación técnica detallada, ofreciendo una representación abstracta de los componentes principales del sistema, sus interacciones y las decisiones arquitectónicas clave que guiarán el desarrollo.
A través de este HLD, buscamos proporcionar una guía clara y estructurada que facilitará la transición hacia las etapas de diseño detallado y desarrollo, asegurando que el sistema final sea robusto, eficiente y alineado con los objetivos del negocio.
2.2. Objetivo
Los objetivos del documento son:
Proporcionar una Visión General:
- Describir la arquitectura del sistema en un nivel alto, destacando los componentes principales, sus responsabilidades y cómo interactúan entre sí.
Facilitar la Comunicación:
- Actuar como una herramienta de comunicación entre las partes interesadas, incluyendo gerentes, desarrolladores, arquitectos, y otros involucrados en el proyecto, asegurando que todos tengan una comprensión común del sistema.
Establecer una Base Sólida:
- Sentar las bases para las fases de diseño detallado y desarrollo, proporcionando un marco estructural que guíe las decisiones técnicas y de implementación.
Asegurar la Coherencia y la Escalabilidad:
- Garantizar que el diseño del sistema sea coherente con los objetivos del negocio y pueda escalar para satisfacer futuras necesidades y requerimientos.
2.3. Alcance
Este documento está estructurado para cubrir los siguientes aspectos esenciales de la arquitectura del sistema:
Descripción del Contexto y Alcance:
- Definir el contexto en el que se desarrollará el sistema y los límites de su alcance.
Visión General de la Arquitectura:
- Presentar un diagrama de alto nivel y una descripción de los componentes principales del sistema.
Descripción de Componentes Clave:
- Detallar los componentes principales, sus roles y responsabilidades.
Interacciones y Flujos de Datos:
- Describir cómo interactúan los componentes entre sí y cómo fluyen los datos a través del sistema.
Decisiones Arquitectónicas y Justificación:
- Documentar las decisiones arquitectónicas clave y las razones detrás de ellas.
Consideraciones de Seguridad y Escalabilidad:
- Discutir cómo se abordarán las preocupaciones de seguridad y cómo el diseño permitirá la escalabilidad del sistema.
Requisitos No Funcionales:
- Identificar y describir los requisitos no funcionales importantes que deben ser considerados en el diseño.
2.4. Glosario
La siguiente tabla enlista los términos y sus significados a usarse en el documento:
| TÉRMINO | SIGNIFICADO |
|---|---|
| MSA | Acrónimo usado para referirse a una arquitectura de microservicios. Proviene de las palabras en inglés: MicroServices Architecture |
| AR | Arquitectura de Referencia |
| SOA | Service Oriented Architecture |
| ACID | Atomicity, Consistency, Isolation, Durability |
| TDD | Test Driven Development |
| BDD | Behavior Driven Development |
| DevOps | Development and Operations |
| HTTP | Hypertext Transfer Protocol |
| DDD | Domain Driven Design |
| JSON | JavaScript Object Notation |
| REST | Representational state transfer |
| SOLID | Principios de diseño de software: |
| - S – Single Responsibility Principle (SRP) | |
| - O – Open/Closed Principle (OCP) | |
| - L – Liskov Substitution Principle (LSP) | |
| - I – Interface Segregation Principle (ISP) | |
| - D – Dependency Inversion Principle (DIP) |
3. Descripción general del contexto y Alcance
3.2. Descripción General del Proyecto
Alcance del MVP
- Registrar la salida vinculada a una entrada abierta, con segunda pesada y cálculo de diferencia
- Dar de alta choferes para seleccionarlos al registrar entradas/salidas
- Dar de alta vehículos para asociarlos a movimientos de báscula
- Registrar contenedores/cajas para asociarlos a entradas/salidas
- Dar de alta productos (leche, queso, desechos, etc.) para seleccionarlos en los movimientos y cálculos.
- Administrar usuarios, roles y alcances para controlar quién ve/edita qué módulos.
- Consultar y exportar movimientos para controlar operaciones, diferencias y entradas sin salida
- Un endpoint para consultar Entradas para Disponer información para otros sistemas como YMS o LDV
- Un endpoint para consultar Salidas para Disponer información para otros sistemas como YMS o LDV
Arquitectura Propuesta
La solución propuesta es llevar la implementación de estos procesos a una arquitectura en microservicios con microfrontend dentro de una infraestructura cloud.
Frontend - Módulos
Módulo Usuario
Módulo Camion
Backend - Microservicios
alpura-back-java-msa-balance: Microservicio encargado de toda operativadad del peso de los camiones, como son los registros de las entradas y salidas.
Componentes reutilizables:
-
Catalogo de producos: Actualmente en la arquitectura , se tiene varios compones que se puede reutilizar, como es es el caso de gestor de cátalogos, este apartado vamos dar esta los productos.
-
Gestión Usuario: Este módulo ya existe actualemtne en la arquitectura de Alpura, el cual este nuevo requerimiento podemos reutilizar para la administración de usuario.
-
Reportes : Ya se cuenta con un componente que se puede usar para generar diferentes tipos de reportes, Solo se tiene que configurar en el proyecto de acuerdo a las regals de negocio.
- Solicitar un maquetado html por UX
- El html se deberá guardar a nivel de base de datos.
alpura-back-java-msa-report: Microservicio encargado de realizar los diferentes reportes solicitado por el sistema. -Poder exportar a un Excel/PDF
Base de Datos
Para el sistema de la BÁSCULA se tiene como propuesta una base de datos estructurada (PostgreSQL) para almacenar toda información de usuarios, camion, choferes y administración de contenedores , etc.
Tecnología Frontend
Finalmente, para la interfaz del Usuario se pretende llevar el desarrollo con Angular, donde buscamos mejorar la interacción con las pantallas, que le sea fácil interactuar con la información en los diferentes módulos que proveerá el sistema.
En esta solución se busca mejorar la eficiencia, manejo de errores, ofrecerle al usuario una interfaz intuitiva y la alta disponibilidad de servicio.
Características funcionales
Características no funcionales
3.3. Descripción de Escenarios y Seguimiento
Gestión de Usuario
En el siguiente escenario muestra el usuario pueda tener credenciales para poder acceder al sistema
- Ingresar usuario,contraseña
- De acuerdo al rol de cada usuario , va poder ver diferentes pantallas
- La sesión se registra y le muestra la pantalla
Alta y Edición
- Dar de alta un usuario
- Poder asignarle un rol como son :
- Entrada
- Salida
- Catálogos
- reportes
- Control de acceso por planta/bascula
- Poder realizar búsqueda:
- usuario
- rol
- estado