AGESIC. Aplicación de Ruteo y Trazabilidad de Expediente Electrónico. Especificación Técnica ARTEE. Asunto: Fecha: 28/08/11

Transcripción

1 AGESIC Aplicación de Ruteo y Trazabilidad de Expediente Electrónico Asunto: Especificación Técnica ARTEE Fecha: 28/08/11

2 1. TABLA DE CONTENIDO 1. Tabla de Contenido Objetivo Diagrama de componentes Detalle de componentes ARTEECore ARTEEDataContract ARTEEServiceLibrary ARTEEWebServices ARTEEManteinanceTasks ARTEEWebQuery ARTEEAdmin Base de Datos Modelo Entidad Relación Artee_Config Artee_Log Error_Code Expedient_Trace Expedient_Trace_Search Inbox Organism Security_Function Security_Object Security_Role Security_Role_Function Página 2 de 29

3 6. Descripción de Servicios ObtenerDirectorioOrganismos ObtenerMesasOrganismo ObtenerClavePublicaOrganismo CrearModificarMesa ActualizarClavePublicaOrganismo EnviarExpediente ObtenerCantidadExpedientesMesa DescargarExpediente NotificarExpediente RecuperarExpediente ConsultarTrazaPorNumero ConsultarTrazaPorTexto Ping Componentes adicionales ARTEETest ARTEEClientPGE Hardware Servidor Web Servidor Base de Datos Página 3 de 29

4 2. OBJETIVO En este documento se detallan los aspectos técnicos de implementación de los distintos módulos de la Aplicación de Ruteo y Trazabilidad de Expedientes Electrónicos. Página 4 de 29

5 3. DIAGRAMA DE COMPONENTES Se presenta a continuación el diagrama con los principales componentes de la solución y sus interacciones. <<Porltet>> ARTEEWebQuery Aplicación de Expedientes ARTEEWebServices ARTEEAdminWebServices ARTEEWebServices <<WebApp>> ARTEEAdmin ARTEEServiceLibrary ARTEEDataContract ARTEECore <<EXE>> ARTEEManteinanceTasks LDAP PGE Timestamp PGE Database File Repository Página 5 de 29

6 4. DETALLE DE COMPONENTES Se describen en esta sección las principales características de cada componente de la aplicación. 4.1 ARTEECore Este componente se encarga de implementar las principales funcionalidades de la aplicación de ruteo y trazabilidad. Implementa la funcionalidad de acceso a la base de datos de la aplicación Implementa la lógica de los servicios Implementa la lógica de mantenimiento Comunicación con el proveedor de Timestamp Cabe destacar que parte de las funcionalidades de la aplicación se implementan directamente en la base de datos mediante el uso de procedimientos almacenados. ARTEECore.DataAccess ARTEECore.Manager ARTEECore.Provider 4.2 ARTEEDataContract En este componente se definen los contratos de datos de la aplicación para ser utilizados por los servicios y el resto de las capas. ARTEEDataContract.Entity ARTEEDataContract.Parameters Página 6 de 29

7 4.3 ARTEEServiceLibrary En este componente se definen los contratos de los servicios para las aplicaciones de expedientes, para la consulta ciudadana y para la aplicación de administración. Se implementa como una biblioteca de servicios de WCF. ARTEEServiceLibrary.Service ARTEEServiceLibrary.Context ARTEEServiceLibrary.Message ARTEEServiceLibrary.MessageAdmin 4.4 ARTEEWebServices Este componente se encarga de exponer los servicios de WCF como Web Services. ARTEEWebServices.ARTEEWebServices ARTEEWebServices.ARTEEAdminWebServices 4.5 ARTEEManteinanceTasks Este componente es un ejecutable que invoca a las operaciones de mantenimiento de la aplicación, como por ejemplo, la depuración de expedientes antiguos. Puede ser invocado de forma manual por un administrador, o ser agendado para su ejecución periódica. ARTEEManteinanceTasks.Context ARTEEManteinanceTasks.Manteinance Página 7 de 29

8 4.6 ARTEEWebQuery Este componente se implementa como un Portlet que permite realizar búsquedas de texto libre sobre la traza de los expedientes trazados por ARTEE. uy.com.dvelop.artee.bean uy.com.dvelop.artee.message uy.com.dvelop.artee.proxy uy.com.dvelop.artee.portlet Página 8 de 29

9 4.7 ARTEEAdmin Este componente es una aplicación web que permite administrar los organismos y mesas de ARTEE, realizar consultas, visualizar errores y modificar los parámetros de configuración de la aplicación. Esta implementado con Genexus X generando código.net. Se integra con el resto de la aplicación a nivel de base de datos y utilizando los servicios web de administración. Página 9 de 29

10 5. BASE DE DATOS Se detalla en esta sección la estructura de la base de datos de la aplicación. 5.1 Modelo Entidad Relación Página 10 de 29

11 5.2 Artee_Config 5.3 Artee_Log 5.4 Error_Code Página 11 de 29

12 5.5 Expedient_Trace Página 12 de 29

13 5.6 Expedient_Trace_Search 5.7 Inbox Página 13 de 29

14 5.8 Organism 5.9 Security_Function 5.10 Security_Object Página 14 de 29

15 5.11 Security_Role 5.12 Security_Role_Function Página 15 de 29

16 6. DESCRIPCIÓN DE SERVICIOS Se detallan en esta sección las características de los servicios expuestos por la aplicación 6.1 ObtenerDirectorioOrganismos Descripción: Obtiene el directorio de organismos activos de la aplicación. Activo (booleano) Resultado (estructura) Codigo (texto) Detalle (texto) Organismos (lista) Id (entero) Dominio (texto) Telefono (texto) Address (texto) (texto) ClavePublica (texto) Activo (booleano) Parámetros Devuelve organismos activos o inactivos Resultado Indica el resultado de la invocación y detalles de error en caso de ocurrir Directorio de organismos Página 16 de 29

17 6.2 ObtenerMesasOrganismo Descripción: Devuelve las mesas de un organismo. Dominio (texto) Resultado (estructura) Codigo (texto) Detalle (texto) Mesas (lista) Id (entero) Subdominio (texto) Confidencial (booleano) Activa (booleano) PorDefecto (booleano) Telefono (texto) Parámetros Dominio del organismo del cual se piden las mesas Resultado Indica el resultado de la invocación y detalles de error en caso de ocurrir Lista de mesas del organismo especificado 6.3 ObtenerClavePublicaOrganismo Descripción: Devuelve la clave pública de un organismo. Dominio (texto) Resultado (estructura) Codigo (texto) Detalle (texto) ClavePublica (texto) Parámetros Dominio del organismo del cual se pide la clave pública Resultado Indica el resultado de la invocación y detalles de error en caso de ocurrir Clave pública del organismo Página 17 de 29

18 6.4 CrearModificarMesa Descripción: Crea o actualiza una mesa de un organismo. Dominio (texto) Subdominio (texto) Descripcion (texto) Confidencial (booleano) Activa (booleano) Crear (booleano) Resultado (estructura) Codigo (texto) Detalle (texto) Parámetros Dominio del organismo al cual pertenece la mesa Subdominio de la mesa a crear o modificar Descripción de la mesa Indica si la mesa es confidencial Indica si la mesa está activa Indica si se está creando o modificando la mesa Resultado Indica el resultado de la invocación y detalles de error en caso de ocurrir 6.5 ActualizarClavePublicaOrganismo Descripción: Actualiza la clave pública de un organismo. Dominio (texto) ClavePublica (texto) Resultado (estructura) Codigo (texto) Detalle (texto) Parámetros Dominio del organismo dueño de la clave Nueva clave pública Resultado Indica el resultado de la invocación y detalles de error en caso de ocurrir Página 18 de 29

19 6.6 EnviarExpediente Descripción: Envía un expediente FIEE. DominioOrigen (texto) DominioDestino (texto) SubdominioOrigen (texto) Anio (texto) Inciso (texto) UnidadEjecutora (texto) Numero (texto) AnioAnterior (texto) IncisoAnterior (texto) UnidadEjecutoraAnterior (texto) NumeroAnterior (texto) ElementosFisicos (booleano) Confidencial (booleano) SeccionOrigen (texto) SeccionDestino (texto) Expediente (stream) Resultado (estructura) Codigo (texto) Detalle (texto) Parámetros Dominio del organismo origen del envío Dominio del organismo destino del expediente Subdominio de la mesa destino del expediente Año actual del expediente Inciso actual del expediente Unidad ejecutora actual del expediente Número actual del expediente Año de procedencia anterior del expediente Inciso de procedencia anterior del expediente Unidad ejecutora de procedencia anterior del expediente Número de procedencia anterior del expediente Marca de elementos físicos Marca de confidencialidad Sección origen del expediente Sección destino del expediente Expediente FIEE Resultado Indica el resultado de la invocación y detalles de error en caso de ocurrir 6.7 ObtenerCantidadExpedientesMesa Descripción: Obtiene la cantidad de expedientes disponibles en una mesa. Dominio (texto) Parámetros Dominio del organismo dueño de la mesa Página 19 de 29

20 Subdominio (texto) Resultado (estructura) Codigo (texto) Detalle (texto) CantidadExpedientes (entero) Subdominio de la mesa Resultado Indica el resultado de la invocación y detalles de error en caso de ocurrir Cantidad de expedientes disponibles 6.8 DescargarExpediente Descripción: Descarga el siguiente expediente FIEE de la mesa. Dominio (texto) Subdominio (texto) Resultado (estructura) Codigo (texto) Detalle (texto) Expediente (stream) Traza (estructura) Id (entero) Timestamp (fecha-hora) OrganismoOrigen (estructura) OrganismoDestino (estructura) MesaOrigen (estructura) SeccionOrigen (texto) SeccionDestino (texto) Anio (texto) Inciso (texto) UnidadEjecutora (texto) Numero (texto) AnioAnterior (texto) IncisoAnterior (texto) UnidadEjecutoraAnterior (texto) NumeroAnterior (texto) Parámetros Dominio del organismo dueño de la mesa Subdominio de la mesa Resultado Indica el resultado de la invocación y detalles de error en caso de ocurrir Expediente FIEE Información de la traza del expediente Página 20 de 29

21 Confidencial (booleano) ElementosFisicos (booleano) Página 21 de 29

22 6.9 NotificarExpediente Descripción: Notifica el envío de un expediente. DominioOrigen (texto) DominioDestino (texto) SubdominioOrigen (texto) Anio (texto) Inciso (texto) UnidadEjecutora (texto) Numero (texto) AnioAnterior (texto) IncisoAnterior (texto) UnidadEjecutoraAnterior (texto) NumeroAnterior (texto) ElementosFisicos (booleano) Confidencial (booleano) SeccionOrigen (texto) SeccionDestino (texto) Timestamp (fecha-hora) Resultado (estructura) Codigo (texto) Detalle (texto) Parámetros Dominio del organismo origen del envío Dominio del organismo destino del expediente Subdominio de la mesa destino del expediente Año actual del expediente Inciso actual del expediente Unidad ejecutora actual del expediente Número actual del expediente Año de procedencia anterior del expediente Inciso de procedencia anterior del expediente Unidad ejecutora de procedencia anterior del expediente Número de procedencia anterior del expediente Marca de elementos físicos Marca de confidencialidad Sección origen del expediente Sección destino del expediente Tiempo notificado de envío Resultado Indica el resultado de la invocación y detalles de error en caso de ocurrir Página 22 de 29

23 6.10 RecuperarExpediente Descripción: Recupera expedientes con el número especificado. Dominio (texto) Subdominio (texto) Numero (texto) Resultado (estructura) Codigo (texto) Detalle (texto) Expedientes (stream) Trazas (lista) Id (entero) Timestamp (fecha-hora) OrganismoOrigen (estructura) OrganismoDestino (estructura) MesaOrigen (estructura) SeccionOrigen (texto) SeccionDestino (texto) Anio (texto) Inciso (texto) UnidadEjecutora (texto) Numero (texto) AnioAnterior (texto) IncisoAnterior (texto) UnidadEjecutoraAnterior (texto) NumeroAnterior (texto) Confidencial (booleano) ElementosFisicos (booleano) Parámetros Dominio del organismo dueño de la mesa Subdominio de la mesa Número de expediente a recuperar Resultado Indica el resultado de la invocación y detalles de error en caso de ocurrir Archivo ZIP con expedientes FIEE Información de las trazas de los expedientes Página 23 de 29

24 6.11 ConsultarTrazaPorNumero Descripción: Consulta la traza de expedientes por número. Dominio (texto) Numero (texto) Resultado (estructura) Codigo (texto) Detalle (texto) Trazas (lista) Id (entero) Timestamp (fecha-hora) OrganismoOrigen (estructura) OrganismoDestino (estructura) MesaOrigen (estructura) SeccionOrigen (texto) SeccionDestino (texto) Anio (texto) Inciso (texto) UnidadEjecutora (texto) Numero (texto) AnioAnterior (texto) IncisoAnterior (texto) UnidadEjecutoraAnterior (texto) NumeroAnterior (texto) Confidencial (booleano) ElementosFisicos (booleano) Parámetros Dominio de quien invoca el servicio Número de expediente a buscar Resultado Indica el resultado de la invocación y detalles de error en caso de ocurrir Información de las trazas de los expedientes Página 24 de 29

25 6.12 ConsultarTrazaPorTexto Descripción: Consulta la traza de expedientes por texto libre. Dominio(texto) Texto (texto) TamanioPagina (entero) IndicePagina (entero) Parámetros Dominio de quien invoca el servicio Texto a buscar Tamaño de la página de resultados Número de página a devolver Resultado (estructura) Codigo (texto) Detalle (texto) ResultadoBusqueda (estructura) Cantidad (entero) Trazas (lista) Id (entero) Timestamp (fecha-hora) OrganismoOrigen (estructura) OrganismoDestino (estructura) MesaOrigen (estructura) SeccionOrigen (texto) SeccionDestino (texto) Anio (texto) Inciso (texto) UnidadEjecutora (texto) Numero (texto) AnioAnterior (texto) IncisoAnterior (texto) UnidadEjecutoraAnterior (texto) NumeroAnterior (texto) Confidencial (booleano) ElementosFisicos (booleano) Resultado Indica el resultado de la invocación y detalles de error en caso de ocurrir Resultados de la búsqueda Página 25 de 29

26 6.13 Ping Descripción: Recibe un archivo y devuelve un hash del mismo. Es utilizado como servicio de monitoreo para comprobar la disponibilidad de la aplicación. Dominio (texto) Archivo (stream) Resultado (estructura) Codigo (texto) Detalle (texto) MD5 (texto) Parámetros Dominio de quién invoca al servicio Archivo a enviar Resultado Indica el resultado de la invocación y detalles de error en caso de ocurrir Hash del archivo recibido Página 26 de 29

27 7. COMPONENTES ADICIONALES Existen componentes adicionales del sistema que no forman parte del ambiente de ejecución, pero sí del ambiente de desarrollo. 7.1 ARTEETest En este módulo se implementan diversas pruebas unitarias (y algunas de integración) sobre los distintos componentes del sistema. Antes de cada prueba se elimina y vuelve a crear la base de datos, manteniendo la independencia de ejecución entre cada test. En ARTEETest.Util se encuentran scripts de backup, creación y carga inicial de la base de datos. ARTEETest.AdminTestCase ARTEETest.ServiceTestCase ARTEETest.CoreTestCase ARTEETest.Util Página 27 de 29

28 7.2 ARTEEClientPGE Esta aplicación simula un cliente de prueba y permite probar algunos de los servicios que ofrece ARTEE. Facilita la prueba de llamadas concurrente a un conjunto de operaciones. Página 28 de 29

29 8. HARDWARE Dimensionamiento de Hardware de referencia mínimo para la plataforma ARTEE. 8.1 Servidor Web Sistema Operativo: Windows Server 2008 Procesador: 2.0Ghz o superior Memoria: 3Gb o superior Espacio en Disco: 80Gb o superior por ser precavido, pero no utiliza espacio en disco la aplicación Versión del framework de.net: Servidor Base de Datos Sistema Operativo: No hay preferencia frente a Windows o Linux, ya que solo se utiliza la base de datos Procesador: 2.0Ghz o superior Memoria: 3GB o superior Espacio en Disco: 250Gb o superior para soportar el crecimiento de la base, realizar backups, etc. Versión de Mysql: 5.1 o superior Página 29 de 29