GERENCIA DE INFORMÁTICA

Contrato de Servicio Web

SJAV058: Web Service Broker Expediente
Agosto de 2018

Nombres y Apellidos / Cargo Firma Fecha

Elaborado por / Analista Programador

Davis Gereda Hernandez / Analista

Revisado por Programador
Conrad León Torres / Gestor de Proyectos

Erik Almonte Ruiz / Coordinador de

Servicios y Aplicaciones Web
Aprobado por Giancarlo Zavaleta Ibañez/ Gestor de
Proyectos
 Versión
CONTRATO DE SERVICIO WEB 1.0

INDICE

1. INTRODUCCIÓN ......................................................................................................................... 3
2. OBJETIVOS ................................................................................................................................. 3
3. ALCANCE .................................................................................................................................... 3
4. ESPECIFICACIONES TÉCNICAS DEL SERVICIO .................................................................... 3
5. SERVICIOS WEB Del PROYECTO ............................................................................................ 4
6. DEFINICIÓN SERVICIO WEB ..................................................................................................... 4
6.1. WSBrokerExpediente ........................................................................................................ 4
7. EXCEPCIONES ........................................................................................................................... 7
8. CONSIDERACIONES DE DESEMPEÑO .................................................................................... 8
8.1. Concurrencia ..................................................................................................................... 8
8.2. Tiempo de respuesta esperado ......................................................................................... 8
8.3. Desempeño y Alta Disponibilidad ...................................................................................... 9
8.4. Escalabilidad y Soporte Técnico ....................................................................................... 9
9. SEGURIDAD DE APLICACIÓN ................................................................................................... 9
10. DIAGRAMA DE LA ARQUITECTURA. ........................................................................................ 9
ANEXO 01: Valores de ejemplo para las consultas realizadas a los métodos del servicio web
implementado. ........................................................................................................................... 11

HISTORIAL DE VERSIONES

Fecha de Elaborado Fecha de

Versión Descripción Revisado por
Elaboración por Revisión
Davis Gereda
16/08/2018 1.0 Creación del documento
Conrad León

Poder Judicial - 2018 Página 2 de 12

 Versión
CONTRATO DE SERVICIO WEB 1.0

Código SJAV058
Sistema / Módulo /
Aplicación
Web Service Broker Expediente
Documento(s)
asociado(s)

1. INTRODUCCIÓN
El presente documento formula el contrato del Servicio Web de Broker Expediente
especificando los métodos que la componen y los parámetros de entrada y salida utilizadas en
la migración de archivos desde el servidor FTP hacia el servidor Alfresco.

2. OBJETIVOS
El objetivo del documento es proporcionar información que permita la implementación de los
métodos “consultar documentos pendientes” y “actualizar el estado de los archivo en proceso de
migración” en el servicio web Broker Expediente a fin de migrar los archivos desde los servidores
FTP hacia el Servidor Alfresco.

3. ALCANCE
El contenido del documento está dirigido al equipo de desarrolladores de sistemas de esta
institución, quienes son los encargados de realizar la implementación de la migración de los
documento digitales generados a raíz del proyecto eje en las sedesTributario, Comerciales, La
Mar, JAV, Nazca, Arnaldo Marquez y Puno Carabaya en cumplimiento de la entrega del
proyecto en la cual se especifica los requerimientos recopilados en reuniones instituciones
realizadas.

4. ESPECIFICACIONES TÉCNICAS DEL SERVICIO

Los Servicios Web utilizarán un sistema estándar XML, para intercambiar mensajes, independiente
al sistema operativo operacional o lenguaje de programación, con dos propiedades básicas:

Publicable: Al crear el servicio, su publicación debe ser hecha mediante el registro de un catálogo
de servicios para que potenciales usuarios puedan encontrarlo y utilizarlo de ser el caso,
recomendando UDDI V. 3.0.2 definida por OASIS como catalogo o infraestructura de registro a
utilizar.

Auto Descriptible: Los servicios web deben ofrecer una descripción completa de sus servicios y
de cómo los usuarios podrán crear aplicaciones para interactuar con ellos. Esta descripción se
realizará a través de WSDL 2.0., definido por el W3C.

A fin que el servicio cumpla con el requerimiento de integración entre los diversos sistemas de
información, implementadas en diversas tecnologías, se debe utilizar como protocolo de
intercambio de información el SOAP v1.2 definido por el W3C., utilizando mensajes escritos en
lenguaje XML como estándar de interoperabilidad.

Poder Judicial - 2018 Página 3 de 12

 GERENCIA DE INFORMÁTICA

5. SERVICIOS WEB DEL PROYECTO

Los servicios web comprendidos en el proyecto son los siguientes:

Nombre
N° de Descripción Responsable Métodos Dirección WS
Servicio
 consultarDocume
ntosPendientesB
WSBroker  http://172.20.245.22:8088/pj.gob.p
roker
1 Expedient Poder Judicial e/servicesAlfresco/brokerExpedien
e  actualizarEstado
te?wsdl
ArchivoMigracion
Broker.

6. DEFINICIÓN SERVICIO WEB

6.1. WSBrokerExpediente

El servicio web está compuesto por dos (2) métodos:

Código de servicio WSBRE

Nombre de Servicio WSBrokerExpediente
N° Código Nombre de Método Descripción
Permite obtener:
consultarDocumentosPen 1. La metadata del archivo que se va a transferir y
1 CNAP
dientesBroker la ruta y nombre del mismo en el servidor FTP.
2. Los datos de acceso al servidor FTP.
Permite actualizar el estado (J:tarea, Q:cola,
actualizarEstadoArchivoM
2 ACAM M:migrado, E:error) del archivo en el proceso de
igracionBroker
transferencia.

A continuación se detallan los parámetros de entrada y salida por cada uno de los métodos
mencionados:

6.1.1. ConsultarDocumentosPendientesBroker
Nombre de
consultarDocumentosPendientesBroker
Método
Descripción Permite obtener:
1. La metadata del archivo que se va a transferir y la ruta y nombre del
mismo en el servidor FTP.
2. Los datos de acceso al servidor FTP.
PARÁMETROS DE HEADER
Nombre de
Tipo de dato Obligatorio Longitud Descripción
elemento
Username String SI 20 Usuario quien realiza la
solicitud
Password String SI 20 Contraseña de quien
realiza la solicitud
PARÁMETROS DE ENTRADA
Nombre de elemento Tipo de dato Obligatorio Longitud Descripción
requestSeguridad Seguridad
codigoCliente String SI 5 Código del cliente
codigoAplicativo String SI 3 Código del
aplicativo
 Versión
CONTRATO DE SERVICIO WEB 1.0

codigoRol String SI 3 Código rol

requestAuditoria Auditoria
ipPc String SI 15 Dirección IP
macAddressPc String SI 17 Dirección MAC
pcName String SI 45 Nombre de la Pc
usuarioSis String SI 45 Usuario del S.O.
usuarioRed String SI 45 Usuario de red
nombreSo String SI 45 Nombre del S.O.
requestConsultarDocu RequestConsult
mentosPendientesBro arDocumentosP
ker endientesBroker
codigoDB String SI 3 Código de la Base
de Datos
codigoSede String SI 4 Código de la Sede
PARÁMETROS DE SALIDA
Nombre de elemento Tipo de dato Obligatorio Longitud Descripción
responseConsultarDo ResponseConsu
cumentosPendientesB ltarDocumentos
roker PendientesBrok
er
mensaje MensajeType
codigo String SI 5 Código del mensaje
descripcion String SI 100 Descripción del
mensaje
responseConsultarD ResponseConsu
ocumentosPendient ltarDocumentos
esData PendientesData
listaDocumentosPe List<ResponseL
ndientes istaDocumentos
Pendientes>
n_correlativo_det String SI 10 Número correlativo
c_tabla String SI 3 Código de tabla
tipo_doc String SI 3 Tipo de documento
n_unico String SI 20 Número único del
expediente
n_incidente String SI 10 Numero Incidente del
Expediente
x_formato String SI 50 Formato del
Expediente
c_especialidad String SI 2 Código de
Especialidad
c_sub_especialid String SI 2 Código de
ad SubEspecialidad
c_org_jurisd String SI 2 Código de Instancia
x_nombre_juez String NO 15 Nombre de Juez
x_extension String SI 5 Extensión del
documento
f_ingreso String NO 24 Fecha de Ingreso
f_ingreso_acto String NO 24 Fecha de Ingreso
Acto
f_real_acto String NO 24 Fecha Real de Acto
c_motivo_ingreso String NO 3 Código de Motivo
Ingreso
c_proceso String NO 3 Código de Proceso

Poder Judicial - 2018 Página 5 de 12

 Versión
CONTRATO DE SERVICIO WEB 1.0

c_acto_procesal String NO 3 Código de Acto

Procesal
c_audiencia String NO 3 Código de Audiencia
f_creacion String NO 24 Fecha de Creación
n_sala String NO 10 Número de Sala
n_programacion String NO 10 Número de
Programación
n_audiencia String NO 6 Número de
Audiencia
nro_cedula String NO 6 Número de cédula
n_ano String NO 4 Número de año
f_emision String NO 24 Fecha de Emisión
f_notificacion String NO 24 Fecha de
Notificación
x_nombre_docu String SI 100 Nombre de
mento Documento
x_ruta_archivo String SI 150 Ruta del archivo en
el servidor FTP
x_ip String SI 15 IP del servidor FTP
c_usuario String SI 15 Usuaio del servidor
FTP
c_clave String SI 18 Clave del servidor
FTP
x_ruta_doc String SI 150 Ruta de Archivo en
el servidor Alfresco
c_sede String NO 4 Código de Sede
n_documento String NO 10 Número de
Documento
f_descargo String NO 24 Fecha de Descargo
distrito String NO 3 Código de Distrito
provincia String NO 4 Código de Provincia
instancia String NO 3 Código de Órgano
Jurisdiccional

6.1.2. ActualizarEstadoArchivoMigracionBroker

Nombre de
actualizarEstadoArchivoMigracionBroker
Método
Descripción Permite actualizar el estado (J:tarea, Q:cola, M:migrado, E:error) del
archivo en el proceso de transferencia.
PARÁMETROS DE HEADER
Nombre de
Tipo de dato Obligatorio Longitud Descripción
elemento
Username String SI 20 Usuario quien realiza la
solicitud
Password String SI 20 Contraseña de quien
realiza la solicitud
PARÁMETROS DE ENTRADA
Nombre de
Tipo de dato Obligatorio Longitud Descripción
elemento
requestSeguridad Seguridad
codigoCliente String SI 5 Código del cliente
codigoAplicativo String SI 3 Código del aplicativo
codigoRol String SI 3 Código rol
requestAuditoria Auditoria

Poder Judicial - 2018 Página 6 de 12

 Versión
CONTRATO DE SERVICIO WEB 1.0

ipPc String SI 15 Dirección IP

macAddressPc String SI 17 Dirección MAC
pcName String SI 45 Nombre de la Pc
usuarioSis String SI 45 Usuario del S.O.
usuarioRed String SI 45 Usuario de red
nombreSo String SI 45 Nombre del S.O.
requestActualizarEst RequestActu
alizarEstado
adoArchivoMigracion
ArchivoMigra
Broker cionBroker
String SI 3 Código de la base de
codigoDB
datos
numeroCorrelativo String SI 10 Número correlativo
indicadorMigracion String SI 1 Indicador de migración
uuid String NO 45 UUID
observación String NO 150 Observación
PARÁMETROS DE SALIDA
Nombre de
Tipo de dato Obligatorio Longitud Descripción
elemento
responseActualizarE ResponseAct
stadoArchivoMigraci ualizarEstad
onBroker oArchivoMigr
acionBroker
mensaje MensajeType
codigo String SI 5 Código del mensaje
descripcion String SI 100 Descripción del mensaje
responseActualizarE ResponseAct
stadoArchivoMigraci ualizarEstad
onData oArchivoMigr
acionData
actualizado String SI 1 S/N

7. EXCEPCIONES
Las excepciones empleadas en la implementación de los métodos existentes en el servicio
web “Broker Expediente” son los siguientes:

Validación método consultarDocumentosPendientesBroker

Código Descripción
VD001 El valor del bloque requestSeguridad es requerido.
VD002 El valor del campo codigoCliente es requerido.
VD003 El valor del campo codigoAplicativo es requerido.
VD004 El valor del campo codigoRoles requerido.
VD005 El valor del bloque requestAuditoria es requerido.
VD006 El valor del campo ipPc es requerido.
VD007 El valor del campo macAddressPc es requerido.
VD008 El valor del campo pcName requerido.
VD009 El valor del campo usuarioSis es requerido.
VD010 El valor del campo usuarioRed es requerido.
VD011 El valor del campo nombreSo requerido.

Poder Judicial - 2018 Página 7 de 12

 Versión
CONTRATO DE SERVICIO WEB 1.0

VD012 El valor del bloque requestAuditoria es requerido.

VD013 El valor del campo codigoDB es requerido.
VD014 El valor del campo codigoSede es requerido.

Validación método actualizarEstadoArchivoMigracionBroker

Código Descripción
VD001 El valor del bloque requestSeguridad es requerido.
VD002 El valor del campo codigoCliente es requerido.
VD003 El valor del campo codigoAplicativo es requerido.
VD004 El valor del campo codigoRoles requerido.
VD005 El valor del bloque requestAuditoria es requerido.
VD006 El valor del campo ipPc es requerido.
VD007 El valor del campo macAddressPc es requerido.
VD008 El valor del campo pcName requerido.
VD009 El valor del campo usuarioSis es requerido.
VD010 El valor del campo usuarioRed es requerido.
VD011 El valor del campo nombreSo requerido.
VD012 El valor del bloque RequestActualizarEstadoArchivoMigracionBroker es
requerido.
VD013 El valor del campo codigoDB es requerido.
VD014 El valor del campo numeroCorrelativo es requerido.
VD015 El valor del campo indicadorMigracion es requerido.

8. CONSIDERACIONES DE DESEMPEÑO
Debido a que el servicio web deberá ser consumido desde aplicativos informáticos
(tareaMigracion y consumerMigracion) debido a su operatividad constante, se requiere
implementar un esquema de alta disponibilidad considerando los siguientes puntos.

8.1. Concurrencia
La cantidad estimada de peticiones diarias en el proceso son los siguientes:

Peticiones Peticiones
Usuarios Usuarios
Usuario Máximas por promedio por
Estimados concurrentes
día día
1 1 - 5 mil aprox.
Poder Judicial
El cuadro expuesto deberá ser llenado previa coordinación con las áreas involucradas en el proceso a fin de
obtener proyecciones y/o estimaciones cercanas a la realidad.

8.2. Tiempo de respuesta esperado

El tiempo de respuesta óptimo dependerá de infraestructura existente la misma que no deberá
superar los 6 segundos. Las instituciones se comprometen en aplicar la mejora continua para la
reducción progresiva de los tiempos de respuesta actuales.

Poder Judicial - 2018 Página 8 de 12

 Versión
CONTRATO DE SERVICIO WEB 1.0

8.3. Desempeño y Alta Disponibilidad

Debido a que el servicio web será consumido desde aplicativos informáticos considerados críticos
por su alta operatividad dentro de los procesos, el servicio web deberá tener una disponibilidad de
99% anual.

8.4. Escalabilidad y Soporte Técnico

El Poder Judicial deberá realizar un procedimiento interno de soporte técnico para el manejo de
incidencias. Cada incidencia presentada deberá ser informada a los responsables del soporte a fin
de solucionar el problema de manera inmediata y garantizar la continuidad del flujo de proceso.

9. SEGURIDAD DE APLICACIÓN
Las políticas de seguridad a considerar en la implementación del servicio web son las siguientes:

 Log de accesos, incluyendo información de usuarios y la totalidad de casos positivos y

negativos.
 Se recomienda la implementación del ISO 27001 e ISO 27002 relacionados Técnicas de
Seguridad en Tecnologías de la Información.

10. DIAGRAMA DE LA ARQUITECTURA.

La arquitectura de la solución tecnológica es la siguiente:

Poder Judicial - 2018 Página 9 de 12

 Versión
CONTRATO DE SERVICIO WEB 1.0

Poder Judicial - 2018 Página 10 de 12

 Versión
CONTRATO DE SERVICIO WEB 1.0

ANEXO 01: VALORES DE EJEMPLO PARA LAS CONSULTAS REALIZADAS A LOS

MÉTODOS DEL SERVICIO WEB IMPLEMENTADO.

 Ejemplo de método “consultarDocumentosPendientesBroker”: Valores para la

realizar la consulta de los archivos que se tiene que migrar:

Nombre de Método consultarDocumentosPendientesBroker

PARÁMETROS DE HEADER
Nombre de elemento Valor
Username TAMIG_USER
Password 123456
PARÁMETROS DE ENTRADA
Nombre de elemento Valor
requestSeguridad
codigoCliente PJ
codigoAplicativo TAMIG
codigoRol ADM
requestAuditoria
ipPc 127.0.0.1
macAddressPc 00:00:00:00:00:00
pcName PC-DAVIS
usuarioSis DGEREDAH
usuarioRed
nombreSo
requestConsultarDocumento
sPendientesBroker
codigoDB 102
codigoSede 1899

 Ejemplo de método “actualizarEstadoArchivoMigracionBroker”: Valores para la

realizar la consulta de los archivos que se tiene que migrar:

Nombre de Método consultarDocumentosPendientesBroker

PARÁMETROS DE HEADER
Nombre de elemento Valor
Username TAMIG_USER
Password 123456
PARÁMETROS DE ENTRADA
Nombre de elemento Valor
requestSeguridad
codigoCliente PJ
codigoAplicativo TAMIG
codigoRol ADM
requestAuditoria
ipPc 127.0.0.1
macAddressPc 00:00:00:00:00:00
pcName PC-DAVIS
usuarioSis DGEREDAH

Poder Judicial - 2018 Página 11 de 12

 Versión
CONTRATO DE SERVICIO WEB 1.0

usuarioRed
nombreSo
requestActualizarEstadoArc
hivoMigracionBroker
codigoDB 102
numeroCorrelativo 1
indicadorMigracion E
uuid
observacion Hubo un error al transferir archivo

Poder Judicial - 2018 Página 12 de 12