Herramientas de usuario

Herramientas del sitio


ada:howto:sicoferp:factory:logmodels:message

¡Esta es una revisión vieja del documento!


Fábrica - Modelos Logs - API de Mensajes

Esta sección describe el API de mensajes que debe ser utilizada en las aplicaciones de la compañia.

Tipos de Mensajes

A continuación se listan los tipos de mensajes que deben ser considerados en el log.

  • Mensajes Informativos: Utilizados para informar al cliente sobre procesos, estados, opciones, confirmaciones etc.
  • Mensajes de Advertencias: Utilizados para alertar sobre situaciones en las aplicaciones.
  • Mensajes de Errores: Utilizados para notificar errores generados en los procesos de la aplicaciones.

Que no se considera en el API

  • Textos descriptivos de procesos como (guías, tutoriales).
  • Mensajes asociados a sistemas operativos, maquinas virtuales, bases de datos o errores desconocidos.

¿Donde usar el Servicio?

Este servicio debe consumirse en las generaciones de errores de:

  • Aplicaciones Java
  • Aplicaciones .Net
  • Web Service
  • Integración Supertabla
  • Soluciones que afecten los productos SICOF

Operaciones del API

El API soporta las siguientes operaciones:

  • Consultar mensaje por código interno numérico. Columna: CODIGO_MENSAJE
  • Consultar mensaje por código externo texto. Columna CODIGO
  • Consultar mensaje formateado por código interno numérico y array de (String) literales # (Ejemplo: Mensaje = Hola #1 | Literal #1 = Mundo | Mensaje Formateado = Hola Mundo)
  • Consultar mensaje formateado por código externo texto y array de (String) literales # (Ejemplo: Mensaje = Hola #1 | Literal #1 = Mundo | Mensaje Formateado = Hola Mundo)

Nota: Aplicaciones Powerbuilder

Powerbuilder tiene restricciones para el consumo de servicios Rest por lo tanto en las aplicaciones de esta tecnología se implementará un API para realizar las llamadas.

Diccionario de Datos

OWNER PRESUP01 TABLE MENSAJES_SISTEMA COMMENTS Tabla que contiene los mensajes de los procesos de SICOF
# NAME NULLEABLE TYPE COMMENTS
1CODIGO_MENSAJENNUMBERCódigo Interno del Mensaje (Es unico en la tabla y se asigna de forma manual)
2MENSAJEYVARCHAR2(1024)Descripción del mensaje que se representa puede registrar expresiones de sustitución con la regla #identificador númerico Ej Hola #1
3INFORMATIONYCHAR(1)Bandera que puede ser utilizada por el frontend: indica que el mensaje es de tipo: Información
4STOPYCHAR(1)Bandera que puede ser utilizada por el frontend: indica que el mensaje es de tipo: Error
5EXCLAMATIONYCHAR(1)Bandera que puede ser utilizada por el frontend: indica que el mensaje es de tipo: Advertencia
6QUESTIONYCHAR(1)Bandera que puede ser utilizada por el frontend: indica que el mensaje es de tipo: Pregunta o Interrogación
7NONEYCHAR(1)Bandera que puede ser utilizada por el frontend: indica que el mensaje no especifica su tipo: Por lo general se usa Información
8OKYCHAR(1)Bandera que puede ser utilizada por el frontend: indica que el mensaje utiliza boton: Aceptar
9CANCELYCHAR(1)Bandera que puede ser utilizada por el frontend: indica que el mensaje utiliza boton: Cancelar
10YESYCHAR(1)Bandera que puede ser utilizada por el frontend: indica que el mensaje utiliza boton: Si
11NOYCHAR(1)Bandera que puede ser utilizada por el frontend: indica que el mensaje utiliza boton: No
12RETRYYCHAR(1)Bandera que puede ser utilizada por el frontend: indica que el mensaje utiliza boton: Reintentar
13ABORTYCHAR(1)Bandera que puede ser utilizada por el frontend: indica que el mensaje utiliza boton: Abortar
14IGNOREYCHAR(1)Bandera que puede ser utilizada por el frontend: indica que el mensaje utiliza boton: Ignorar
15DEFAULTBUTTONYNUMBER(1,0)Bandera que puede ser utilizada por el frontend: indica que el mensaje utiliza un boton por defecto (con foco) es un identificador numérico que se representa de izuiqerda a derecha
16CODIGO_BASE_DATOSYNUMBER(10,0)Código interno de base de datos que está asociado al mensaje
17USUARIO_EMPRESAYVARCHAR2(30)Usuario Empresa
18CODIGO_MEMPRESAYVARCHAR2(50)Código de la emprsa por defecto '9999999999' para entorno uniempresa.
19FECHA_REGISTROYDATEFecha del sistema
20TIPO_PROCESOYVARCHAR2(256)Clasificación del mensaje Ej: Disponiiblidad, Compromiso etc.
21CODIGOYVARCHAR2(128)Es un identificador string unico que puede ser utilizado para identificar el mensaje por lo general inicial con una sigla nemotecnica asociada a la clasificación (TIPO_PROCESO) EJ: Para Disponibilidad seria CDP00001
22TITULOYVARCHAR2(256)Campo que puede ser utilizada por el frontend para visualizar un titulo en el mensaje.
23OBSERVACIONESYVARCHAR2(4000)Información complementaria que orienta al usuario sobre la situación notificada en el mensaje. Puede llevar pasos, consejos o indicaciones.

Modo de uso: Java (Próximamente)

Para las aplicaciones desarrolladas en la tecnología Java el log de sesión será implementado por medio de un servicio web.

←Volver atras

ada/howto/sicoferp/factory/logmodels/message.1630331935.txt.gz · Última modificación: 2021/08/30 13:58 por administraidor