Manual Del Programador Iotmach

Grupo de Investigación de Internet de las Cosas (IOTMACH)
Universidad Técnica de Machala
Aplicación web para la gestión del repositorio del Grupo IOTMACH 1.0
Dirección: Av. Panamericana Km. 5 1/2 Vía a Pasaje

Teléfono: +593 - 72983362 – Ext: 410 ó 419
Email: iotmach@utmachala.edu.ec
Url: www.iotmach.utmachala.edu.ec
Documento: IOT-PW-MP
Manual del Programador Grupo de Investigación del Internet de las
Cosas de la Universidad Técnica de Machala
Componente: Aplicación web para la gestión

Versión: 1.0
del repositorio del Grupo IOTMACH
CONTROL DE CAMBIOS
Fecha Descripción Responsable Versión
Colocar imágenes, colocar código, Srta. Jessenia

15/06/2016 1.0
índice de script Zaruma
Responsable: Fecha de actualización:

Página 2 de 11
Jessenia E. Zaruma Villón 17/06/2016

Versión: 1.0
IOT-PW-MP
Manual del Programador
Aplicación web para la gestión del repositorio del Grupo IOTMACH
Versión de Documento: 1.0
Copyright © 2016, Grupo de Investigación IOTMACH.
Todos los derechos Reservados.
Ninguna parte de este documento puede ser usado, reproducido, traducido, citado o
copiado, de cualquier forma, o método sin previo permiso escrito del Grupo de
investigación IOTMACH.
El Grupo de Investigación IOTMACH se reserva el derecho de modificar este manual por

mejoras del producto u otras causas sin notificación alguna.

Página 3 de 11

Versión: 1.0
Índice de Contenido
PREFACIO 6
ÁMBITO 6
QUIEN PUEDE USAR EL DOCUMENTO 6
RESUMEN 6
1. INTRODUCCIÓN 7
2. REQUISITOS DEL SISTEMA 8
2.1 CONFIGURACIÓN MÍNIMA 8
2.2 CONFIGURACIÓN RECOMENDADOS 8
2.3 REQUISITOS DEL SOFTWARE PARA EL DESARROLLO 8
2.4 REQUISITOS DE IMPLEMENTACIÓN 8
3. DESARROLLO DEL MANUAL 9
3.1 INICIO DE SESIÓN 9
3.1.1. CÓDIGO FUENTE DEL LOGIN DE ACCESO AL PORTAL 9
1.2.1. NOMBRES TÉCNICOS, URLS, VARIABLES, COMANDOS DE INSTALACIÓN 10
4. GLOSARIO 10
5. REFERENCIAS BIBLIOGRÁFICAS 10
6. ANEXOS 10
Índice de Tablas
Tabla 1 Configuración mínima del Sistema .............................................................. 8
Tabla 2 Configuración máxima del Sistema .............................................................. 8
Índice de Ilustraciones
Ilustración 1 Interfaz de Login ....................................................................................................... 9
Índice de Script
Script 1: Código fuente del login ................................................................................................ 10

Página 4 de 11

Versión: 1.0
Simbologías a utilizar en este manual
SIMBOLOGÍA
Símbolos a utilizar:
Esta simbología implica posibles causas de errores que se pueden presentar en el sistema
para su correcto funcionamiento. Asegúrese de leer las indicaciones pertinentes antes
de hacer uso del sistema IOTMACH.
Esta simbología implica las posibles soluciones que se le puede dar para la solución sobre
cómo resolver los posibles errores de usuarios

Página 5 de 11

Versión: 1.0
PREFACIO
ÁMBITO
Los componentes de la Aplicación Web se desarrollan con la finalidad de implementar
herramientas de documentación OpenSources que permitan el desarrollo de aplicaciones
donde se puede presentar documentación clasificada y almacenada en repositorios al
cual se accederá atreves de la utilización. Por el cual se realizará un portal web en el
cual se colocará la documentación técnica y de usuario, utilizando la herramienta
Doxygen para código y Pycharm para el portal web para así poder documentar cada
módulo que compone el proyecto IOTMACH.
QUIEN PUEDE USAR EL DOCUMENTO

El manual de Programador es un documento de comunicación técnica destinado a dar
asistencia a las personas que utilizan un sistema en particular en ese caso es útil para
los desarrolladores y técnicos del sistema en este caso este manual es directamente
para el Programador ya que es la persona quien va a manipular el sistema en su totalidad
en cuanto a lo que respecta a programación.
Rol Usuario autorizado
Administrador
Desarrollador si
Técnico si
Usuario
RESUMEN
En el presente documento se pretende desarrollar un manual con el contenido necesario
para su entendimiento del sistema que se esté desarrollando en cual poseerá una guía
paso a paso de cómo funciona el sistema.

Página 6 de 11

Versión: 1.0
1. INTRODUCCIÓN
En el siguiente trabajo se logrará realizar un manual de programador en el cual se

exponga cada una de las funciones del sistema, el sistema a describir en el manual es
un portal web que tiene como finalidad proporcionar la documentación necesaria al
programador.
Se presentarán todas las funcionalidades del sistema con el cual hará que el programador
pueda manipular correctamente del mismo, se detallaran cada uno de los códigos
fuentes y métodos que se utilizaron en la elaboración de cada módulo que se esté
realizando para la aplicación.
En este manual se mostrarán las imágenes de cada formulario y junto a ellos el código
fuente más relevante de esta aplicación para así poder entender su funcionamiento y
saber el flujo que está tomando este método.

Página 7 de 11

Versión: 1.0
2. REQUISITOS DEL SISTEMA

Breve descripción de la aplicación realizada.
2.1 Configuración mínima

IOTMACH Requisitos del sistema
Sistema Operativo Windows 7
Procesador Core i3
Espacio libre en disco 50 GB
RAM 6 GB
Tabla 1 Configuración mínima del Sistema
2.2 Configuración recomendados

Procesador Core i5
Espacio libre en disco 100 GB
RAM 6 GB
Tabla 2 Configuración máxima del Sistema
2.3 Requisitos del software para el desarrollo

Frameword Web Django 1.8.4
IDE de Desarrollo Pycharm 3.1
Python 3.4.1
Packages Virtualenv, reportlab, pip, psycopg2, pip-tools
2.4 Requisitos de implementación

Hosting Hostinger (Colocar el de ustedes)
Servicios oracle, postgres, hive, kafka, mqtt
Capacidad de almacenamiento

Página 8 de 11

Versión: 1.0
3. DESARROLLO DEL MANUAL

3.1 Inicio de Sesión
Ilustración 1 Interfaz de Login
Iniciar sesión siempre y cuando el usuario se encuentre registrado en el sistema
Si no desea iniciar sesión puede cerrar el sistema sin ningún inconveniente.
Si usted no posee un usuario y contraseña registrarse llenando el formulario con los

datos correspondientes.
3.1.1. Código fuente del login de acceso al portal

Acceso al login
Este método corresponde al Acceso al login en el cual controla el usuario y la
contraseña autentificado pudiendo así controlar si el acceso al usuario si está
registrado o no en la base de datos.
- El Frameword Web que utilizaremos es Django

- IDE de desarrollo Pycharm
def indexView(request):
return render(request, "index.html")
@login_required
def indexAdmin(request):
return render(request, "index_admin.html")
def loginView(request):
if request.method == "POST":
form = LoginForm(request.POST)
if form.is_valid():

Página 9 de 11

Versión: 1.0
user = authenticate(username=form.cleaned_data['username'],
password=form.cleaned_data['password'])
if user is not None and user.is_active:
login(request, user)
return redirect(request.POST.get('next', '/adminsite/'))
else:
messages.error(request, "Nombre de Usuario o contraseÃ±a Incorrecto")
return redirect("/login/")
form = LoginForm()
return render(request, "login.html", {"form": form})
Script 1: Código fuente del login
3.1.2. Nombres técnicos, urls, variables, comandos de instalación

 LoginView(): corresponde a un nombre de método que es donde se está
llevando la acción del logue para el ingreso del usuario
 http://www.denodo.com/es
 Username: corresponde a una variable que esta apuntado aun campo de texto
donde se colocara el nombre del usuario a verificar.
 password: corresponde a una variable que esta apuntado aun campo de texto
donde se colocara la contraseña del usuario a verificar.
4. GLOSARIO
seg_rol: Almacena roles.
User: Usuario del sistema
Seg_men: Almacena menús, submenús e ítems.
seg_permiso: Almacena los permisos que van a ser asignado a los roles.
5. REFERENCIAS BIBLIOGRÁFICAS
Foundation, D. S. (2015). DJANGO. Obtenido de DJANGO: https://www.djangoproject.com/
6. ANEXOS
Anexo #1: Diagrama de instalación

Página 10 de 11

Versión: 1.0

Página 11 de 11

Manual Del Programador Iotmach

Enviado por

Dados do documento

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Manual Del Programador Iotmach

Enviado por

Direitos autorais:

Formatos disponíveis

Grupo de Investigación de Internet de las Cosas (IOTMACH)

Universidad Técnica de Machala

Dirección: Av. Panamericana Km. 5 1/2 Vía a Pasaje

Componente: Aplicación web para la gestión

Fecha Descripción Responsable Versión

Colocar imágenes, colocar código, Srta. Jessenia

Responsable: Fecha de actualización:

Componente: Aplicación web para la gestión

Versión de Documento: 1.0

Copyright © 2016, Grupo de Investigación IOTMACH.

Todos los derechos Reservados.

El Grupo de Investigación IOTMACH se reserva el derecho de modificar este manual por

Responsable: Fecha de actualización:

Componente: Aplicación web para la gestión

Responsable: Fecha de actualización:

Componente: Aplicación web para la gestión

Simbologías a utilizar en este manual

Responsable: Fecha de actualización:

Componente: Aplicación web para la gestión

QUIEN PUEDE USAR EL DOCUMENTO

Rol Usuario autorizado

Responsable: Fecha de actualización:

Componente: Aplicación web para la gestión

En el siguiente trabajo se logrará realizar un manual de programador en el cual se

Responsable: Fecha de actualización:

Componente: Aplicación web para la gestión

2. REQUISITOS DEL SISTEMA

2.1 Configuración mínima

2.2 Configuración recomendados

2.3 Requisitos del software para el desarrollo

2.4 Requisitos de implementación

Responsable: Fecha de actualización:

Componente: Aplicación web para la gestión

3. DESARROLLO DEL MANUAL

Ilustración 1 Interfaz de Login

Iniciar sesión siempre y cuando el usuario se encuentre registrado en el sistema

Si no desea iniciar sesión puede cerrar el sistema sin ningún inconveniente.

Si usted no posee un usuario y contraseña registrarse llenando el formulario con los

3.1.1. Código fuente del login de acceso al portal

- El Frameword Web que utilizaremos es Django

Responsable: Fecha de actualización:

Componente: Aplicación web para la gestión

3.1.2. Nombres técnicos, urls, variables, comandos de instalación

Foundation, D. S. (2015). DJANGO. Obtenido de DJANGO: https://www.djangoproject.com/

Responsable: Fecha de actualización:

Componente: Aplicación web para la gestión

Responsable: Fecha de actualización:

Você também pode gostar