Plantilla para el registro de Componentes

Se presenta una plantilla base para la documentación de los servicios expuestos

Definición

Definición del Componente
Nombre	nombre del componente expuesto
Descripción	una breve descripción del componente
Proyecto PB	nombre del proyecto en PB
Versión PB	versión del IDE de PB
URL SVN	dirección del repositorio que contiene el proyecto de PB
Librerias Propias	Tipo
nombre de cada librería del proyecto	breve descripción de la librería
Librerias Core	Tipo
nombre de cada librería base usada	breve descripción de la librería
Requisitos Técnicos
Framework	.Net 4.02 o Superior
Servidor	Internet Information Server 7.5 o Superior
Sistema Operativo	Windows Server 2012 R2
Memoria Ram	8GB
Exposición de Servicio
Tipo Servicio	SOAP 1.1 y SOAP 1.2 (.Net Easy SOAP - Generado por Powerbuilder)
URL Recurso	dirección del servicio wsdl expuesto
Operaciones	Objetivo
nombre de cada interfáz de consumo expuesta	breve descripción de la interfáz expuesta

Contrato de Consumo
Operación	Objetivo
nombre de interfáz expuesta	breve descripción de la interfáz expuesta
Parametros de Entrada
Nombre	Tipo de Datos	Descripcion			Formato Tipo
as_config	String	Cadena de Configuración del Consumo			Json
as_data	String	Cadena que contiene los parametros del Consumo			Json
Definicion Interna
Parametro Entrada	Atributo	Tipo Dato	Descripción	Requerido	Valor por Defecto¹⁾
as_config	token_session	String	Cadena que representa el hash de autenticación de acceso al consumo	Si	N/A
as_data	firstpag	Integer	Identificador de registro inicial de la paginación del consumo	Si	1
as_data	lastpag	Integer	Identificador de registro final de la paginación del consumo	Si	1
as_data	orderby	String	Cadena que contiene las columnas de ordenamiento del consumo	No	Utilizado por la DB
as_data	where	String	Cadena que contiene la sentencias de filtrado del consumo	No	N/A
Parametros de Retorno
Nombre	Tipo de Datos	Descripcion			Formato Tipo
identificador de la interfaz en el servicio	tipo de dato	breve descripción			Json
Definicion Interna
Parametro Entrada	Atributo	Tipo Dato	Descripción	Requerido	Valor por Defecto²⁾
identificador de la interfaz en el servicio	atributo de retorno	tipo de dato	berve descripción	identificación de requerido	valor por defecto

Entrada
código soap de ejemplo\|\|\|\|\|\| ^ Retorno ^^^^^^ \|<code html> código soap de ejemplo

id	Código	Descripción
código interno	texto de constante que representa	texto de validación

¹⁾ , ²⁾

Los valores por defecto son asumidos por el consumo interno