Contrato de servicio

No. IT-2010-06-28

INFORME TÉCNICO
PROYECTO: Commodities OnLine
CLIENTE: Usuario consumidor

Descripción general: Commodities OnLine.

FECHA: 28 de junio de 2010
DESCRIPCIÓN: En este informe técnico se presenta la descripción del contrato para el servicio web de Commodities OnLine
REPORTAR A: administrador@grupo6.com.gt

Características:

• Basado en arquitectura orientada aservicios (SOA) implementada con Web Services.
• Encapsulamiento del acceso a datos + lógica de negocios a sistemas externos.

Web Service genérico

• Descripción: Web Service publicado en el servidor del sistema Commodities OnLine y consumido por sistemas externos. En este caso por sistema Cliente.

• Además se tiene como premisa importante que no se replicará ningún dato adicional de controlhacia los sistemas externos, sino sólo las llaves de identificación (número de caso, número de etapa, número de parámetro). La consulta del historial de etapas se consultarán en Sistema Commodities OnLine.

• Objetivos:
o Construir en Sistema “Commodities OnLine” un punto de actualización y consulta de datos sobre el estado y la cotizacion de los productos commodities en las diferentes bolsas demercacias.
o Integrador operativo entre Sistema Commodities OnLine y sistemas externos de bolsas de Exchange.

• Descripción de métodos: los métodos que expondrá el Web Service genérico corresponderán a las funciones genéricas definidas por el cliente.
• Diseño de la interfaz general para cualquier método:
Tipo de dato Descripción
INPUT (parámetros) STRING El Web Service recibe undocumento XML con la información de los parámetros para la solicitud de la operación. El documento XML encapsulará los valores entrantes.
OUTPUT (retorno) STRING El Web Service retorna un documento XML con la información del resultado de la operación. La estructura manejará un encabezado y un área de datos.

• Detalles técnicos: la información técnica del Web Service (acceso, WSDL, etc.) sedefinirá durante la construcción del sistema.

Estructura de la mensajería y comportamiento general:

INPUT:
Para el envío de los parámetros, en la mayoría de los métodos, se empleará la siguiente estructura para el documento XML de solicitud:





• El campo Symbol será el simbolo del Commodity a consultar.
• El campo Fecha será la fecha a consultar para un commoditie,esto para los datos historicos.
• El modelo de contenido XML del elemento raíz es por_elementos: puede contener cero o más elementos, cada uno en correspondencia con los parámetros de acuerdo a la naturaleza de la solicitud.

OUTPUT:
Para la respuesta de las operaciones solicitadas, se empleará la siguiente estructura para el documento XML de retorno:

Cookie.
.
.


• El elemento HRESULT, indica a través de un código de retorno binario cuál fue el estado del resultado de la operación, de la siguiente forma:
o 0 = operación fallida  ocurrió un error, descrito en el elemento mensaje.
o 1 = operación llevada a cabo con éxito  se obtuvo una respuesta lógicamente válida.
• El elementomensaje, brinda información adicional/específica referente al resultado de la operación:
o Si HRESULT=0, el mensaje brinda la descripción textual del error.
o Si HRESULT=1, el mensaje brinda cualquier texto aclarativo/informativo adicional (opcional) que se le puede indicar al usuario.
Esta descripción se enviará textualmente (dentro de una sección CDATA).
• El elemento área-datos contendrá todoslos datos de respuesta específicos a la operación solicitada, si el resultado de la operación fue exitosa; de lo contrario, dicha área se generará vacía. Así, el modelo de contenido XML de este elemento es por_elementos: cero o más elementos.

Revisión general de los accesos (métodos del Web Service genérico):

A continuación, se presenta la tabla general que resume los accesos inicialmente...