Contrato Consultar Listas Negras

PLANTILLA PARA ESPECIFICAR
CONTRATOS DE SERVICIOS.
MEPROC
Documento de Especificación de Servicios (Contrato):
Servicio-S09
Versión 1.0
MEPROC
Documento de especificación de un servicio SOA (Contrato)
Versión:
1.0
Fecha: 16/05/2010
Revisión
Fecha
Versión
Descripción
Autor
Aprobaciones
Nombre / Rol
Derechos Reservados Jorge
Arias Consultor
Independiente
Fecha
Plantilla para levantar contratos
de Servicios
Firma
Pág. 2 de 11
MEPROC
Documento de especificación de un servicio SOA (Contrato)
Versión:
1.0
Fecha: 16/05/2010
Tabla de Contenido
1.
Breve Descripción
4
2.
Versión del servicio
4
3.
Roles
4
4.
Dueños del servicio
4
5.
Descripción de la interfaz del servicio
4
6.
Detalle del contrato del servicio
5
6.1
6.2
6.3
6.4
6.5
Consultar todo
5
6.1.1 Mensaje de entrada (en su defecto coloco una referencia al archivo XSD que contiene la
definición del mensaje de entrada)
5
6.1.2 Mensaje de Salida (en su defecto coloco una referencia al archivo XSD que contiene la definición
del mensaje de entrada)
6
6.1.3 Excepciones
6
Consulta la lista Clinton
6
6.2.1 Mensaje de entrada (en su defecto coloco una referencia al archivo XSD que contiene la
definición del mensaje de entrada)
6
6.2.2 Mensaje de Salida (en su defecto coloco una referencia al archivo XSD que contiene la definición
del mensaje de entrada)
7
6.2.3 Excepciones
7
Consulta la lista del ministerio de hacienda
7
6.3.1 Mensaje de entrada (en su defecto coloco una referencia al archivo XSD que contiene la
definición del mensaje de entrada)
7
6.3.2 Mensaje de Salida (en su defecto coloco una referencia al archivo XSD que contiene la definición
del mensaje de entrada)
8
6.3.3 Excepciones
8
Consulta CIFIN
8
6.4.1 Mensaje de entrada (en su defecto coloco una referencia al archivo XSD que contiene la
definición del mensaje de entrada)
8
6.4.2 Mensaje de Salida (en su defecto coloco una referencia al archivo XSD que contiene la definición
del mensaje de entrada)
9
6.4.3 Excepciones
9
Consulta la lista Negra local
9
6.5.1 Mensaje de entrada (en su defecto coloco una referencia al archivo XSD que contiene la
definición del mensaje de entrada)
10
6.5.2 Mensaje de Salida (en su defecto coloco una referencia al archivo XSD que contiene la definición
del mensaje de entrada)
10
6.5.3 Excepciones
10
7.
Implementación del servicio
11
8.
Manejo de requerimientos no funcionales
11
Derechos Reservados Jorge
Arias Consultor
Independiente
Plantilla para levantar contratos
de Servicios
Pág. 3 de 11
MEPROC
Documento de especificación de un servicio SOA (Contrato)
Versión:
1.0
Fecha: 16/05/2010
Documento de Especificación del Servicio Consultar
listas negras
1.
Breve Descripción
Este servicio se encarga de consultar en los diferentes tipos de listas de riegos, los clientes
potenciales para los diferentes productos que ofrece el banco. Al final de la consulta del
proceso el servicio informará como primera medida si el cliente se encuentra o no en algunas
de las listas restrictivas.
2.
Versión del servicio
1.0
3.
Roles
Role
Sistema Proveedor
Potenciales Sistemas
consumidores
4.
Descripción
BlackListSystem
CRM
Dueños del servicio
<De acuerdo a una matriz RACI (Resposible, Accountable, Consulted, Informed> indique las
áreas de negocio o personas responsables del servicio>
Resposible
Accountable
Informed
Area de riesgo
Area de riesgo
CRM
Nota: Recuerde que el secreto de SOA es la gobernabilidad, la cual es un principio de base de
la organización alrededor de su visión de arquitectura empresarial.
5.
Descripción de la interfaz del servicio
Nombre de la
operación
Consultar Todo
Descripción de la
operación
Por medio de esta
operación los demás
sistemas saben si
una persona se
encuentra o no en
una lista negra
Consulta Lista
Hace una consulta
Clinton
especifica en la lista
clienton
Derechos Reservados Jorge
Plantilla
Arias Consultor
Independiente
Mensaje de
entrada
Nombre
completo de la
persona 0 razón
social y tipo de
documento
Mensaje de
salida
Boolean
indicando si el
cliente existe
en alguna lista
o no
Nombre
Boolean
completo de la
indicando si la
persona 0 razón persona o
para levantar contratos
de Servicios
Excepciones
GeneralException Se
indicara a través de
una excepción si
alguno de los
sistemas tienen
problemas
ClintonListException
Indica si hubo algún
problema en la
Pág. 4 de 11
MEPROC
Documento de especificación de un servicio SOA (Contrato)
social y tipo de
documento
Consulta listas
Ministerio
Consulta las listas
restrictivas del
ministerio de
hacienda
Nombre
completo de la
persona 0 razón
social y tipo de
documento
Consulta CIFIN
Consulta el
repositorio interno
CIFIN
Nombre
completo de la
persona 0 razón
social y tipo de
documento
6.
Versión:
1.0
Fecha: 16/05/2010
entidad
consultada
existe en la
lista
Boolean
indicando si la
persona o
entidad
consultada
existe en la
lista
Boolean
indicando si la
persona o
entidad
consultada
existe en la
lista
consulta a esta lista
MinisterListException
Indica si hubo algún
problema en la
consulta a esta lista
CifinException
Indica si hubo algún
problema en la
consulta a este
repositorio
Detalle del contrato del servicio
<Describa en esta sección de manera detalla los tipos de datos, y las reglas que aplican para
cada uno de ellos, que componen los mensajes de entrada y salida de las diferentes funciones
descritas en la sección 5.
6.1 Consultar todo
6.1.1 Mensaje de entrada (en su defecto coloco una referencia al archivo XSD que contiene la
definición del mensaje de entrada)
Atributo
Descripción
Tipo
Nombres
Nombres
completos de la
persona a
evaluar
String
Apellidos
Apellidos
completos de la
persona a
evaluar
String
Razón social
Razón social
completa de la
entidad a
evaluar
String
Tipo de
identificación
Indica el tipo
de
String
Derechos Reservados Jorge
Arias Consultor
Independiente
Obligatorio
Valores
(Dominio,
Valor por
default, etc.)
Regla de
negocio
Si, si el tipo
de
documento
seleccionado
no es NIT
Si, si el tipo
de
documento
seleccionado
no es NIT
Si, si el tipo
de
documento
seleccionado
es NIT
Plantilla para levantar contratos
de Servicios
CC, NIt, NUIP,
TI y CE
Pág. 5 de 11
MEPROC
Documento de especificación de un servicio SOA (Contrato)
Atributo
Descripción
Tipo
Obligatorio
Versión:
1.0
Fecha: 16/05/2010
Valores
(Dominio,
Valor por
default, etc.)
Regla de
negocio
identificación
a evaluar
6.1.2 Mensaje de Salida (en su defecto coloco una referencia al archivo XSD que contiene la definición
del mensaje de entrada)
Atributo
resultado
Descripción
Mensaje
indicando si se
encontró o no
una persona
Tipo
boolean
Obligatorio
Si
Valores
(Dominio,
Valor por
default, etc.)
1.0
Regla de
negocio
6.1.3 Excepciones
En esta sección se debe describir todas las posibles excepciones que puede llegar a generar la
ejecución de la operación que está siendo descrita.
Nombre de la excepción
GeneralException
Descripción
Error general al
consultar la lista
Regla de negocio
6.2 Consulta la lista Clinton
6.2.1 Mensaje de entrada (en su defecto coloco una referencia al archivo XSD que contiene la
definición del mensaje de entrada)
Atributo
Nombres
Descripción
Nombres
completos de la
persona a
evaluar
Tipo
Obligatorio
Si, si el tipo
de
documento
seleccionado
no es NIT
Apellidos
Apellidos
String
Si, si el tipo
completos de la
de
persona a
documento
evaluar
seleccionado
no es NIT
Razón social
Razón social
String
Si, si el tipo
Derechos Reservados Jorge
Plantilla para levantar contratos
Arias Consultor
de Servicios
Independiente
Valores
(Dominio,
Valor por
default, etc.)
Regla de
negocio
String
Pág. 6 de 11
MEPROC
Documento de especificación de un servicio SOA (Contrato)
Atributo
Descripción
Tipo
completa de la
entidad a
evaluar
Tipo de
identificación
Indica el tipo
de
identificación
a evaluar
Obligatorio
Versión:
1.0
Fecha: 16/05/2010
Valores
(Dominio,
Valor por
default, etc.)
Regla de
negocio
de
documento
seleccionado
es NIT
String
CC, NIt, NUIP,
TI y CE
6.2.2 Mensaje de Salida (en su defecto coloco una referencia al archivo XSD que contiene la definición
del mensaje de entrada)
Atributo
resultado
Descripción
Mensaje
indicando si se
encontró o no
una persona
Tipo
boolean
Obligatorio
Si
Valores
(Dominio,
Valor por
default, etc.)
1.0
Regla de
negocio
6.2.3 Excepciones
En esta sección se debe describir todas las posibles excepciones que puede llegar a generar la
ejecución de la operación que está siendo descrita.
Nombre de la excepción
ClintonListException
Descripción
Error general al
consultar la lista
Regla de negocio
6.3 Consulta la lista del ministerio de hacienda
6.3.1 Mensaje de entrada (en su defecto coloco una referencia al archivo XSD que contiene la
definición del mensaje de entrada)
Atributo
Nombres
Descripción
Nombres
completos de la
persona a
evaluar
Derechos Reservados Jorge
Arias Consultor
Independiente
Tipo
Obligatorio
Si, si el tipo
de
documento
seleccionado
no es NIT
Plantilla para levantar contratos
de Servicios
Valores
(Dominio,
Valor por
default, etc.)
Regla de
negocio
String
Pág. 7 de 11
MEPROC
Documento de especificación de un servicio SOA (Contrato)
Atributo
Descripción
Tipo
Apellidos
Apellidos
completos de la
persona a
evaluar
String
Razón social
Razón social
completa de la
entidad a
evaluar
String
Tipo de
identificación
Indica el tipo
de
identificación
a evaluar
String
Obligatorio
Versión:
1.0
Fecha: 16/05/2010
Valores
(Dominio,
Valor por
default, etc.)
Regla de
negocio
Si, si el tipo
de
documento
seleccionado
no es NIT
Si, si el tipo
de
documento
seleccionado
es NIT
CC, NIt, NUIP,
TI y CE
6.3.2 Mensaje de Salida (en su defecto coloco una referencia al archivo XSD que contiene la definición
del mensaje de entrada)
Atributo
resultado
Descripción
Mensaje
indicando si se
encontró o no
una persona
Tipo
boolean
Obligatorio
Si
Valores
(Dominio,
Valor por
default, etc.)
1.0
Regla de
negocio
6.3.3 Excepciones
En esta sección se debe describir todas las posibles excepciones que puede llegar a generar la
ejecución de la operación que está siendo descrita.
Nombre de la excepción
MinisterListException
Descripción
Error general al
consultar la lista
Regla de negocio
6.4 Consulta CIFIN
6.4.1 Mensaje de entrada (en su defecto coloco una referencia al archivo XSD que contiene la
definición del mensaje de entrada)
Derechos Reservados Jorge
Arias Consultor
Independiente
Plantilla para levantar contratos
de Servicios
Pág. 8 de 11
MEPROC
Documento de especificación de un servicio SOA (Contrato)
Atributo
Descripción
Tipo
Nombres
Nombres
completos de la
persona a
evaluar
String
Apellidos
Apellidos
completos de la
persona a
evaluar
String
Razón social
Razón social
completa de la
entidad a
evaluar
String
Tipo de
identificación
Indica el tipo
de
identificación
a evaluar
String
Obligatorio
Versión:
1.0
Fecha: 16/05/2010
Valores
(Dominio,
Valor por
default, etc.)
Regla de
negocio
Si, si el tipo
de
documento
seleccionado
no es NIT
Si, si el tipo
de
documento
seleccionado
no es NIT
Si, si el tipo
de
documento
seleccionado
es NIT
CC, NIt, NUIP,
TI y CE
6.4.2 Mensaje de Salida (en su defecto coloco una referencia al archivo XSD que contiene la definición
del mensaje de entrada)
Atributo
resultado
Descripción
Mensaje
indicando si se
encontró o no
una persona
Tipo
boolean
Obligatorio
Si
Valores
(Dominio,
Valor por
default, etc.)
1.0
Regla de
negocio
6.4.3 Excepciones
En esta sección se debe describir todas las posibles excepciones que puede llegar a generar la
ejecución de la operación que está siendo descrita.
Nombre de la excepción
CIFINException
Descripción
Error general al
consultar la lista
Regla de negocio
6.5 Consulta la lista Negra local
Derechos Reservados Jorge
Arias Consultor
Independiente
Plantilla para levantar contratos
de Servicios
Pág. 9 de 11
MEPROC
Documento de especificación de un servicio SOA (Contrato)
Versión:
1.0
Fecha: 16/05/2010
6.5.1 Mensaje de entrada (en su defecto coloco una referencia al archivo XSD que contiene la
definición del mensaje de entrada)
Atributo
Descripción
Tipo
Nombres
Nombres
completos de la
persona a
evaluar
String
Apellidos
Apellidos
completos de la
persona a
evaluar
String
Razón social
Razón social
completa de la
entidad a
evaluar
String
Tipo de
identificación
Indica el tipo
de
identificación
a evaluar
String
Obligatorio
Valores
(Dominio,
Valor por
default, etc.)
Regla de
negocio
Si, si el tipo
de
documento
seleccionado
no es NIT
Si, si el tipo
de
documento
seleccionado
no es NIT
Si, si el tipo
de
documento
seleccionado
es NIT
CC, NIt, NUIP,
TI y CE
6.5.2 Mensaje de Salida (en su defecto coloco una referencia al archivo XSD que contiene la definición
del mensaje de entrada)
Atributo
resultado
Descripción
Mensaje
indicando si se
encontró o no
una persona
Tipo
boolean
Obligatorio
Si
Valores
(Dominio,
Valor por
default, etc.)
1.0
Regla de
negocio
6.5.3 Excepciones
En esta sección se debe describir todas las posibles excepciones que puede llegar a generar la
ejecución de la operación que está siendo descrita.
Nombre de la excepción
LocalListException
Derechos Reservados Jorge
Arias Consultor
Independiente
Descripción
Error general al
consultar la lista
Plantilla para levantar contratos
de Servicios
Regla de negocio
Pág. 10 de 11
MEPROC
Documento de especificación de un servicio SOA (Contrato)
7.
Versión:
1.0
Fecha: 16/05/2010
Implementación del servicio
<Describa en esta sección las reglas de negocio, consideraciones, lineamientos, políticas y
principios de negocio que deban tenerse en cuenta durante la implementación de cada una de
las diferentes funciones que componente o estructuran el servicio>
Función
Detalles de implementación
Teniendo en cuenta que esta consulta tiene un
costo, Se debe consultar un repositorio propio con
la información y actualizar dicho repositorio
periódicamente
Teniendo en cuenta que esta consulta tiene un
costo, Se debe consultar un repositorio propio con
la información y actualizar dicho repositorio
periódicamente
Hay que actualizar periódicamente las listas
gratuitas
Consulta a CIFIN
Consulta datacredito
Otras listas
8.
Manejo de requerimientos no funcionales
Agrupador
Requerimiento
Invocación
Seguridad
Calidad de
Servicio
Transacciones
Derechos Reservados Jorge
Arias Consultor
Independiente
Requerimiento
Detalle del requerimiento
Tipo de
invocación
Protocolo
Autenticación
Autorización
Integridad &
No repudio
Síncrono
Privacidad
Tiempo de
respuesta
(Segs.)
Numero de
invocaciones /
segundo
Transacciones
SOAP/HTTP
Si debe usarse LDAP
Solo administrador del sistema
2 seg
0.5
Propagación de contextos
Plantilla para levantar contratos
de Servicios
Pág. 11 de 11