Manual técnico (Portal de Clientes Almacenes)

Manual técnico
Portal de Clientes
Almacenes

• Documento original
• Video presentación

Fecha: 29 de agosto de 2024
Versión: Ver. 1.0
Proyecto: GM-Almacenes

Elaborado por:

Certuit Software S. de R.L de C.V.
Cerro de las Campanas No. 384, Insurgentes Oeste, CP. 21280

Mexicali, BC. México

Historial de Cambios

Fecha	Secciones	Razón de Cambios	Autor(es)	Revisor(es)
13 de agosto de 2022	TODAS	Creación del documento	Silvia Tolosa
2 de septiembre del 2024	TODAS	Actualización de contenido y formato	Silvia Tolosa

Introducción

Descripción del Proyecto

GM Portal de Clientes Almacenes Sistema Web es una aplicación web diseñada para ser utilizada por el personal de las empresas de logística.

Tecnologías y Librerías Utilizadas

Se presenta el listado de tecnologías y sus versiones.

• Frontend

  • NodeJS: v14.17.3
  • ReactJS: v17.0.1
  • React Router: v5.2.0
  • npm: v6.14.13
  • JavaScript

• Backend

  • Springboot
  • Maven

  Librerías destacadas

Material UI v4

Para componentes de vista.

Bootstrap

El proyecto se inició usando Bootstrap para los componentes de vista pero se fue migrando a Material UI, sin embargo, aún hay código de bootstrap.

Arquitectura del Proyecto

Navegación

La navegación dentro del proyecto se hace usando React Router. Se puede observar la configuración en el archivo App.js ubicado en la carpeta src en la raíz del proyecto.

Visualmente se accede a los procesos por medio de una barra lateral.

Configuración Inicial del Proyecto

Seguir los pasos descritos para configurar el proyecto en un ambiente de desarrollo (local):

1. Clonar el Repositorio:

git clone http://190.9.53.4:3000/GM-Transport/almacenes-portal.git

2. Descargar librerías: Ejecutar el comando

npm install

3. Ejecutar el Proyecto:

npm start

Esto abrirá la aplicación en http://localhost:3000.

Conexión con servicios

Rutas de servicios

El proyecto se divide en cuatro ramas principales: master y develop. La rama develop está conectada al ambiente de pruebas, mientras que la rama master a producción.

Las URLs de cada ambiente se encuentran en el archivo .env que se ubica en la raíz del proyecto.

• Ambiente de Pruebas:
  • Backend Última Milla Webdev (REACT_APP_API_URL):
    • http://190.9.53.4:9090
  • Backend Ultima Milla Spring Boot (REACT_APP_REPORT_URL):
    • http://190.9.53.4:8083/almacen
• Ambiente de Producción:
  • Backend Última Milla Webdev (REACT_APP_API_URL):
    • http://190.9.53.4:9090
  • Backend Última Milla Spring Boot (REACT_APP_REPORT_URL):
    • https://almacen.gmtransport.co/almacen

Es importante mencionar que la forma de identificar qué base de datos se va consultar es a través del RFC del cliente. Para esto se manda el RFC como header en todas las peticiones de backend.

El backend de WEBDEV es en su mayoría solo utilizado para tema de reportes. Ahí se almacenan los formatos de impresión y se consultan. El resto de flujos se hacen con el backend de Spring Boot.

Organización de Directorios

Frontend

La estructura de directorios del proyecto está organizada de la siguiente manera:

Proyecto

• scr: contiene los archivos del proyecto tal cual, componentes, paginas, etc.
  • Constants/index: contiene encabezados para peticiones http, plantillas para la impresión de etiquetas y otras configuraciones.
  • Files: directorio con los archivos usados para tutoriales.
  • iconos: directorio con las imágenes usadas en el sistema, desde logos, hasta iconos.
  • Util/Context: directorio con los archivos context que contienen las urls de los servicios.
  • Views: directorio que contiene todas los los archivos que corresponden a las vistas.
  • index.js: aplicación principal
  • routes.js: archivo que contiene las rutas de la barra lateral de navegación.
  • routesCatalogos.js: archivo que contiene las rutas de la sección de catálogos.
  • routesConfiguraciones.js: archivo que contiene las rutas de la sección a configuraciones.
• .env: archivo que contiene las url de los diferentes ambientes. Cambia dependiendo la rama en la que se encuentre.
• package.json: archivo que contiene las librerías necesarias para el proyecto.

Backend

La estructura de directorios del proyecto está organizada de la siguiente manera:

Proyecto

• src: Contiene los archivos del proyecto como:
  • main/java/com/certuit/base
    • config: directorio con los archivos de configuración para la ejecución del proyecto.
    • domain: directorio con las clases auxiliares empleados por los servicios rest para el mapeo de datos.
    • endpoint: directorio que contiene todos los servicios rest disponibles.
    • services/base: directorio con las clases y funciones que contienen la lógica y reglas de negocio.
    • util: directorio con la utilería y archivo de conexión a la base de datos.
    • CertuitBaseApplicaction.java: clase main la cual ejecuta el proyecto.
  • resources: Contiene los recursos del proyecto
    • application.yml: archivo de configuración principal del proyecto.

Procesos

Login (inicio de sesión)

Descripción general

Al cargar el url del portal de clientes se dirige a la ventana de inicio de sesión, en el cual el cliente o el proveedor del cliente puede iniciar sesión con el RFC, usuario y contraseña.
El inicio de sesión sirve para inicializar a vista principal y cargar los módulos correspondientes dependiendo el tipo de usuario que entraría.

Inicialización

Al iniciar la vista se verifica la sesión del usuario: si no hay una sesión iniciada, se muestra la pantalla del login.
Para iniciar sesión se requieren los siguientes datos:

• RFC: viene del ERP

• Correo electrónico: viene del ERP en la tabla CatClientes o CatProveedores.

• contraseña: viene del ERP en la tabla CatClientes o CatProveedores (en caso que se inicie sesión por primera vez un cliente, la contraseña sería el RFC del cliente)

  Una vez introducidos los datos necesarios se realiza una llamada al backend para iniciar la sesión y cargar los datos del cliente o proveedor.

• Inicio sesión

  • URL: /api/Clientes/ValidarLogin/admin@certuit.com/

Si la operación es exitosa se dirige al usuario al módulo de Citas si el usuario es proveedor y si es cliente se dirige al módulo de Almacén; Si hay algún error envía mensaje de error al usuario.

Citas (Proveedores)

Descripción general

En el menú lateral izquierdo, el módulo de Citas, se muestra el componente Citas.js donde se puede visualizar un listado de citas, agregar, exportar y cancelar.
La cita se utiliza para agendar una cita para embarcar productos y almacenar en los almacenes correspondientes.

Inicialización

Al iniciar la vista se verifica la sesión del usuario: si no hay una sesión iniciada, se redirige al login; si hay una sesión activa se hace una llamada al backend para obtener el listado de citas y sus respectivos filtros.

• Obtener sucursales
  • URL
    • /almacen/api/Sucursales/GetListado
• Obtener estatus cita
  • URL
    • /almacen/api/EstatusCita/GetListadoActivos
• Obtener listado proveedores por filtro y cliente
  • URL
    • /api/Citas/Proveedor/GetListadoByFiltrosByCliente/{idProveedor}/{idCliente}/{folio}/{fechaCita}/{idEstatus}/{idSucural}
• Obtener listado de productos activos por cliente
  • URL
    • /almacen/api/Productos/GetListadoActivoByIdCliente/{idCliente}
• Obtener listado embalajes
  • URL
    • /almacen/api/Embalajes/GetListado
• Obtener parámetros de configuración
  • URL
    • /almacen/api/ParametrosConfiguracion/GetParametros
• Obtener tipos de unidades
  • URL
    • /almacen/api/TiposUnidades/GetListado
• Obtener notificaciones
  • URL
    • /almacen/api/Notificaciones/{idUsuario}/{rfc}

Al obtener los listados se muestran en varios select para el filtro y en una tabla se muestra el listado de citas. La tabla tiene varias acciones que dependiendo del estatus de la guía se podrán realizar; entre ellos están consultar, modificar, reagendar cita entre otros.

Acciones del usuario

Agregar

Para agregar se debe presionar la pestaña Agregar ubicada en la parte superior. A continuación se explican los datos necesarios para crear una cita.

• Cliente: viene del ERP, por default sería el cliente del usuario.
• Folio Cita: se crea automáticamente en el servicio de agregar.
• Fecha y Hora Registro: se define por default desde el front.
• Proveedor: viene del ERP, por default sería el proveedor del usuario.
• Fecha Entrega de la Mercancía: lo elige el usuario.
• Hora de la Cita: lo elige el usuario.
• Orden de Compra: se introduce por el usuario.
• Remisión: se introduce por el usuario.
• Sucursal: viene del ERP, se elige por el usuario.
• Tipo de Unidad:
• Comentarios Generales: se introduce por el usuario.
• Mercancía: se elige por el usuario y viene de la base de datos.

Al presionar el botón Agregar Mercancía se abre una ventana donde se necesitan nuevos datos, pero esta vez del producto:

• Producto: se elige por el usuario y viene de la base de datos.
• Cantidad: se introduce por el usuario.
• Embalaje: se agrega automáticamente cuando se elige el producto.
• Peso Unitario: se agrega automáticamente cuando se elige el producto.
• Total Pallets:
• Temperatura Máxima: se agrega automáticamente cuando se elige el producto.
• Temperatura Mínima: se agrega automáticamente cuando se elige el producto.
• Observaciones: lo introduce el usuario (no es obligatorio).

Al darle agregar en el botón inferior de la ventana, se agrega a una tabla donde se enlistan los productos a entregar.

Finalmente al darle Guardar en el botón de la parte inferior se hace una llamada al backend para guardar la información.

• Agregar cita
  • URL:
    • /almacen/api/Citas/AgregarByCliente
  • Body:
    • Todos los parámetros explicados anteriormente.

Si la operación es exitosa se redirige al usuario al listado. Si surge algún error se muestra mensaje al usuario y se permanece en el formulario.

Consultar

Para consultar se debe presionar el icono de ojo ubicado en la columna Acciones de las Citas que se requiera, sin importar el estatus de la cita se puede consultar. Al entrar se carga la información de la cita el cual viene de una consulta del backend.

• Obtener cita
  • URL:
    • /almacen/api/Citas/GetById/{idCita}

Estando todos los campos bloqueados ya que es consultar, solo puede regresar al listado de citas con el botón cancelar.

Modificar

Para Modificar se debe presionar el icono de lápiz ubicado en la columna Acciones de las Citas que se requiera, tomando en cuenta que solo se puede modificar si el estatus de la cita no es Completado o Cancelado. Al entrar se carga la información de la cita el cual viene de una consulta del backend.

• Obtener cita
  • URL:
    • /almacen/api/Citas/GetById/{idCita}

A continuación se explican los datos necesarios para modificar los datos que se requieran de una cita.

• Cliente: viene del ERP, por default sería el cliente del usuario.
• Folio Cita: se crea automáticamente en el servicio de agregar.
• Fecha y Hora Registro: se define por default desde el front.
• Proveedor: viene del ERP, por default sería el proveedor del usuario.
• Fecha Entrega de la Mercancía: lo elige el usuario.
• Hora de la Cita: lo elige el usuario.
• Orden de Compra: se introduce por el usuario.
• Remisión: se introduce por el usuario.
• Sucursal: viene del ERP, se elige por el usuario.
• Tipo de Unidad: se elige por el usuario y viene de la base de datos.
• Comentarios Generales: se introduce por el usuario.
• Mercancía: se elige por el usuario y viene de la base de datos.

Al presionar el botón Agregar Mercancía o Editar se abre una ventana donde se necesitan nuevos datos, pero esta vez del producto:

• Producto: se elige por el usuario y viene de la base de datos.
• Cantidad: se introduce por el usuario.
• Embalaje: se agrega automáticamente cuando se elige el producto.
• Peso Unitario: se agrega automáticamente cuando se elige el producto.
• Total Pallets:
• Temperatura Máxima: se agrega automáticamente cuando se elige el producto.
• Temperatura Mínima: se agrega automáticamente cuando se elige el producto.
• Observaciones: lo introduce el usuario (no es obligatorio).

Al darle agregar en el botón inferior de la ventana, se agrega a una tabla donde se enlistan los productos a entregar.

Finalmente al darle Guardar en el botón de la parte inferior se hace una llamada al backend para guardar la información.

• Modificar cita
  • URL:
    • /almacen/api/Citas/Modificar/{idCita}
  • Body:
    • Todos los parámetros explicados anteriormente.

Si la operación es exitosa se redirige al usuario al listado. Si surge algún error se muestra mensaje al usuario y se permanece en el formulario.

Exportar

Para Exportar se debe presionar la pestaña exportar ubicada en la parte superior, lo cual hace que se descargue un archivo formato xml con el listado de las citas.

Cancelar

Para cancelar se debe presionar la pestaña Cancelar ubicada en la parte superior. Al entrar a la vista se carga la información de la cita, el cual viene de una consulta del backend.

• Obtener cita

  • URL:
    • /almacen/api/Citas/CancelarGetListado/

  En la vista se llenan automáticamente los campos requeridos para cancelar la cita. Se necesitan los siguientes datos para cancelar la cita:

• Cliente: se selecciona de CatClientesAM en la base de datos.

• Folio Cita: se obtiene de la consulta de la cita.

• Fecha de Registro: se obtiene de la fecha de hoy desde el frontend.

• Estatus: se obtiene de la consulta de la cita.

• Motivo: lo ingresa manualmente el usuario.

  Finalmente al darle Aceptar se hace una llamada al backend para guardar la información.

• Cancelar cita

  • URL:
    • /almacen/api/Cita/Cancelar/{idCita}

Si la operación es exitosa se redirige al usuario al listado. Si surge algún error se muestra mensaje al usuario y se permanece en el formulario.

Reagendar Cita

Para Reagendar Cita se debe presionar el icono de libro ubicado en la columna Acciones de las Citas que se requiera, tomando en cuenta que solo se puede reagendar cita si el estatus de la cita es Pendiente Confirmación. Al entrar se requieren los siguientes datos para reagendar:

• Fecha de la cita: se obtiene de la cita seleccionada.

• Hora de la cita: se obtiene de la cita seleccionada.

• Fecha nueva cita: se selecciona por el usuario.

• Hora nueva cita: se selecciona por el usuario.

  Finalmente al darle Guardar se hace una llamada al backend para guardar la información.

• Reagendar cita

  • URL:
    • /almacen/api/Citas/ReagendarCitaCliente/{idCita}

Si la operación es exitosa se redirige al usuario al listado. Si surge algún error se muestra mensaje al usuario y se permanece en el formulario.

Confirmar Cita

Para Reagendar Cita se debe presionar el icono de libro ubicado en la columna Acciones de las Citas que se requiera, tomando en cuenta que solo se puede confirmar la cita si el cliente confirmó la cita anteriormente (se utiliza una bandera). Al hacer clic se muestra un mensaje de advertencia y al confirmar se realiza una llamada al backend para confirmar la cita.

• Confirmar cita
  • URL:
    • /almacen/api/Citas/ConfirmarCitaCliente/{idCita}

Si la operación es exitosa se redirige al usuario al listado. Si surge algún error se muestra mensaje al usuario y se permanece en el formulario.

Citas (Clientes)

Descripción general

En el menú lateral izquierdo, el módulo de Citas, se muestra el componente Citas.js donde se puede visualizar un listado de citas, agregar, exportar y cancelar.
La cita se utiliza para agendar una cita para embarcar productos y almacenar en los almacenes correspondientes.

Inicialización

Al iniciar la vista se verifica la sesión del usuario: si no hay una sesión iniciada, se redirige al login; si hay una sesión activa se hace una llamada al backend para obtener el listado de citas y sus respectivos filtros.

• Obtener sucursales
  • URL
    • /almacen/api/Sucursales/GetListado
• Obtener proveedores
  • URL
    • /almacen/api/Proveedor/GetListadoActivosCliente/{idCliente}
• Obtener estatus cita
  • URL
    • /almacen/api/EstatusCita/GetListadoActivos
• Obtener listado proveedores por filtro y cliente
  • URL
    • /api/Citas/Proveedor/GetListadoByFiltrosByCliente/{idProveedor}/{idCliente}/{folio}/{fechaCita}/{idEstatus}/{idSucural}
• Obtener listado de productos activos por cliente
  • URL
    • /almacen/api/Productos/GetListadoActivoByIdCliente/{idCliente}
• Obtener listado embalajes
  • URL
    • /almacen/api/Embalajes/GetListado
• Obtener parámetros de configuración
  • URL
    • /almacen/api/ParametrosConfiguracion/GetParametros
• Obtener tipos de unidades
  • URL
    • /almacen/api/TiposUnidades/GetListado
• Obtener notificaciones
  • URL
    • /almacen/api/Notificaciones/{idUsuario}/{rfc}

Al obtener los listados se muestran en varios select para el filtro y en una tabla se muestra el listado de citas. La tabla tiene varias acciones que dependiendo del estatus de la guía se podrán realizar; entre ellos están consultar, modificar, reagendar cita entre otros.

Acciones del usuario

Agregar

Para agregar se debe presionar la pestaña Agregar ubicada en la parte superior. A continuación se explican los datos necesarios para crear una cita.

• Cliente: viene del ERP, por default sería el cliente del usuario.
• Folio Cita: se crea automáticamente en el servicio de agregar.
• Fecha y Hora Registro: se define por default desde el front.
• Proveedor: viene del ERP, se elige por el cliente.
• Orden de Compra: se introduce por el usuario.
• Remisión: se introduce por el usuario.
• Sucursal: viene del ERP, se elige por el usuario.
• Tipo de Unidad: se elige por el usuario y viene de la base de datos.
• Comentarios Generales: se introduce por el usuario.
• Mercancía: se elige por el usuario y viene de la base de datos.

Al presionar el botón Agregar Mercancía se abre una ventana donde se necesitan nuevos datos, pero esta vez del producto:

• Producto: se elige por el usuario y viene de la base de datos.
• Cantidad: se introduce por el usuario.
• Embalaje: se agrega automáticamente cuando se elige el producto.
• Peso Unitario: se agrega automáticamente cuando se elige el producto.
• Total Pallets:
• Temperatura Máxima: se agrega automáticamente cuando se elige el producto.
• Temperatura Mínima: se agrega automáticamente cuando se elige el producto.
• Observaciones: lo introduce el usuario (no es obligatorio).

Al darle agregar en el botón inferior de la ventana, se agrega a una tabla donde se enlistan los productos a entregar.

Finalmente al darle Guardar en el botón de la parte inferior se hace una llamada al backend para guardar la información.

• Agregar cita
  • URL:
    • /almacen/api/Citas/AgregarByCliente
  • Body:
    • Todos los parámetros explicados anteriormente.

Si la operación es exitosa se redirige al usuario al listado. Si surge algún error se muestra mensaje al usuario y se permanece en el formulario.

Consultar

Para consultar se debe presionar el icono de ojo ubicado en la columna Acciones de las Citas que se requiera, sin importar el estatus de la cita se puede consultar. Al entrar se carga la información de la cita el cual viene de una consulta del backend.

• Obtener cita
  • URL:
    • /almacen/api/Citas/GetById/{idCita}

Estando todos los campos bloqueados ya que es consultar, solo puede regresar al listado de citas con el botón cancelar.

Modificar

Para Modificar se debe presionar el icono de lápiz ubicado en la columna Acciones de las Citas que se requiera, tomando en cuenta que solo se puede modificar si el estatus de la cita no es Completado o Cancelado. Al entrar se carga la información de la cita el cual viene de una consulta del backend.

• Obtener cita
  • URL:
    • /almacen/api/Citas/GetById/{idCita}

A continuación se explican los datos necesarios para modificar los datos que se requieran de una cita.

• Cliente: viene del ERP, por default sería el cliente del usuario.
• Folio Cita: se crea automáticamente en el servicio de agregar.
• Fecha y Hora Registro: se define por default desde el front.
• Proveedor: viene del ERP, se elige por el usuario.
• Orden de Compra: se introduce por el usuario.
• Remisión: se introduce por el usuario.
• Sucursal: viene del ERP, se elige por el usuario.
• Tipo de Unidad:
• Comentarios Generales: se introduce por el usuario.
• Mercancía: se elige por el usuario y viene de la base de datos.

Al presionar el botón Agregar Mercancía o Editar se abre una ventana donde se necesitan nuevos datos, pero esta vez del producto:

• Producto: se elige por el usuario y viene de la base de datos.
• Cantidad: se introduce por el usuario.
• Embalaje: se agrega automáticamente cuando se elige el producto.
• Peso Unitario: se agrega automáticamente cuando se elige el producto.
• Total Pallets:
• Temperatura Máxima: se agrega automáticamente cuando se elige el producto.
• Temperatura Mínima: se agrega automáticamente cuando se elige el producto.
• Observaciones: lo introduce el usuario (no es obligatorio).

Al darle agregar en el botón inferior de la ventana, se agrega a una tabla donde se enlistan los productos a entregar.

Finalmente al darle Guardar en el botón de la parte inferior se hace una llamada al backend para guardar la información.

• Modificar cita
  • URL:
    • /almacen/api/Citas/Modificar/{idCita}
  • Body:
    • Todos los parámetros explicados anteriormente.

Si la operación es exitosa se redirige al usuario al listado. Si surge algún error se muestra mensaje al usuario y se permanece en el formulario.

Exportar

Para Exportar se debe presionar la pestaña exportar ubicada en la parte superior, lo cual hace que se descargue un archivo formato xml con el listado de las citas.

Cancelar

Para cancelar se debe presionar la pestaña Cancelar ubicada en la parte superior. Al entrar a la vista se carga la información de la cita, el cual viene de una consulta del backend.

• Obtener cita

  • URL:
    • /almacen/api/Citas/CancelarGetListado/

  En la vista se llenan automáticamente los campos requeridos para cancelar la cita. Se necesitan los siguientes datos para cancelar la cita:

• Cliente: se selecciona de CatClientesAM en la base de datos.

• Folio Cita: se obtiene de la consulta de la cita.

• Fecha de Registro: se obtiene de la fecha de hoy desde el frontend.

• Estatus: se obtiene de la consulta de la cita.

• Motivo: lo ingresa manualmente el usuario.

  Finalmente al darle Aceptar se hace una llamada al backend para guardar la información.

• Cancelar cita

  • URL:
    • /almacen/api/Cita/Cancelar/{idCita}

Si la operación es exitosa se redirige al usuario al listado. Si surge algún error se muestra mensaje al usuario y se permanece en el formulario.

Reagendar Cita

Para Reagendar Cita se debe presionar el icono de libro ubicado en la columna Acciones de las Citas que se requiera, tomando en cuenta que solo se puede reagendar cita si el estatus de la cita es Pendiente Confirmación. Al entrar se requieren los siguientes datos para reagendar:

• Fecha de la cita: se obtiene de la cita seleccionada.

• Hora de la cita: se obtiene de la cita seleccionada.

• Fecha nueva cita: se selecciona por el usuario.

• Hora nueva cita: se selecciona por el usuario.

  Finalmente al darle Guardar se hace una llamada al backend para guardar la información.

• Reagendar cita

  • URL:
    • /almacen/api/Citas/ReagendarCitaCliente/{idCita}

Si la operación es exitosa se redirige al usuario al listado. Si surge algún error se muestra mensaje al usuario y se permanece en el formulario.

Almacén (Clientes)

Descripción general

En el menú lateral izquierdo, el módulo de Almacén, se muestra el componente Inventario.js donde se puede visualizar los productos en los almacenes del cliente, además de exportar la información.

Inicialización

Al iniciar la vista se verifica la sesión del usuario: si no hay una sesión iniciada, se redirige al login; si hay una sesión activa se hace una llamada al backend para obtener los listado de productos de los almacenes y su respectivo filtro.

• Obtener inventario filtro
  • URL:
    • /almacen/api/Intentario/GetByFiltros/{idCliente}/{idSucursal}/{idZona}/{idEstatus}/{fechaInicial}/{fechaFinal}/{lote}
• Obtener clientes
  • URL:
    • /almacen/api/Clientes/GetPasswordById/{idCliente}
• Obtener inventario
  • URL:
    • /almacen/api/Inventario/Exportar/{idCliente}
• Obtener estatus espacios activos
  • URL:
    • /almacen/api/EstatusEspacios/GetEstatusEspaciosActivos
• Obtener sucursales
  • URL:
    • /almacen/api/Sucursales/GetListado
• Obtener almacenes
  • URL:
    • /almacen/api/Almacenes/GetListado
• Obtener productos
  • URL:
    • /almacen/api/Productos/GetListado

Al obtener los listados se muestran en varios select para el filtro y en varias tablas se muestran los productos por almacén.

Acciones del usuario

Exportar

Para Exportar se debe presionar la pestaña exportar ubicada en la parte superior, lo cual hace que se descargue un archivo formato xml con los datos del inventario.

Embarques (Clientes)

Descripción general

En el menú lateral izquierdo, el módulo de Embarque, se muestra el componente Embarque.js donde se puede visualizar el listado de embarques del cliente.
El Embarque es cuando se requiere la entrega de productos del Almacén a algún destinatario.

Inicialización

Al iniciar la vista se verifica la sesión del usuario: si no hay una sesión iniciada, se redirige al login; si hay una sesión activa se hace una llamada al backend para obtener los listados de Embarques y su respectivo filtro.

• Obtener inventario filtro
  • URL:
    • /almacen/api/Embarque/GetListadoEmbarqueClienteByFiltros/{folioEmbarque}/{fechaEmbarque}/{fechaInicial}/{fechaFinal}/{sucursal}/{estatus}/{destinatario}
• Obtener estatus embarques
  • URL:
    • /almacen/api/EstatusEmbarque/GetEstatusEmbarqueSinPendiente
• Obtener remitentes
  • URL:
    • /almacen/api/Remitentes/GetListado
• Obtener parámetros configuración
  • URL:
    • /almacen/api/ParametrosConfiguracion/GetParametros
• Obtener sucursales
  • URL:
    • /almacen/api/Sucursales/GetListado

Al obtener los listados se muestran en varios select para el filtro y en una tabla los embarques.

Acciones del usuario

Agregar

Para agregar se debe presionar la pestaña Agregar ubicada en la parte superior. Al entrar a la vista se realiza una llamada al backend para obtener los listados de tipos de unidades y sucursales.

• Obtener sucursales
  • URL:
    • /almacen/api/Sucursales/GetListado
• Obtener tipos de unidades
  • URL:
    • /almacen/api/TiposUnidades/GetListado

A continuación se explican los datos necesarios para crear un Embarque.

• Cliente: viene del ERP, por default sería el cliente del usuario.
• Folio Embarque: se crea automáticamente en el servicio de agregar.
• Fecha y Hora Registro: se define por default desde el front.
• Fecha Embarque: se elige por el usuario.
• Hora Embarque: se elige por el usuario.
• Sucursal: viene del ERP, se elige por el usuario.
• Tipo de Unidad: se elige por el usuario y viene de la base de datos.
• Comentarios Generales: se introduce por el usuario.
• Productos: se elige por el usuario y viene de la base de datos.

Al presionar el botón Agregar Producto se abre una ventana donde se realiza una llamada al backend para traer un listado de productos.

• Obtener productos
  • URL:
    • /almacen/api/EspaciosProducto/ProductosCliente/{idCliente}/{idSucursal}

Enseguida se necesitan nuevos datos para agregar el producto:

• Producto: se elige por el usuario y viene de la base de datos.
• Cantidad: se introduce por el usuario.
• Embalaje: se agrega automáticamente cuando se elige el producto.
• Peso Unitario: se agrega automáticamente cuando se elige el producto.
• Temperatura Máxima: se agrega automáticamente cuando se elige el producto.
• Temperatura Mínima: se agrega automáticamente cuando se elige el producto.
• Observaciones: lo introduce el usuario (no es obligatorio).

Al darle agregar en el botón inferior de la ventana, se agrega a una tabla donde se enlistan los productos a entregar.

Al terminar de seleccionar los productos se debe seleccionar un destinatario y automáticamente se llena la información del destinatario requerida.

• Destinatario
• RFC
• Estado
• Municipio
• Código Postal
• Domicilio
• Calle
• Número Exterior
• Número Interior
• Teléfono
• Correo electrónico

Finalmente al darle Guardar en el botón de la parte inferior se hace una llamada al backend para guardar la información.

• Agregar embarque
  • URL:
    • /almacen/api/Embarque/AgregarByCliente
  • Body:
    • Todos los parámetros explicados anteriormente.

Si la operación es exitosa se redirige al usuario al listado. Si surge algún error se muestra mensaje al usuario y se permanece en el formulario.

Consultar

Para consultar se debe presionar el icono de ojo ubicado en la columna Acciones de los Embarques que se requiera. Al entrar se carga la información del embarque el cual viene de una consulta del backend.

• Obtener embarque
  • URL:
    • /almacen/api/Embarque/GetById/{idEmbarque}

Estando todos los campos bloqueados ya que es consultar, solo puede regresar al listado de embarques con el botón cancelar.

Modificar

Para Modificar se debe presionar el icono de lápiz ubicado en la columna Acciones de los Embarques que se requiera. Al entrar se carga la información del embarque y algunos listados los cuales vienen de una consulta del backend.

• Obtener embarque
  • URL:
    • /almacen/api/Embarque/GetById/{idEmbarque}
• Obtener sucursales
  • URL:
    • /almacen/api/Sucursales/GetListado
• Obtener tipos de unidades
  • URL:
    • /almacen/api/TiposUnidades/GetListado
• Obtener remitentes
  • URL:
    • /almacen/api/Remitentes/GetListado

A continuación se explican los datos necesarios para modificar los datos que se requieran de un embarque.

• Cliente: viene del ERP, por default sería el cliente del usuario.
• Folio Embarque: se crea automáticamente en el servicio de agregar.
• Fecha y Hora Registro: se define por default desde el front.
• Fecha Embarque: se elige por el usuario.
• Hora Embarque: se elige por el usuario.
• Sucursal: viene del ERP, se elige por el usuario.
• Tipo de Unidad: se elige por el usuario y viene de la base de datos.
• Comentarios Generales: se introduce por el usuario.
• Productos: se elige por el usuario y viene de la base de datos.

Al presionar el botón Agregar Producto se abre una ventana donde se realiza una llamada al backend para traer un listado de productos.

• Obtener productos
  • URL:
    • /almacen/api/EspaciosProducto/ProductosCliente/{idCliente}/{idSucursal}

Enseguida se necesitan nuevos datos para agregar el producto:

• Producto: se elige por el usuario y viene de la base de datos.
• Cantidad: se introduce por el usuario.
• Embalaje: se agrega automáticamente cuando se elige el producto.
• Peso Unitario: se agrega automáticamente cuando se elige el producto.
• Temperatura Máxima: se agrega automáticamente cuando se elige el producto.
• Temperatura Mínima: se agrega automáticamente cuando se elige el producto.
• Observaciones: lo introduce el usuario (no es obligatorio).

Al darle agregar en el botón inferior de la ventana, se agrega a una tabla donde se enlistan los productos a entregar.

Al terminar de seleccionar los productos se debe seleccionar un destinatario y automáticamente se llena la información del destinatario requerida.

• Destinatario
• RFC
• Estado
• Municipio
• Código Postal
• Domicilio
• Calle
• Número Exterior
• Número Interior
• Teléfono
• Correo electrónico

Finalmente al darle Aceptar en el botón de la parte inferior se hace una llamada al backend para guardar la información.

• Modificar embarque
  • URL:
    • /almacen/api/Embarque/Modificar/{idEmbarque}
  • Body:
    • Todos los parámetros explicados anteriormente.

Si la operación es exitosa se redirige al usuario al listado. Si surge algún error se muestra mensaje al usuario y se permanece en el formulario.

Exportar

Para Exportar se debe presionar la pestaña exportar ubicada en la parte superior, lo cual hace que se descargue un archivo formato xml con el listado de los embarques.

Cancelar

Para cancelar se debe presionar la pestaña Cancelar ubicada en la parte superior. Al entrar a la vista se carga la información del embarque, el cual viene de una consulta del backend.

• Obtener embarque

  • URL:
    • almacen/api/Embarque/GetById/{idEmbarque}

  En la vista se llenan automáticamente los campos requeridos para cancelar la cita. Se necesitan los siguientes datos para cancelar la cita:

• Cliente: se selecciona de CatClientesAM en la base de datos.

• Folio Embarque: se obtiene de la consulta de la cita.

• Fecha de Registro: se obtiene de la fecha de hoy desde el frontend.

• Usuario: se elige al usuario que inició la sesión, por default.

• Estatus: se obtiene de la consulta de la cita.

• Motivo: lo ingresa manualmente el usuario.

  Finalmente al darle Aceptar se hace una llamada al backend para guardar la información.

• Cancelar embarque

  • URL:
    • /api/Embarque/Cancelar/{idEmbarque}

Si la operación es exitosa se redirige al usuario al listado. Si surge algún error se muestra mensaje al usuario y se permanece en el formulario.