Especificación del Propósito del Sistema

Proyecto: classABM php

Versión: 1.0.0

Seminario de Integración Profesional

Profesor: Christian López Pasarón
Alumno: Iván Kevin Berlot
2021 Ing. en Informática Plan 11
 Especificaciones del Software
classABM php Versión: 1.0.0

Historial de Revisiones
Versión Fecha Autor Descripción
1.0.0 06/04/2021 Ivan Kevin Berlot Creación del documento y carga del propósito y alcance
del sistema.

Identificador del documento: SIP 2021 – Proyecto 17 – BERLOT Iván Kevin

 Especificaciones del Software
classABM php Versión: 1.0.0

Índice de Contenido

Introducción 4
Alcance 4
Definiciones, Acrónimos y Abreviaturas 4

Requerimientos Funcionales 5

Requerimientos No Funcionales 7
Usabilidad 7
Confiabilidad 7
Seguridad 7
Eficiencia 7
Mantenimiento y Actualización 7
Soportabilidad y Operabilidad 7
Restricción de Diseño 7
Requerimientos de Documentación en Línea y de Sistemas de Ayuda 8
Interfaces 8
Interfaces de Usuario 8
Interfaces de Software 8
Interfaces de Hardware 8
Interfaces de Comunicaciones 8
Aspectos Legales 8
Políticas de la Organización 8
Contratos con Otras Organizaciones 8
Propiedad Intelectual 9
Estándares Aplicables 9

Casos de Uso 9
Actores 9
Resumen 10
Diagrama 10
Especificaciones de Casos de Uso 11

Documentos relacionados 13

Especificaciones del Software

Identificador del documento: SIP 2021 – Proyecto 17 – BERLOT Iván Kevin

 Especificaciones del Software
classABM php Versión: 1.0.0

1 Introducción

1.1 Alcance
classABM es un Framework escrito en php que tiene como objetivo proporcionar las herramientas
para la creación rápida y sencilla de listados con ventanas de alta, baja y modificación.
Cuenta con un conjunto de funcionalidades para trabajar de forma nativa con datos de los tipos:
bit, combo, dbCombo, moneda, número, password, rownum, textarea, texto, upload y fecha. Estas
funcionalidades incluyen, entre otras, opciones de formateo y controles de seguridad.
El framework tiene incluidas las funcionalidades de paginación, ordenamiento y búsqueda. Todas
ellas configurables y con opciones de personalización. La paginación se realiza a nivel consulta a la
base, trayendo únicamente los registros a mostrar con el fin de manejar microtransacciones en vez
de grandes volúmenes de datos.
A nivel base de datos se provee de forma nativa y transparente conexión con los motores
MySQL, SQLServer, Oracle y PostgreSQL, incorporando la generación de consultas parametrizadas
y con JOINs a las subtablas para la obtención de un performance superior.

1.2 Definiciones, Acrónimos y Abreviaturas

● ABM: abr. lit. Alta Baja Modificación.
● Framework: Un entorno de trabajo​ (del inglés framework), o marco de trabajo​ es un
conjunto estandarizado de conceptos, prácticas y criterios para enfocar un tipo de
problemática particular que sirve como referencia, para enfrentar y resolver nuevos
problemas de índole similar.
● JOINs: La sentencia JOIN (unir, combinar) de SQL permite combinar registros de una o más
tablas en una base de datos.
● Upload: (Cargar o Subir) Es el proceso por el que copiamos un archivo de nuestro
ordenador a un servidor o sistema, para poder transmitirlo por la Red o colgarlo en una
página Web. Lo contrario, el bajarse un archivo de la Red a nuestro ordenador, se llama
-download- o descarga.
● Bit: Tipo de dato que permite únicamente dos valores.
● Rownum: Número de línea.
● Password: Contraseña, tipo de campo que permanece bloqueado al escribirse para que no
pueda ser visto.
● Combo: Tipo de campo que permite la selección de una opción desde un listado.
● Paginación: Capacidad de dividir en páginas.

Identificador del documento: SIP 2021 – Proyecto 17 – BERLOT Iván Kevin

 Especificaciones del Software
classABM php Versión: 1.0.0

2 Requerimientos Funcionales

Se presentan a continuación los requerimientos funcionales de prioridad alta y alto nivel, en un

documento aparte se registran el total de los requerimientos funcionales.

Nombre del Requerimiento: Pantalla de listado

Identificación del requerimiento: RE-ABM-001
Debe mostrar un listado de los datos actuales con las opciones de Alta Baja Modificación y búsqueda.
Requerimiento relacionado: -
La prioridad es: Alta

Nombre del Requerimiento: Pantalla de alta

Identificación del requerimiento: RE-ABM-002
Ventana modal que permite la carga de todos aquellos parámetros requeridos para el alta de un
elemento.
Requerimiento relacionado: -
La prioridad es: Alta

Nombre del Requerimiento: Pantalla de modificación

Identificación del requerimiento: RE-ABM-003
Ventana modal que permite la modificación de los datos de un elemento.
Requerimiento relacionado: -
La prioridad es: Alta

Nombre del Requerimiento: Confirmación de baja

Identificación del requerimiento: RE-ABM-004
Debe mostrar Un mensaje de confirmación para la eliminación de elementos de la Base
Requerimiento relacionado: -
La prioridad es: Alta

Nombre del Requerimiento: Posibilidad de ordenar listados

Identificación del requerimiento: RE-ABM-021
Se debe poder ordenar el listado. Seleccionando los campos por los que se puede ordenar.
Requerimiento relacionado: RE-ABM-001
La prioridad es: Alta

Identificador del documento: SIP 2021 – Proyecto 17 – BERLOT Iván Kevin

 Especificaciones del Software
classABM php Versión: 1.0.0

Nombre del Requerimiento: Posibilidad de Paginar

Identificación del requerimiento: RE-ABM-022
Se debe poder paginar el listado seleccionando la cantidad de items a mostrar por página.
Requerimiento relacionado: RE-ABM-001
La prioridad es: Alta

Nombre del Requerimiento: Utilización de Ventanas Modal

Identificación del requerimiento: RE-ABM-028
Las ventanas fuera del listado (Alta y modificación) deben ser por ventanas modal y no por redirección.
Requerimiento relacionado: -
La prioridad es: Alta

Nombre del Requerimiento: Utilización de una clase Singleton para el acceso

Identificación del requerimiento: RE-ABM-029
La clase de conexión a la base debe instanciarse una sola vez de forma que se optimicen los accesos
y consumo de recursos.
Requerimiento relacionado: -
La prioridad es: Alta

Nombre del Requerimiento: Utilización de verificaciones de datos en cliente

Identificación del requerimiento: RE-ABM-030
El sistema debe generar los scripts de verificación de datos en el cliente de forma automática y realizar
la comprobación en el servidor al momento de hacer los insert y los updates.
Requerimiento relacionado: -
La prioridad es: Alta

Identificador del documento: SIP 2021 – Proyecto 17 – BERLOT Iván Kevin

 Especificaciones del Software
classABM php Versión: 1.0.0

3 Requerimientos No Funcionales

3.1 Usabilidad
El tiempo de aprendizaje de las características básicas del sistema por parte del usuario no
deberá superar el de las 4 horas.
Dicho sistema contará con manuales de usuario con el fin de facilitar su comprensión y uso.
El sistema proporcionará mensajes de error que sean informativos al usuario.

3.2 Confiabilidad
El sistema estará disponible los 7 días, las 24 hs. El sistema será tolerante ante los fallos y las
operaciones a realizar deberán ser transaccionales.

3.3 Seguridad
Los permisos de acceso al sistema se clasifican en dos grupos, de acceso web o de desarrollo.
De manera estándar los usuarios con acceso web tienen todos los mismos permisos y la
estratificación de los mismos debe trabajarse por fuera de lo que comprende este framework.
Los usuarios desarrolladores deben manejar su acceso por medio de la configuración del sistema
operativo del servidor.

3.4 Eficiencia
El sistema implementa las conexiones a la base de datos por medio de un patrón singleton que
maximiza la eficiencia minimizando el consumo de recursos realizando llamadas a una misma
instancia de la conexión a la base.
Las consultas generadas de forma automática se encuentran parametrizadas, permitiendo la
reutilización de las cargas en memoria logrando un mejor rendimiento a la hora de realizar múltiples
accesos/procesos.

3.5 Mantenimiento y Actualización

El sistema podrá recibir modificaciones/actualizaciones para solucionar posibles errores que se
presenten.
Dichas actualizaciones se realizarán por medio del gestor de versiones Git permitiendo la
implementación por parte del cliente en el momento que las requiera.

3.6 Soportabilidad y Operabilidad

La aplicación cuenta con un manual de ayuda para que el usuario pueda manejar de la mejor
manera el sistema.

3.7 Restricción de Diseño

El sistema está desarrollado para ser utilizado exclusivamente sobre plataformas Web.
La instalación de la aplicación no ocupará más de 200Mb de espacio en disco.

Identificador del documento: SIP 2021 – Proyecto 17 – BERLOT Iván Kevin

 Especificaciones del Software
classABM php Versión: 1.0.0

Los lenguajes utilizados para el desarrollo del sistema son PHP en su versión 7, SQL para la
creación de consultas y JavaScript para algunas de las funcionalidades.

3.8 Requerimientos de Documentación en Línea y de Sistemas de Ayuda

El sistema tendrá un manual en línea de ayuda el cual servirá para que los usuarios lo lean cada
vez que tengan un problema y lo puedan solucionar.

3.9 Interfaces
En este apartado se definen las interfaces que debe apoyar la aplicación, como son: las
interfaces de usuario, interfaces de software, etc.
En caso de que aplique es conveniente hacer referencia a estándares de la aplicación o
corporativos.

3.9.1 Interfaces de Usuario

El sistema utiliza plantillas de estilos en cascada (archivos css) para simplificar la personalización
de la interfaz de usuario. Además de esto el sistema utilizara ventanas modal y procesos ajax.

3.9.2 Interfaces de Software

Apache
PHP 7.0 o superior
Bases de datos (MySQL, SQLServer, Oracle o PostgreSQL)

3.9.3 Interfaces de Hardware

No tiene interfaces de hardware pertinentes.

3.9.4 Interfaces de Comunicaciones

No tiene Interfaces de Comunicaciones pertinentes.

3.10 Aspectos Legales

3.10.1 Políticas de la Organización

El sistema satisface las políticas de seguridad ya que utiliza logaritmos de encriptación de datos.
El sistema utiliza licencias GPL por lo que satisface las políticas legales.

3.10.2 Contratos con Otras Organizaciones

El sistema utiliza los siguientes softwares/plugins adicionales:
jQuery - ;
CKEditor - Plugin para el formateo de texto.

Identificador del documento: SIP 2021 – Proyecto 17 – BERLOT Iván Kevin

 Especificaciones del Software
classABM php Versión: 1.0.0

3.10.3 Propiedad Intelectual

Componente Dueño Licencia Estado Comentarios

Class ABM PHP Pandora-inc GPL En conformidad
Base de datos Distribuidor Depende del motor elegido.
Apache Software
Apache Licencia Apache 2.0 En conformidad
Foundation
php7 PHP Group Licencia PHP En conformidad
Frederico Caldeira GNU GPL, GNU
CKEditor En conformidad
Knabben LGPL y MPL

3.11 Estándares Aplicables

El sistema tiene certificación ISO 9001.
El sistema utiliza el formato de codificación de caracteres UTF – 8 según la ISO 10646.

4 Casos de Uso

4.1 Actores

Actor Descripción
Desarrollador Implementa el Framework para la generación de ABM.
Es aquel que tiene conocimiento sobre el modelo de datos. y que
va a utilizar el framework a nivel código.
Administrador Va a ser quien tiene habilitadas las funciones de alta, baja y
modificación en la pantalla de listado.
En todas las funciones de usabilidad será el dueño del sistema.
Usuario Es quien tiene acceso únicamente a la vista del listado y las
opciones de buscar datos y descarga de archivos exportados.

Identificador del documento: SIP 2021 – Proyecto 17 – BERLOT Iván Kevin

 Especificaciones del Software
classABM php
4.12 Resumen
Nombre
Configuración DB
Creación de ABM
Inicialización de campo
Definición de Búsqueda
Definición de Paginado
Configuración Exportación
Campos tipo bit
Campos tipo combo
Campos tipo dbcombo
Campos tipo moneda
Campos tipo número
Campos tipo password
Campos tipo rownum
Campos tipo textarea
Campos tipo texto
Campos tipo upload
Campos tipo fecha
Baja registros
Alta registros
Modificación registros
Consulta de datos
Identificador del documento:
Versión: 1.0.0
Caso de Uso
El desarrollador puede configurar la conexión a la DB.
El desarrollador inicializa el ABM.
Se inicializan los campos del ABM.
Se define como será el campo de búsqueda del ABM.
Se establece el paginado del ABM.
Se configura los parámetros requeridos para poder exportar el listado.
El desarrollador puede declarar y configurar campos del tipo bit.
El desarrollador puede declarar y configurar campos del tipo combo.
El desarrollador puede declarar y configurar campos del tipo dbcombo.
El desarrollador puede declarar y configurar campos del tipo moneda.
El desarrollador puede declarar y configurar campos del tipo número.
El desarrollador puede declarar y configurar campos del tipo password.
El desarrollador puede declarar y configurar campos del tipo rownum.
El desarrollador puede declarar y configurar campos del tipo textarea.
El desarrollador puede declarar y configurar campos del tipo texto.
El desarrollador puede declarar y configurar campos del tipo upload.
El desarrollador puede declarar y configurar campos del tipo fecha.
El Administrador puede dar de baja registros por medio del ABM.
El Administrador puede dar de alta registros por medio del ABM.
El Administrador puede modificar registros por medio del ABM.
El Usuario y el Administrador pueden consultar el listado de datos.
SIP 2021 – Proyecto 17 – BERLOT Iván Kevin
 Especificaciones del Software
classABM php Versión: 1.0.0

4.3 Diagrama

Identificador del documento: SIP 2021 – Proyecto 17 – BERLOT Iván Kevin

 Especificaciones del Software
classABM php Versión: 1.0.0

4.4 Especificaciones de Casos de Uso

Referirse al documento anexo de Casos de Uso.

5 Documentos relacionados

Título Fecha Organización Identificador del documento

Requerimientos Auxiliares del Sistema 28/04/2021 Pandora-inc SIP_2021-Proyecto_17-EdR-Berlot_Ivan_k.pdf

Especificaciones de Casos de Uso 28/04/2021 Pandora-inc SIP_2021-Proyecto_17-CU-Berlot_Ivan_k.pdf

Identificador del documento: SIP 2021 – Proyecto 17 – BERLOT Iván Kevin