PLATAFORMA DE INTEROPERABILIDAD, PDI INTRANET GUBERNAMENTAL República de Colombia - Derechos Reservados

Transcripción

1 MANUAL SERVICIOS DE INTEROPERABILIDAD DEL SISTEMA DE NOTIFICACIONES Y COMUNICACIONES EN LÍNEA PLATAFORMA DE INTEROPERABILIDAD, PDI INTRANET GUBERNAMENTAL República de Colombia - Derechos Reservados Bogotá, D.C., Agosto de 2009

2 FORMATO PRELIMINAR AL DOCUMENTO Título: Fecha elaboración aaaa-mm-dd: Sumario: MANUAL SERVICIOS DE INTEROPERABILIDAD DEL SISTEMA DE NOTIFICACIONES Y COMUNICACIONES EN LINEA Este documento relaciona los servicios de notificación en línea ofrecidos como servicios a través del tramitador de la PDI Palabras Claves: Formato: DOC Lenguaje: Español Dependencia: Ministerio de comunicaciones: programa Agenda de Conectividad Proyecto Sistema de Notificaciones y Comunicaciones Electrónicas Código: Versión: 2.0 Estado: APROBADO Categoría: Autor (es): Equipo U.T e-notificaciones Revisó: Aprobó: Información Adicional: Ubicación: Gerente de Proyecto U.T. e- Notificaciones Álvaro Rueda Zapata Gerente de Proyecto Programa Agenda de Conectividad Johanna Pimiento Quintero Gerente de Inteventoría Manuel Gomez Restrepo Gerente de Proyecto U.T. e- Notificaciones Álvaro Rueda Zapata Firmas:

3 CONTROL DE CAMBIOS VERSIÓN FECHA No. SOLICITUD /08/ /09/ /09/ /09/ /09/ /09/ /09/2009 RESPONSABLE Equipo U.T. e- Notificaciones Equipo U.T. e- Notificaciones Equipo U.T. e- Notificaciones Equipo U.T. e- Notificaciones Equipo U.T. e- Notificaciones Equipo U.T. e- Notificaciones Equipo U.T. e- Notificaciones DESCRIPCIÓN Creación de documento Cambios por observaciones de interventoría y Agenda Adición del capítulo de transferencia de archivos Cambios por observaciones de interventoría y Agenda Cambios por observaciones de Agenda Cambios por observaciones de Agenda Cambios por observaciones de Agenda

4 TABLA DE CONTENIDO 1. INTRODUCCIÓN PROPÓSITO ALCANCE SERVICIOS A TRAVÉS DEL TRAMITADOR PDI DESCRIPCIÓN GENERAL CÓMO USAR LOS SERVICIOS ESQUEMAS DESCRIPCIÓN DE LOS SERVICIOS SERVICIO DE TRANSFERENCIA DE ARCHIVOS... 11

5 1. INTRODUCCIÓN En este documento se presenta la explicación de las funcionalidades que exponen los servicios web de notificación en línea que se desarrollaron para ser expuestos en el tramitador. 1.1 PROPÓSITO Proveer una descripción técnico funcional de los servicios de interoperabilidad del sistema de notificaciones y comunicaciones en línea, brindando así mayor comprensión para la implementación de software cliente de los mismos. 1.2 ALCANCE Este documento aplica para el entregable MANUAL SERVICIOS DE INTEROPERABILIDAD DEL SISTEMA DE NOTIFICACIONES Y COMUNICACIONES EN LINEA y describe en general los servicios a través del tramitador de la PDI.

6 2. SERVICIOS A TRAVÉS DEL TRAMITADOR PDI 2.1 DESCRIPCIÓN GENERAL Son servicios web que se publican en el tramitador y que tienen funcionalidad relacionada con el tema de notificaciones electrónicas. Se supone que estos servicios van a ser consumidos por medio de sistemas de información clientes del tramitador. Como todos los servicios expuestos en el tramitador, la forma de los datos que se usa está restringida por los esquemas de GEL-XML. 2.2 CÓMO USAR LOS SERVICIOS Como se mencionó, el consumo de estos servicios se hace por medio de sistemas de información clientes del tramitador. Una vez hayan sido publicados allí, se podrán crear los clientes que, ateniéndose a las restricciones expuestas por los esquemas GEL-XML, hagan uso de las funcionalidades que éstos prestan. La forma de creación de esos clientes no se trata aquí porque es un tema completamente aparte del alcance del documento. 2.3 ESQUEMAS La versión de los esquemas GEL-XML usada es la 1.0. La url de publicación de los mismos es y las rutas mencionadas adelante son relativas a ésta. 2.4 DESCRIPCIÓN DE LOS SERVICIOS Hay dos datos comunes a los esquemas de entrada de todos los servicios: el identificador de la entidad y el identificador del sistema de esa entidad que harán uso del servicio. Esos datos se adicionaron para poder tener control sobre quién tiene autorización para ejecutar los servicios. La identificación de los errores de negocio se hace mediante los campos que están definidos en los xsd de salida de cada servicio. El detalle de los posibles errores se expone para cada servicio Consulta estado notificación Consulta el estado en que se encuentra alguna notificación.

7 Los esquemas de entrada y salida del servicio son: PDI/NotificacionEnLinea/Notificacion/tipoConsultaEstadoNotificacionEnt.xsd y /// /PDI/NotificacionEnLinea/Notificacion/tipoConsultaEstadoNotificacionSal.xsd Datos de entrada: Entidad pública notificación (locorg:tipocodunicoidentidadpublica) V 1.0 Sistema entidad pública notificación (notcor:tipoidsistemaentidad) V 1.0 Número notificación consulta (notcor:tiponumnotificacion) V1.0 Datos de salida: Número del proceso (locdoc:tiponumexpediente) V 1.0 Número del acto administrativo (locdoc:tiponumactoadministrativo) V 1.0 Fecha de emisión del acto administrativo (comtem:tipofecha) V 1.0 Estado de la notificación (notcor:tipoestadonotificacion) V 1.0 Entidad pública notificación (locorg:tipocodunicoidentidadpublica) V 1.0 Identificación de errores de negocio: Si no existe o si ocurre algún error, el campo estadoconsultanotificacion del xml de salida se llena con los valores: código 9, nombre NO_EXISTE, en el dato Estado de la notificación. Ver anexo 1.1 donde se muestran gráficas de la estructura de los xml de entrada y salida Crear proceso de notificación Crea una notificación. Los esquemas de entrada y salida del servicio son: /// /PDI/NotificacionEnLinea/Notificacion/tipoDatoProcesoNotificacionEnt.xsd y /// /PDI/NotificacionEnLinea/Notificacion/tipoDatoProcesoNotificacionSal.xsd Datos de entrada: Archivo adjunto a la notificación (comdoc:tipoarchivoadjunto) V 1.0 Número del acto administrativo de notificación (locdoc:tiponumactoadministrativo) V 1.0 Número de proceso de administración (locdoc:tiponumexpediente) V 1.0 Parte resolutiva (locdoc:tipotextoactoadministrativo) V 1.0

8 Entidad pública notificación (locorg:tipocodunicoidentidadpublica) V 1.0 Dependencia entidad notificación (locorg:tipodependenciaentidad) V 1.0 Sistema entidad pública notificación (notcor:tipoidsistemaentidad) V 1.0 Identificador del funcionario notificante (locper:tipoidentificacionnacionalpersona) V 1.0 Lista de personas a las que se envía la notificación (notcor:tipolistapersonanotificar) V 1.0 Plantilla proceso notificación (notnot:tipoplantillaproceso) V 1.0 Número acto administrativo asociado (locdoc:tiponumactoadministrativo) V 1.0 Datos de salida: Número del proceso (locdoc:tiponumexpediente) V 1.0 Número del acto administrativo (locdoc:tiponumactoadministrativo) V 1.0 Mensaje de confirmación (tipdat:tipocadena512) V 1.0 Lista de vías gubernativas. Cada vía gubernativa contiene los datos de la notificación y de la persona a la que se envía. (notnot:tipolistaviagubernativa) V 1.0 Identificación de errores de negocio en el campo mensaje de confirmación: "Error: Hay personas a notificar que no se encuentran asociadas al acto administrativo asociado", "Error: Hay procesos que no se encuentran en el estado correcto para emitir un acto administrativo asociado", "Error: Hay procesos que no se encuentran asociados o repartidos a un funcionario", "Error: el proceso y/o acto administrativo ya existe en la base de datos". Cuando se presentan estos errores, los valores de los demás datos tienen la información de los datos de entrada correspondientes. Ver anexo 1.2 donde se muestran gráficas de la estructura de los xml de entrada y salida Ejecutoriar acto administrativo Da por ejecutoriado un acto administrativo en el sistema. Los esquemas de entrada y salida del servicio son: // //PDI/NotificacionEnLinea/Notificacion/tipoEjecutoriarActoAdministratiEnt.xsd y ////PDI/NotificacionEnLinea/Notificacion/tipoEjecutoriarActoAdministratiSal.xsd Datos de entrada: Entidad pública notificación (locorg:tipocodunicoidentidadpublica) V 1.0 Dependencia entidad notificación (locorg:tipodependenciaentidad) V 1.0 Sistema entidad pública notificación (notcor:tipoidsistemaentidad) V 1.0 Archivo adjunto al acto (comdoc:tipoarchivoadjunto) v 1.0 Número del acto administrativo (locdoc:tiponumactoadministrativo) V 1.0 Número de proceso de administración (locdoc:tiponumexpediente) V 1.0

9 Datos de salida: Estado del acto administrativo (notcor:tipoestadonotificacion) V 1.0 Número del proceso de administración (locdoc:tiponumexpediente) V 1.0 Número del acto administrativo (locdoc:tiponumactoadministrativo) V 1.0 Mensaje de confirmación (tipdat:tipocadena512) V 1.0 Identificación de errores de negocio: "No se pudo ejecutoriar el acto porque aún está en ejecución Este mensaje se envía en el dato Mensaje de confirmación. Además en el campo estadoejecutoriaractoadministrativo se da el código correspondiente -según los esquemas GEL-xml- a error. Ver anexo 1.3 donde se muestran gráficas de la estructura de los xml de entrada y salida Revocar proceso de notificación Da por revocado un proceso de notificación en el sistema. Los esquemas de entrada y salida del servicio son: ////PDI/NotificacionEnLinea/Notificacion/tipoDatoRevocatoriaNotificacionEnt.xsd y ////PDI/NotificacionEnLinea/Notificacion/tipoDatoRevocatoriaNotificacionSal.xsd Datos de entrada: Número del acto administrativo (locdoc:tiponumactoadministrativo) V 1.0 Número del proceso de administración (locdoc:tiponumexpediente) V 1.0 Entidad pública notificación (locorg:tipocodunicoidentidadpublica) V 1.0 Dependencia entidad notificación (locorg:tipodependenciaentidad) V 1.0 Sistema entidad pública notificación (notcor:tipoidsistemaentidad) V 1.0 Observación a la revocatoria (comgen:tipoobservacion) V 1.0 Lista de personas a las que se envía la revocatoria (notcor:tipolistapersonanotificar) V 1.0 Datos de salida: Número del proceso de administración (locdoc:tiponumexpediente) V 1.0 Número del acto administrativo (locdoc:tiponumactoadministrativo) V 1.0 Mensaje de confirmación (tipdat:tipocadena512) V 1.0 Lista de vías gubernativas. Cada vía gubernativa contiene los datos de la notificación y de la persona a la que se envía (notnot:tipolistaviagubernativa) V 1.0

10 Identificación de errores de negocio: "No se pudo enviar la notificación de revocatoria a todas las personas de la lista" Este mensaje se envía en el dato Mensaje de confirmación Ver anexo 1.4 donde se muestran gráficas de la estructura de los xml de entrada y salida.

11 3. SERVICIO DE TRANSFERENCIA DE ARCHIVOS 3.1 SERVICIO DE SFTP El servicio de SFTP(Secure File Transfer Protocol) es un servicio de transferencia de archivos seguro, este se encarga de almacenar todos los procesos que han sido ejecutoriados en el servidor SFTP de la entidad a la cual pertenecen los procesos. Este servicio debe ser configurado por cada una de las entidades para que el sistema pueda almacenar los archivos en el servidor SFTP de la entidad. 3.2 CONFIGURACION DEL SERVICIO Para configurar el servicio de SFTP es necesario entrar al site de funcionarios como administrador e ingresar por la opción de gestión de contenidos tal como se muestra en la imagen a continuación. Una vez en la página de contenidos, se pueden visualizar los campos necesarios para la configuración del servicio, estos campos son: Unidades de tiempo: se refiere al número bajo el cual se debe hacer la periocidad de la sincronización de los archivos.

12 Precisión de tiempo: se refiere al periodo cíclico bajo el cual se van a contar las unidades de tiempo. Usuario: el usuario del servicio. Password: el password del usuario del servicio. URL: la url del servicio ftp con el prefijo sftp://. Además de la dirección del servicio se debe colocar la ruta a la carpeta en al cual se quieren dejar los archivos. Una vez ingresados lo datos, cuando se desea terminar la operación el sistema verifica que la dirección sea válida y este activa para la transferencia de archivos, en caso que esta operación no sea exitosa, el sistema le avisa al usuario que hay algún error en la configuración. El archivo que se envía es un archivo comprimido en formato.zip el cual contiene todos los archivos relacionados. Adicionalmente el sistema es capaz de ordenar en el ftp de la entidad el histórico con relación al número de proceso y fecha en el cual se archivó. La estructura del archivo se puede ver a continuación: - El nombre del archivo es el siguiente: Tipo de documento(nf, CF)-numero de proceso-numero de acto identificador único en la base de datos de la dependencia, ej. : NF Dentro de este archivo comprimido en formato.zip estarán los archivos relacionados a este proceso con la siguiente estructura: