Manual Funcional de la plataforma de administración web “Back Office” para la solución de Biometría Facial

Descripción

En el presente manual se describen las funcionalidades de la plataforma de administración web “Back Office”, para la solución de biometría facial desarrollada para el cliente.

AMBIENTES

Siguiendo los estándares del desarrollo de soluciones de software se cuenta con 3 ambientes, detallados a continuación.

Desarrollo

En este ambiente los desarrolladores crean y prueban nuevas características, funcionalidades y correcciones de errores. El enfoque principal es la construcción y mejora del software.

El ingreso a este ambiente se puede realizar mediante la siguiente URL:

https://www.facialdev.identia.pe

Control de calidad (QA)

Este ambiente se utiliza para realizar pruebas exhaustivas y asegurarse de que el software cumpla con los estándares de calidad antes de ser lanzado en producción.

El ingreso a este ambiente se puede realizar mediante la siguiente URL:

https://www.facialqa.identia.pe

Producción

En este ambiente la aplicación está en pleno funcionamiento y disponible para los usuarios finales. Su objetivo es proporcionar un entorno estable y seguro para el uso en producción.

El ingreso a este ambiente se puede realizar mediante la siguiente URL:

https://www.facial.identia.pe

MÓDULOS

La plataforma tiene los siguientes módulos:

Inicio de sesión

Es la pantalla inicial que se visualiza al ingresar a la URL de acuerdo con el ambiente. En esta pantalla se presentan 3 campos:

• Entidad: Corresponde a la entidad o empresa a la cual pertenece una cuenta.

• Usuario: Es el correo electrónico u otro dato identificador con el que se creó una cuenta. Sirve para identificar al usuario del sistema.

• Contraseña: Es la contraseña inicialmente asignada y que luego el usuario debe cambiar al ingresar por primera vez en el sistema.

Cambio de contraseña

La contraseña debe seguir unas reglas de seguridad definidas por defecto de mezcla de caracteres, de acuerdo a una expresión regular REGEX parametrizable. Existen dos (2) formas mediante las cuales el usuario/titular de la cuenta puede cambiar la contraseña.

Primer Inicio de sesión

La contraseña que se asigna al crear una cuenta es aleatoria y temporal, por tanto, el sistema pedirá su cambio por una contraseña segura la primera vez que se inicie sesión.

Menú en la consola

Dentro de la consola del Back Office en el menú “Cambiar contraseña”

Dashboard

En este menú se pueden monitorear los recursos del sistema (a) y además ver un resumen de las validaciones faciales (b) de los últimos 30 días.

Tanto el monitoreo de recursos como el resumen de validaciones se muestran solo si es que el usuario tiene asignados en su rol las funciones “Recursos” o “Registros” respectivamente, caso contrario se le mostrará solo el texto de inicio “¡Bienvenido(a)!”. Adicionalmente hay un botón “Actualizar” (c) que sirve para refrescar la data haciendo una nueva consulta hacia el back-end.

Registros

En este módulo se pueden ver los registros de validaciones biométricas faciales que le corresponden a una entidad.

Filtros

Por defecto al momento de ingresar el filtro estará preseleccionado con la fecha actual considerando la hora local del país, por tanto, la fecha de inicio y fin serían las mismas, y de esta forma se mostrarían solo las transacciones de ese día.

Si el usuario desea ver las transacciones del mes actual o de un rango de fechas específico, debe hacer clic en el ícono correspondiente del calendario y luego seleccionar una fecha de inicio y otra de fin para obtener el rango. Luego debe presionar en el botón “Filtrar”.

Adicionalmente, para variar el orden de visualización de los registros, esto es, que se muestren en orden ascendente o descendente, se puede presionar el botón “Asc.” o el “Desc.”, respectivamente. También se pueden utilizar los otros filtros disponibles para obtener resultados más precisos, por ejemplo, para buscar por el número de DNI de una persona (ID Persona). Los campos adicionales por los que se puede filtrar son los siguientes:

• ID Persona: Se refiere al número de documento de identidad de la persona que ha pasado por un proceso de validación.
• Resultado: Es un campo desplegable con las opciones “HIT” y “NO HIT” y corresponde al resultado del proceso de validación, es decir si la identidad de la persona ha sido validada con éxito o no.
• Tipo Doc.: Es un desplegable con la lista de tipos de documento de identidad peruanos.
• Descr. Aplicativo / Descr. Canal / Descr. Proceso: Son campos desplegables con las listas de aplicativos, canales y procesos que van como parte de la descripción al crear un proceso de validación.

Detalle

Se puede ver el detalle de una transacción presionando el botón que lleva el ícono de un ojo al final de la fila. Además, se puede descargar el detalle de la transacción presionando en el botón “Guardar como PDF” dentro del mensaje emergente que saldrá en pantalla.

Exportar

Se puede realizar presionando en el botón con el mismo nombre, con ello las transacciones se exportarán en formato CSV, de acuerdo a los filtros seleccionados.

Lista negra

En este módulo se pueden ver a todas las personas que han sido bloqueadas del proceso de validaciones biométrica facial, ya sea de forma manual o de forma automática por alguna de las reglas parametrizadas, como por ejemplo la cantidad de intentos.

Filtros

Este módulo cuenta con filtros por fecha, por número de documento de identidad de la persona y por tipo de bloqueo.

Desbloqueo manual

Para desbloquear a una persona de forma manual se debe presionar en el “Candado” rojo al final de la fila, luego aparecerá un Pop-up que pedirá confirmar la acción, allí se debe presionar el botón “Si” para poder desbloquear a la persona.

Bloqueo manual

Para bloquear a una persona de forma manual se debe presionar en el botón “Nuevo” lo cual abrirá un popup en el que se puede seleccionar la nacionalidad, colocar el número de documento de la persona y una fecha y hora de expiración del bloqueo. Si se selecciona una fecha de expiración entonces de forma automática el usuario podrá volver a utilzar el proceso de validación una vez que se cumpla la fecha. En caso no se envíe una fecha de expiración, la persona quedaría bloqueada de forma permanente, siempre y cuando no se haga un desbloqueo manual.

Bloqueo / desbloqueo masivo

Para utilizar esta funcionalidad se debe presionar en el botón “Importar”, con esto se abrirá un popup con 2 botones. El botón “Formato” sirve para descargar el formato que debe ser llenado para poder hacer la importación, y con el botón “Seleccionar” se selecciona el archivo luego de ser llenado para poder ser subido.

El formato tiene 4 columnas:

• Nat: Que hace referencia a la nacionalidad de la persona, para Perú es “PER”.
• Id: Que hace referencia al número de DNI de la persona.
• Ban: Que hace referencia a si se desea bloquear “1” o desbloquear “0” a una persona.
• Undo_date: Que hace referencia a la fecha de desbloqueo automático en caso se esté bloqueando a una persona. Si este campo va vacío y se está bloqueando a una persona, entonces el bloqueo es permanente.

Exportación

Se puede realizar presionando en el botón con el mismo nombre, con ello se exportarán los registros de la lista negra en formato CSV, de acuerdo a los filtros seleccionados.

Detalle

Se puede ver el detalle de un registro de Lista Negra presionando en el botón con el ícono del “Ojo” al final de la fila. Además, se puede descargar el detalle del registro presionando en el botón “Guardar como PDF” dentro del pop-up.

Usuarios

Este módulo sirve para poder gestionar a los usuarios del sistema back-office y a los usuarios de tipo software que podrán utilizar los APIs en las integraciones.

Filtros

Este módulo cuenta con varios tipos de filtros que permiten hacer búsquedas más precisas de los usuarios.

Creación de usuario

Para crear un nuevo usuario se debe presionar en el boton “Crear usuario”, con ello se abrirá un pop-up en el que se registrarán los datos del usuario. Incluyendo:

• Tipo de usuario: Humano o software(para uso de API’s).
• Email/Usuario: Identificador del usuario, como estándar es un email, pero podría ser otro dato como un nombre de usuario o un número de DNI.
• Nombres: Nombres del usuario.
• Apellidos: Apellidos del usuario.

• Rol: Rol a asignar al usuario.

• Franja horaria: Datos sobre los días en que trabaja, y el horario de la persona, lo cual permitiría que solo se pueda acceder al sistema en esa franja.

• Activo: Si el usuario está activo o no.
• Fecha/hora reincorp: Fecha de reincorporación, este campo solo aparece cuando se selecciona la opción activo como “No”, para que así se permita configurar una fecha en la que de forma automática el usuario vuelva a tener acceso al sistema, por ejemplo si va de vacaciones. En caso no se coloque esta fecha se tendría que cambiar el estado a activo “Si” manualmente.

Luego de guardar a un usuario aparecerá un nuevo popup con una contraseña temporal que deberá ser compartida con el usuario para que pueda ingresar y cambiarla.

Edición de usuario

Para poder editar un usuario se debe hacer clic en el ícono del “Lápiz” al final de la fila. Con ello aparecerá un popup en donde podrán editar los datos.

Restablecimiento de contraseña

Para poder restablecer la contraseña a un usuario se debe hacer clic en el ícono de la llave al final de la fila, con esto aparecerá un popup pidiendo confirmar el reestablecimiento en el cual se debe presionar el botón “Si”.

Con ello aparecerá un popup con la nueva contraseña temporal que tendrá que ser enviada al usuario para que ingrese y pueda cambiarla.

Eliminación de un usuario

Para poder eliminar un usuario se debe presionar en el ícono del “Tacho” al final de la fila, con ello aparecerá un popup para confirmar en el cual se debe presionar si en caso deseen continuar con la eliminación.

Exportación

Se puede realizar presionando en el botón con el mismo nombre, con ello se exportará la lista de usuarios en formato CSV, de acuerdo a los filtros seleccionados.

Roles

Este módulo sirve para poder gestionar a los usuarios del sistema back-office y a los usuarios de tipo software que podrán utilizar los APIs en las integraciones.

Filtros

Este módulo cuenta con un filtro por nombre para hacer una búsqueda más precisa del rol.

Creación de Rol

Para crear un nuevo rol se debe presionar en el botón “Nuevo rol”, con ello se abrirá un popup en donde se podrá colocar los datos del rol. Estos datos son:

• Nombre: El nombre del rol, que será un identificador único, por tanto no puede ser editado luego.
• Descripción: Una breve explicación de lo que trata el rol, puede ser opcional.
• Funciones: Las funciones hacen referencia a los permisos que una persona a la que se le asigne vaya a tener sobre los distintos módulos del sistema. Una persona solo puede dar los mismos permisos o menores de los que tenga, esto es por seguridad, para impedir que pueda crear usuarios con más permisos de los que tiene y pueda ser usado con otros fines. Además una persona no puede editar un rol que le pertenezca, teniendo que ser la persona que creo al usuario en caso tenga un rol superior o de nivel root quien haga dicha edición.

Estos permisos son de los tipos Leer (solo consulta), Escribir (Creación y edición) y Eliminar. Los módulos sobre los que se pueden configurar estos permisos son:

• Recursos: Para poder visualizar los recursos del sistema en el dashboard.

• Registros: Para el módulo de registros de validaciones biométricas.

• Lista negra: Para el módulo de Lista negra.

• Usuarios: Para el módulo de usuarios.

• Roles: Para el módulo de roles.

• Logs: Para el módulo de logs de acceso.

• Parámetros: Para poder configurar parámetros.

Edición de un rol

Para poder editar un rol se debe hacer clic sobre el ícono del lápiz al final de la fila, con ello aparecerá un popup en el que se podrá editar los campos o marcar y desmarcar los permisos.

Eliminación de un rol

Para poder eliminar un rol se debe presionar en el ícono del tacho al final de la columna con ello aparecerá un popup en el cual se deberá presionar “Si” en caso se desee proceder con la eliminación.

Logs de acceso

Este módulo sirve para poder visualizar el historial de accesos de los usuarios y ver por ejemplo intentos de acceso con errores o correctos.

Filtros

Este módulo cuenta con un filtro por fecha que está preseleccionado con la fecha actual para ver los logs del día y otros filtros que permiten un búsqueda más precisa. Los campos adicionales por los que se puede filtrar son los siguientes:

• ID Usuario: Se refiere al identificador de la credencial de acceso del usuario.
• Resultado: Es un campo desplegable con los valores “Correcto” y “Error” y se refiere a si el ingreso al sistema ha sido exitoso o no respectivamente.

Exportación

Se puede realizar presionando en el botón con el mismo nombre, con ello se exportará los logs de acceso en formato CSV, de acuerdo a los filtros seleccionados.

Detalle

Se puede ver el detalle de un registro de log presionando en el botón con el ícono del “Ojo” al final de la fila.

Parametrización

Este módulo permite visualizar y configurar los diferentes parámetros del sistema. Los parámetros son valores que permiten una personalización de algunas características y son usados por el sistema para ese fin. Los nombres de los parámetros son valores únicos con los que se identifican, por tanto no pueden crearse nuevos parámetros pues son una lista finita que configuran los desarrolladores.

Edición de un parámetro

Los parámetros cuentan con valores por defecto, pero también se puede configurar un “Valo actual” que sobreescriba el valor por defecto si así se necesita. Para ello se debe hacer clic en el ícono del lápiz al final de la fila. Con ello aparecerá un popup en el que se podrá escribir el valor actual. En caso se desee volver a utilizar el valor por defecto bastará con borrar lo registrado en el valor actual.

Credenciales RENIEC o de sistema de fuente de datos

Este módulo permite registrar de forma segura los parámetros de conexión y uso del convenio de línea dedicada u otro que tenga la entidad para consultar el servicio de colas MQ de RENIEC. Además permite configurar los parámetros de conexión de un sistema de fuente de datos alterno en caso no se pueda acceder directamente al convenio de la entidad. Por seguridad este formulario solo recibe los valores y si bien son parámetros no son devueltos al front-end sino que solo aparece un “check” verde en caso ya haya sido registrado o una “x” roja en caso de que aún no haya sido registrado.

Modalidades

Este módulo permite configurar las modalidades de validación que luego pueden ser asignadas a un proceso determinado. La configuración de modalidades consiste en la asignación de desafíos que el usuario a validar tendrá que pasar para que se pueda validar su identidad.

Filtros

Este módulo cuenta con un filtro por ID de Modalidad.

Creación de una modalidad

Para crear una nueva modalidad se deberá presionar el botón “Crear modalidad”, con ello se abrirá un pop-up en el que se registrará la lista de desafíos. En el popup se muestra una leyenda con el nombre y descripción para cada posible desafío.

Los desafíos se registran entre 2 corchetes al inicio y 2 al final, con comillas dobles y separados por comas. Ejm:

Edición de una modalidad

Para poder editar una modalidad se debe hacer clic sobre el ícono del lápiz al final de la fila, con ello aparecerá un popup en el que se podrán edita rla lista de desafíos.

Eliminación de una modalidad

Para poder eliminar una modalidad se debe presionar en el ícono del tacho al final de la columna con ello aparecerá un popup en el cual se deberá presionar “Si” en caso se desee proceder con la eliminación.

Procesos

Este módulo permite configurar los procesos da validación que podrán ser asignados luego en la creación de un flujo de validación a través de los APIs.

Filtros

Este módulo cuenta con un filtro por ID de Proceso.

Creación de un proceso

Para crear una nueva modalidad se deberá presionar el botón “Crear modalidad”, con ello se abrirá un pop-up en el que se registrará la lista de desafíos. En el popup se muestra una leyenda con el nombre y descripción para cada posible desafío.

Para crear un proceso se deberá presionar el botón “Crear proceso”, con ello se abrirá un pop-up en el que se podrán seleccionar las modalidades que se desean asignar al proceso. Esto sirve para que en caso no funcione o no se valide correctamente la identidad con una modalidad se pueda ejecutar modalidades alternativas de validación.

Edición de un proceso

Para poder editar un proceso se debe hacer clic sobre el ícono del lápiz al final de la fila, con ello aparecerá un popup en el que se podrán editar la lista de modalidades.

Eliminación de un proceso

Para poder eliminar un proceso se debe presionar en el ícono del tacho al final de la columna con ello aparecerá un popup en el cual se deberá presionar “Si” en caso se desee proceder con la eliminación.

Personalización

Este módulo permite configurar la personalización de estilos y recursos de las pantallas del flujo de validación biométrica facial.

Parámetros generales y guardado

Los parámetros generales (1) de la personalización son:

• Nombre de la personalización: Es un alias para identificar la personalización
• ID de la personalización: Es un código alfanumérico que se genera de forma automática al crear una nueva personalización, y sirve para poder ser utilizada luego en el URL del flujo de validación facial.

Con respecto a la acción de guardar los cambios, esta se puede hacer presionando el botón “Guardar” (2) de la parte final de la pantalla, este botón es único y sirve para guardar los cambios de todas las secciones.

Recursos

Los recursos de la personalización son:

• Fuente / Bold: El archivo de fuente en formato: .otf, .ttf, .woff o .woff2, que servirá que se podrá seleccionar luego para algunas partes del contenido de las pantallas que se desee que vayan en bold con esa fuente.
• Fuente / Regular: El archivo de fuente en formato: .otf, .ttf, .woff o .woff2, que servirá que se podrá seleccionar luego para algunas partes del contenido de las pantallas que se desee que vayan en regular con esa fuente.
• Imágenes / Logo: Es el archivo de imagen en formato .svg, .png o .jpeg, que irá como logo en la cabecera de las pantallas si así se desea.
• Imágenes / Fondo: Es el archivo de imagen en formato .png o .jpeg, que irá como fondo de las pantallas si así se desea.

Para poder subir o actualizar un recurso se debe presionar sobre cualquiera de los botones “Seleccionar” (1), solo se permite seleccionar el formato que corresponde para cada recurso. En caso ya exista un recurso subido aparecerá el nombre del mismo al lado derecho del botón (2), caso contrario no aparecerá ningún texto en ese lugar.

Estilos

Son los estilos CSS para personalizar las pantallas. Estos están divididos por las secciones: Contenedor general, Cabecera, Contenedor de la tarjeta, Tarjeta, Cabecera de la tarjeta, Cuerpo de la tarjeta, Pie de la tarjeta y Botón del pie de la tarjeta. Dichas secciones se pueden identificar en la siguiente imagen:

Adicionalmente los campos del formulario corresponden a estilos CSS y para cada etiqueta se encuentra entre paréntesis su equivalente como nombre CSS para que sea más sencillo identificar el tipo de contenido que puede ir en cada campo. Las propiedades editables son las que aparecen en las imágenes:

Textos por pantalla

Los tipos de pantalla son: Captcha, Documento y Selfie.

Por cada pantalla se puede personalizar los siguientes elementos:

• Texto de la cabecera: Es el texto que irá en la cabecera de la tarjeta de la pantalla.
• Ícono lista cuerpo: Es el ícono que irá dentro del cuerpo de la tarjeta de la pantalla por cada elemento de la lista en caso haya más de uno.
• Texto cuerpo: Es el texto que irá en el cuerpo de la tarjeta de la pantalla. Este texto puede ser tanto único, y en ese caso no tendrá ícono o como una lista, en cual caso si tendrá ícono por cada elemente si se selecciona uno. Para agregar un nuevo elemento a la lista se debe presionar en el botón azul “+” (1) y para quitar un elemento se debe presionar en el botón rojo “-” (2).