Descripción de servicio

Tamaño: px

Comenzar la demostración a partir de la página:

Download "Descripción de servicio"

Bernardo Morales Henríquez
hace 7 años
Vistas:

1 de servicio Código del servicio <Identificador del servicio> Nombre del servicio <Nombre del servicio> Versión <Última versión del servicio> Funcionalidades del servicio 1. <Nombre de la funcionalidad> 2. <Nombre de la funcionalidad> Página 1 de 9 Máster: ( )

2 Introducción Este documento detalla la información mínima que debe ser registrada para facilitar a las diferentes instituciones de la Administración Pública (AP) la búsqueda de los diferentes servicios de información provistos por el Estado, ya sean implementados a través de Web Semántica o Servicios Web. La descripción realizada se limita a dar una reseña de los requerimientos funcionales y no funcionales. Información suficiente para que cualquiera pueda hacer uso del servicio prestado. Objetivo Dar detalles sobre la funcionalidad que presta un servicio específico, incluyendo los requerimientos técnicos relacionados: sus entradas y salidas, flujos, recursos requeridos. Generalidades del intercambio de información Se contemplan los aspectos esenciales de un servicio, su objetivo y especificación. Propósito y descripción <Detalle el propósito y descripción del intercambio de información> Especificaciones del intercambio de Información Nombre y ubicación del archivo Request Nombre y ubicación del archivo Response Tabla 1. Arquitectura Protocolo de Comunicación Tipo de Arquitectura Servicio Web SOAP Especificaciones según SOAP Página 2 de 9 Máster: ( )

3 Nombre y ubicación del archivo Fault Nombre y ubicación del archivo WSDL Endpoint del servicio URLs Desarrollo URLs Testing URLs Producción Web Semántica/ Web 2.0 Protocolo de comunicación XML HTML Servicio Web JSON RDF Fuentes de dato Formato libre OWL Tabla 2. Tipo de Intercambio Tipo de Intercambio En línea Fuera de línea Síncrono Asíncrono En lote Tabla 3. Códigos de error Códigos de error Código error Tabla 4. Medio de confirmación Timeout Cantidad de reintentos Métodos de contingencia Control de unicidad Medio de confirmación Tabla 5. Especificación del ticket Especificación del ticket Estructura Página 3 de 9 Máster: ( )

4 Contenido Vigencia Autenticidad Tabla 6. Integridad del mensaje Integridad del mensaje Confirmación Digesto Autenticidad Forma de acceso Otros Tabla 7. Otras VPN Internet Frame Relay Dirigido a Ciudadano Gobierno Privado Procedimiento de suscripción al servicio Otras Requerimientos funcionales En esta sección se describen las operaciones funcionales del Servicio Web del proceso <Nombre del proceso>. Estas operaciones son: <Nombre de la funcionalidad 1> <Nombre de la funcionalidad 2 > También se definen las operaciones asociadas al servicio en cuanto a: pre-condiciones, terminaciones y post-condiciones resultantes; entradas y salidas -en caso de que existan-, operaciones e interacciones que deben ocurrir para que se cumpla el objetivo, así como la definición del contexto dentro del cual tienen sentido las funcionalidades definidas, incluyendo la identificación de otros contratos relacionados. Página 4 de 9 Máster: ( )

5 de la funcionalidad Las siguientes secciones explican las funcionalidades realizadas por el presente servicio. A continuación se describe a nivel técnico la operación en cuanto a: entradas, salidas, pre-condiciones, postcondiciones, además de otros aspectos: <Nombre de la funcionalidad 1> En la siguiente tabla se describe a detalle la funcionalidad 1: Precondiciones Tabla 8. de la funcionalidad <Nombre de la funcionalidad 1> Datos de entrada (mensaje de Requerimiento) Atributo Formato Tipo Longitud Salida (mensaje de Respuesta) Atributo Formato Tipo Longitud Fecha de Actualización Fuente Calidad de captura Nivel de Calidad Flujo normal Sistemas Servicios Página 5 de 9 Máster: ( )

6 Flujo alterno Estados resultantes Post-condiciones Clientes del servicio Relación con otros servicios Si aplica: indique el código del servicio, nombre de la operación involucrada y detalle el por qué requiere de la interacción con ese servicio. <Nombre de la funcionalidad 2> En la siguiente tabla se describe a detalle la funcionalidad 2. Precondiciones Tabla 9. de la funcionalidad <Nombre de la funcionalidad 2> Datos de entrada (mensaje de Requerimiento) Atributo Formato Tipo Longitud Salida (mensaje de Respuesta) Atributo Formato Tipo Longitud Fecha de Act. Nivel de Calidad Fuente Calidad de captura Página 6 de 9 Máster: ( )

7 Flujo normal Sistemas Servicios Flujo alterno Estados resultantes Post-condiciones Clientes del servicio Relación con otros servicios Si aplica: indique el código del servicio, nombre de la operación involucrada y detalle el por qué requiere de la interacción con ese servicio. Página 7 de 9 Máster: ( )

8 Requerimientos no funcionales Esta parte del contrato incluye: obligaciones (comportamientos requeridos), prohibiciones (comportamientos no permitidos) y restricciones o límites que aplican sobre las funcionalidades definidas en la parte funcional de este Contrato. Consideraciones de seguridad Tabla 10. Seguridad Seguridad Plano Cifrado Observaciones: <Alguna aclaratoria que considere importante resaltar> Nombre Tabla 11. Otras consideraciones de seguridad Otras consideraciones Observaciones: <Alguna aclaratoria que considere importante resaltar> Contexto <Enumere las características del entorno donde se consideró la implementación del servicio> Requerimientos de implementación Estos requerimientos pueden indicarse de forma general (para todas las operaciones) o por cada una de las operaciones definidas. Página 8 de 9 Máster: ( )

9 Tabla 12. Requerimientos de implementación Requerimiento Desempeño Disponibilidad Transacción Otros Página 9 de 9 Máster: ( )

Documentos relacionados

Requerimientos de Software

Requerimientos de Software Ingeniería de Requerimientos Se define como el proceso de establecer los servicios que el consumidor requiere de un sistema y las restricciones sobre las cuales de funcionar