Вы находитесь на странице: 1из 11

Ministerio de Relaciones Exteriores y Culto

Sistema de Portal WEB

Technical Manual for the System Operator on Alert

Description and content of the Technical Manual

The Technical Manual of the System must be structured and include


contents according to the technical manual standard described in this
document:

Tabla de Contenido
2. ALCANCE....................................................................................................................................................2
3. DOCUMENTOS DE REFERENCIA...........................................................................................................2
4. DEFINICIONES IMPORTANTES..............................................................................................................3
4.1 CONCEPTOS GENERALES...................................................................................................................3
4.2 PROCESOS DE ENTRADA Y SALIDA...................................................................................................3
5. DESCRIPCIÓN DE MÓDULOS.................................................................................................................3
6. DICCIONARIO DE DATOS........................................................................................................................4
6.1 MODELO ENTIDAD-RELACIÓN..........................................................................................................4
6.2 DISTRIBUCIÓN FÍSICA Y LÓGICA DE BASE DE DATOS.....................................................5
6.3 RESTRICCIONES ESPECIALES.................................................................................................5
6.4 TAREAS PROGRAMADAS...........................................................................................................5
6.5 DATA TRANSFORMATION SERVICES (BASES DE DATOS SQL SERVER)..........................................6
7. POLÍTICAS DE RESPALDO......................................................................................................................6
7.1 ARCHIVOS...................................................................................................................................6
7.2 BASE DE DATOS.........................................................................................................................6
8. DESCRIPCIÓN DE INTERFACES CON OTROS SISTEMAS.................................................................6
9. INSTALACIÓN Y CONFIGURACIÓN......................................................................................................7
9.1 REQUISITOS GENERALES PRE-INSTALACIÓN....................................................................................7
9.2 DETALLES DEL PROCESO DE INSTALACIÓN......................................................................................8
9.3 DETALLES DE CONFIGURACIÓN DE LA APLICACIÓN.....................................................................10
a. Variables de ambiente......................................................................................................................10
b. Parámetros de aplicaciones............................................................................................................10
c. Archivos de configuración.........................................................................................................10
d. Archivos de bitácora...................................................................................................................10
e. Tareas programadas...................................................................................................................10
F. LISTA DE CONTACTOS TÉCNICOS....................................................................................................10
10. PROCESOS DE CONTINUIDAD Y CONTINGENCIA MÍO...............................................................10
11. DESCRIPCIÓN DE USUARIOS.............................................................................................................11
11.1 USUARIOS DE BASE DE DATOS....................................................................................................11
11.2 USUARIOS DE SISTEMA OPERATIVO...........................................................................................11
11.3 Usuarios de aplicaciones...........................................................................................................11

1
Ministerio de Relaciones Exteriores y Culto
Sistema de Portal WEB

1. Purpose

The main objective of this manual is to show the client a technical conception of
Operator on Alert, as well as to show the technical structure of the mobile
application, how was the progress of the development of the same and what is
the physical structure of the application.
2. Scope

This document is not taught to teach the client to use the application, and will be
directed to the Senda client, must have basic knowledge about what is (a
database, application operation etc.).

3. Documentos de referencia
It does not demand them

2
Ministerio de Relaciones Exteriores y Culto
Sistema de Portal WEB

4. Important definitions

4.1 General concepts


 Interface: It is based on the design of the application, as it is structured by
buttons, menus, images, map, or options, and what were the colors used,
as well as the font size and type.
 Development: the programming of the application and what kind of
software was used for the coding.
 Coding: the code used for the application, one of the important bases.
 Software: the use of visual studio 2017, Android studio, Atom, Postman,
Xampp and phpMyAdmin.
 Visual studio 2017: used for the creation of the web application
 Android studio: Utilizado para la creación de la aplicación móvil.
 Atom: Used for the creation of the mobile application.
 Postman: link server coding with this platform to start the server test.
 Xampp: starting this platform serves to make a connection to the
phpMyAdmin server.
 phpMyAdmin: server to perform the database.
 Base de datos: tables to insert the records that are inserted from the
software, an example, the record, the data once sent, these are inserted to
the corresponding table in the database, in this case a record in the
operator or administrator table.

4.2 Input and output processes


 Inicio de sesión: The user must enter only two data so he can enter the
mobile application.
 Chat: through this functionality the user can contact the administrator of
the mobile application.
 Estado del operador: Through this functionality the user can notify the
administrator if it is available or not, or if it is stranded somewhere.

5. Description of modules
Name of the module: Login
Functionality / Purpose: It will initiate session in the application, entering the
corresponding data. The purpose is to enter the mobile application.
Functional dependence: Registration in the web application.

Name of the module: Chat.

3
Ministerio de Relaciones Exteriores y Culto
Sistema de Portal WEB

Functionality / Purpose: Have access to the chat, where he will talk among
employees. The purpose is that you can have the chat correctly.
Functional dependence: Chat del administrador.

Name of the module: Estado del operador.


Functionality / Purpose: Selection of one of the options presented, in addition
to being able to view the map through the GPS of the mobile. The purpose is to
indicate what the state is (available, unavailable or stranded).
Functional dependence: Reporte en la web.
6. Data Dictionary
6.1 Modelo entidad-relación

6.2 Physical distribution and database logic

4
Ministerio de Relaciones Exteriores y Culto
Sistema de Portal WEB

At this point we represent physically and logically how the system


interacts with the server and sends results to the server base

6.3 Special restrictions


Use the corresponding data such as the specific characters.

6.4 scheduled tasks


A detail of the tasks scheduled within the database should be given with
at least the following:

 Name of the task: Consult the employee's data


 Description / Purpose: The employee's data is consulted in an
orderly manner.
 Sequence of actions: Once the session is started and
accepted, the data is consulted in the Database.
 Consequences of non-execution: it is not possible to access
the start of the application.
 Schedules of execution: There are no schedules for execution
 Considerations before a manual execution: It must be
registered in the Database.
 Any other detail that is of interest: That is not connected to the
internet or has no signal.
 Name of the task: Delete and modify data
 Description / Purpose: Delete and modify personal data from
the web application
 Sequence of actions: The operator contacts the administrator to
make changes to their personal data. From the web application.
 Consequences of non-execution: none
 Schedules of execution: There are no schedules for execution

5
Ministerio de Relaciones Exteriores y Culto
Sistema de Portal WEB

 Considerations before a manual execution: It must be


registered in the Database.
 Any other detail that is of interest: That is not connected to the
internet or has no signal.

6.5 Data Transformation Services


For these cases, it should be indicated:
 Name of the object: MySQL
 Description / Purpose: The data that the end user enters in the
application is stored.
 Sequence of actions: It will depend on the actions that the user
has within the application.
 Dependencies of operation (processes, files, actions, etc.):
enter, consult, modify and delete data.
 Task that executes this object: You could take any of the
above.
 Any other detail that may be of interest: None.

7. Support policies

7.1 Files
There should be a detail of the files to be supported, give a justification
in this regard, its periodicity, desired history, and possible consequences
that a bad practice may cause. To this end, the respective Support Form
must be completed. See document "FORM BACKUP 060119.xls".
7.2 Datababes
The database engine we use for this project is "MySQL", in which the
database (Sendabd) was added, where data will be inserted, modified,
consulted and deleted.

8. Descripción de interfaces con otros sistemas

In this section you should indicate in detail, each of the interfaces that the
solution uses to communicate or interact with other systems. The following data
must be given at least:
 Related system name: instant messaging
 Objective and description of the interface process: this
function will keep the administrator and the operators informed.
 Forms of communication: through internet
 Diagram: diagrams are not required
 Frames: frames are not required
 Cómo bajar y subir la interface: por medio de la selección de
datos

6
Ministerio de Relaciones Exteriores y Culto
Sistema de Portal WEB

 Cómo probar su adecuado funcionamiento: intercambiando


mensajes por medio de esta funcionalidad

9. Instalación y configuración

Cada uno de estos apartados debe ser agrupado por servidor para
garantizar su adecuada descripción. Debe quedar claro el inventario de
software de cada equipo. Este detalle debe darse también para realizar la
instalación de equipos- cliente de los servidores.

1. Requisitos generales pre-instalación


Como principales requisitos se necesitan, estar conectados a una
señal de wifi y verificar que la versión de Android esté actualizada
como se muestra a continuación.

2. Detalles del proceso de instalación


Para instalar la aplicación se hace desde Play Store. Se pone el
nombre en la barrita del buscador.

7
Ministerio de Relaciones Exteriores y Culto
Sistema de Portal WEB

Ingresará a Operator on Alert y dará clic en Instalar.

Al momento en que da clic en “Instalar”, aparecerá una ventana emergente


en donde se le informa que al querer instalar la aplicación, requiere acceso
a ciertos datos. Si da clic en “Aceptar”, aparecerá que la aplicación se está
descargando.

8
Ministerio de Relaciones Exteriores y Culto
Sistema de Portal WEB

Ya después de termina el proceso de instalación aparecerá si quiere


“Desinstalar o Abrir” la aplicación. Después regresa a su pantalla de inicio
y ahí aparecerá el icono de la aplicación que acaba de instalar.

3. Detalles de configuración de la aplicación


Después de habernos asegurado de las especificaciones que se
indican en la pre-instalación, la aplicación puede funcionar
correctamente si ningún problema.

9
Ministerio de Relaciones Exteriores y Culto
Sistema de Portal WEB

a. Variables de ambiente
Solo manejar las variables desde sistemas de Manifest
Android como lo son los paquetes de librerías, MarshMellow,
Nougat y Oreo en sus versiones desde 6.0 .

b. Parámetros de aplicaciones
Ya una vez instalada la aplicación no se exigen que se cambie
ningún parámetro.

Archivos de configuración
El archivo .apk Operator on Alert es el principal ejecutable para
el funcionamiento de lo que lo compone así como lo que son
los layouts que se usan para el diseño, darle estructura a la
interfaz y que este haga que funcione la aplicación.
Archivos de bitácora
Esta sección no exige los archivos de bitácora

Tareas programadas
Esta sección no exige tareas programadas
Lista de contactos técnicos
Debe especificarse una lista de personas a las cuales se les pueda
notificar en caso de problemas con el aplicativo y/o con el
Hardware. Estos contactos deben incluir tanto a personal del
Banco como al personal del proveedor que brinda el servicio.

Nombre completo Empresa/Unidad Módulo que Teléfonos/Beeper


Ejecutora atiende
Wendy Jaqueline Alvarez Operator on Técnico 8119203074
Hdz Alert
Fernanda Anahí Delgado Operator on Técnico 8111189711
Rdz Alert
David Iram Cantú Pérez Operator on Técnico 8121593809
Alert
Jonathan Roberto Zavala Operator on Técnico 8116733352
Rdz Alert
Edgar Ulises Padilla Lerma Operator on Técnico 8180781729
Alert

10. Procesos de continuidad y contingencia MÍO

Es necesario describir la solución de continuidad y contingencia propuesta


para la aplicación. La información mínima requerida es:

10
Ministerio de Relaciones Exteriores y Culto
Sistema de Portal WEB

 La principal solución sería que el operador siempre tendrá los


itinerarios a la mano, sin la necesidad de tener que estar llamándole
al administrador.

11. Descripción de usuarios

1. Usuarios de base de datos


Se debe incluir un listado de los usuarios de base de datos
necesarios para el aplicativo. Cada usuario debe incluir:
 Nombre del usuario: Administrador
 Descripción/Propósito: hacer movimientos desde la aplicación
 Grupos a los que pertenece: Administradores
 Privilegios generales a nivel de base de datos, y privilegios sobre
objetos de las mismas (tablas, vistas, triggers, etc.): poder
insertar, modificar, consultar y eliminar datos

2. Usuarios de sistema operativo


No se exigen los usuarios del sistema operativo

3. Usuarios de aplicaciones
Mencionar todo aquel usuario propietario de la aplicación, con los
siguientes detalles:
 Nombre del usuario: Administrador
 Descripción/Propósito: que podrá acceder a los datos
generales de los operadores
 Grupos a los que pertenece (en caso de que la aplicación realice
este manejo): Administrador
 Privilegios dentro de la aplicación: Accederá a los datos
generales de los operadores y podrá navegar con más
privilegios

11