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.

Proceso de Creación de Mensajes

Todos los mensajes utilizados en las aplicaciones deben ser registrados en esta tabla. A continuación se describen los campos que deben ser incluidos en la creación:

# Campo Observación
1CODIGO_MENSAJERequerido: Se debe enviar el siguiente numero disponible en la columna. Puede utilizar la siguiente sentencia para asegurar la condición requerida: SELECT NVL(MAX(CODIGO_MENSAJE), 0) + 1 FROM PRESUP01.MENSAJES_SISTEMA
2MENSAJERequerido: El mensaje debe claro y conciso. No debe generar ambiguedades en los usuarios y no debe estar expresado en lenguaje técnico.
3INFORMATIONEsta columna debe ser enviada con el valor 'S' si el mensaje es informativo. De lo contrario debe ser enviado en 'N'
4STOPEsta columna debe ser enviada con el valor 'S' si el mensaje es de error. De lo contrario debe ser enviado en 'N'
5EXCLAMATIONEsta columna debe ser enviada con el valor 'S' si el mensaje es de advertencia. De lo contrario debe ser enviado en 'N'
6QUESTIONEsta columna debe ser enviada con el valor 'S' si el mensaje es de confirmación. De lo contrario debe ser enviado en 'N'
7NONEEsta columna debe ser enviada con el valor 'S' si el mensaje no lleva ícono. De lo contrario debe ser enviado en 'N'
8OKEsta columna debe ser enviada con el valor 'S' cuando el mensaje visualiza boton Aceptar. De lo contrario debe ser enviado en 'N'
9CANCELEsta columna debe ser enviada con el valor 'S' cuando el mensaje visualiza boton Cancelar. De lo contrario debe ser enviado en 'N'
10YESEsta columna debe ser enviada con el valor 'S' cuando el mensaje visualiza boton Si. De lo contrario debe ser enviado en 'N'
11NOEsta columna debe ser enviada con el valor 'S' cuando el mensaje visualiza boton No. De lo contrario debe ser enviado en 'N'
12RETRYEsta columna debe ser enviada con el valor 'S' cuando el mensaje visualiza boton Reintentar. De lo contrario debe ser enviado en 'N'
13ABORTEsta columna debe ser enviada con el valor 'S' cuando el mensaje visualiza boton Abortar. De lo contrario debe ser enviado en 'N'
14IGNOREEsta columna debe ser enviada con el valor 'S' cuando el mensaje visualiza boton Ignorar. De lo contrario debe ser enviado en 'N'
15DEFAULTBUTTONEsta columna debe ser enviada con uno de los siguientes valores [1, 2, 3] cuando el mensaje visualiza el foco en uno de los botones utilizados. De lo contrario se ignora esta columna.
16CODIGO_BASE_DATOSSolo se utiliza cuando el mensaje está asociado a un Código de error de base de datos. De lo contrario se ignora esta columna.
17USUARIO_EMPRESAEnviar 'PRESUP01'
18CODIGO_MEMPRESAEnviar '9999999999'
19FECHA_REGISTROEnviar SYSDATE
20TIPO_PROCESORequerido: Clasificación del mensaje Ej: Disponiiblidad, Compromiso etc.
21CODIGORequerido: Código Texto del Mensaje Ej: TERCERO_NOT_FOUND, CDP_NO_BALANCE etc.
22TITULORequerido: Título del mensaje el cuál es utilizado en la barra de titulo de la ventana.
23OBSERVACIONESEste campo solo es requerido cuando el mensaje requiere gestión y debe presentar información complementaria que oriente al usuario sobre la situación notificada en el mensaje. Puede llevar pasos, consejos o indicaciones. De lo contrario se ignora esta columna.

Reglas para la columna: TIPO_PROCESO

Esta columna debe contener el nombre de la funcionalidad a la cuál pertenece el mensaje, Ejmeplos:

  • Disponibilidad
  • Compromisos
  • Pago Automático
  • Centros de Costos
  • Cuentas por Cobrar

Reglas para la columna: CODIGO

Esta columna representa un código en texto del mensaje. Tener presenta las siguientes consideraciones para la generación de los código externos de los mensajes:

Regla Identificador

Debe empezar con el identificador del proceso o entidad que representa en mayúsculas, no debe tener espacios ni separadores al comienzo e intermedio del texto y debe finalizar co el separador _ Ejemplos:

MóduloFuncionalidadIdentificador
SISTEMA DE CONTROL PRESUPUESTALADMINISTRACION CONTROL PRESUPUESTALADMINPRESUP_
SISTEMA DE CONTROL PRESUPUESTALADMINISTRADOR DEL SISTEMAADMINSYSPRESUP_
SISTEMA DE CONTROL PRESUPUESTALANTICIPOSANTICIPOS_
SISTEMA DE CONTROL PRESUPUESTALCOMPROMISOSRP_
SISTEMA DE CONTROL PRESUPUESTALCONTABILIDADCONTA_
SISTEMA DE CONTROL PRESUPUESTALCONTRALORIACONTRA_
SISTEMA DE CONTROL PRESUPUESTALCUENTAS POR COBRARCXC_
SISTEMA DE CONTROL PRESUPUESTALDISPONIBILIDADESCDP_
SISTEMA DE CONTROL PRESUPUESTALINFORMES DE CONTABILIDADREPORTCONTA_
SISTEMA DE CONTROL PRESUPUESTALMAESTROSMAEPRESUP_
SISTEMA DE CONTROL PRESUPUESTALMOVIMIENTO RUBROSMOVRUBROS_
SISTEMA DE CONTROL PRESUPUESTALORDENES DE PAGOOP_
SISTEMA DE CONTROL PRESUPUESTALPAGOS NOMINAPAGONOM_
SISTEMA DE CONTROL PRESUPUESTALPRESUPUESTO INGRESOSPRESUPING_
SISTEMA DE CONTROL PRESUPUESTALPROGRAMACION PACPAC_
SISTEMA DE CONTROL PRESUPUESTALREINTEGROSREINTE_
SISTEMA DE CONTROL PRESUPUESTALREPORTESREPORT_
SISTEMA DE CONTROL PRESUPUESTALREPORTES CIERRE VIGENCIAREPORTCIERREVIG_
SISTEMA DE CONTROL PRESUPUESTALRESERVASRESER_
SISTEMA DE CONTROL DE TESORERIAADMINISTRADOR DEL SISTEMAADMINSYSTESORE
SISTEMA DE CONTROL DE TESORERIABANCOSBANK_
SISTEMA DE CONTROL DE TESORERIACAJAS MENORESCAJAMEN_
SISTEMA DE CONTROL DE TESORERIACOMPROBANTE DE EGRESOCE_
SISTEMA DE CONTROL DE TESORERIACOMPROBANTE DE INGRESOCI_
SISTEMA DE CONTROL DE TESORERIACONCILIACION BANCARIACONCIBANC_
SISTEMA DE CONTROL DE TESORERIADEUDA PÚBLICADEUDAPUB_
SISTEMA DE CONTROL DE TESORERIAFONDO DE CONTINGENCIASFONDOCONTING_
SISTEMA DE CONTROL DE TESORERIAINTERFACESUPERTABLA_
SISTEMA DE CONTROL DE TESORERIAMAESTROSMAETESORE_
SISTEMA DE CONTROL DE TESORERIAMANTENIMIENTO P.A.C.ADMINPAC_
SISTEMA DE CONTROL DE TESORERIAPAGO ELECTRONICOPAGOELEC_
SISTEMA DE CONTROL DE TESORERIAREPORTES (Bancos)REPORTBANK_
SISTEMA DE CONTROL DE TESORERIAREPORTES (Comprobantes de Contabilidad)REPORTCOMPTTESORE_
SISTEMA DE CONTROL DE TESORERIAREPORTES ESTADISTICOSREPORTESTATESORE_
SISTEMA DE CONTROL DE TESORERIAREPORTES (Pago Electronico)REPORTPAGOELECT_
SISTEMA DE CONTROL DE TESORERIAREPORTES (Pagos y Taquillas)REPORTPAGOTAQUI_
SISTEMA DE CONTROL DE TESORERIAREPORTES (Plan Anual de Caja)REPORTPAC_
SISTEMA DE CONTROL DE TESORERIAREPORTES (Rendicion de Cuentas)REPROTRENDCUENT_
SISTEMA DE CONTROL DE TESORERIAREPORTES (Retencion en la Fuente)REPORTRTEFTE_
SISTEMA DE CONTROL DE CONTABLEADMINISTRADOR DEL SISTEMAADMINCONTA_
SISTEMA DE CONTROL DE CONTABLEASIENTOS CONTABLESASIENTOS_
SISTEMA DE CONTROL DE CONTABLECONSULTASCONSULTCONTA_
SISTEMA DE CONTROL DE CONTABLEDETERIORODETERIOR_
SISTEMA DE CONTROL DE CONTABLEMAESTROSMAECONTA_
SISTEMA DE CONTROL DE CONTABLEMEDIOS MAGNETICOS DIANMEDIOSMAGDIAN_
SISTEMA DE CONTROL DE CONTABLEPLAN CUENTAS CONTABLESPUC_
SISTEMA DE CONTROL DE CONTABLEREPORTESREPORTCONTA_
SISTEMA DE COMPRASACTIVOS FIJOSACTIVOSFI_
SISTEMA DE COMPRASADMINISTRADOR DEL SISTEMAADMINCOMPRAS
SISTEMA DE COMPRASCOTIZACIONESCOTIZA_
SISTEMA DE COMPRASINVENTARIOSINVENTA_
SISTEMA DE COMPRASMAESTROSMAECOMPRAS_
SISTEMA DE COMPRASREPORTESREPORTCOMPRAS_
SISTEMA DE COMPRASSOLICITUD DE BIENESSOLICBIEN_
SISTEMA DE COMPRASSOLICITUD DE COMPRACOLICCOMP_
SISTEMA DE NOMINAADMINISTRADOR DEL SISTEMAADMINNOM_
SISTEMA DE NOMINACONFIGURACIÓNCONFIGNOM_
SISTEMA DE NOMINAINFORMESINFONOM_
SISTEMA DE NOMINANOVEDADESNOVEDA_
SISTEMA DE NOMINAOPERACIONOPERACI_
SISTEMA DE NOMINAPAGO AUTOMATICO SIIFPAGOSIIF_
SISTEMA DE NOMINAPRESTACIONES SOCIALESPRESTASOCIA_
SISTEMA DE NOMINASEGURIDAD SOCIALSEGURSOCIAL_
SISTEMA DE NOMINAUTILIDADESUTILINOM_
SISTEMA DE TALENTO HUMANOADMINISTRADOR DEL SISTEMAADMINTALE_
SISTEMA DE TALENTO HUMANOAPOYO ESTUDIANTILAPOYOESTUD_
SISTEMA DE TALENTO HUMANOAPROVECHAMIENTO TIEMPO LIBREAPROVTIEMLIBR_
SISTEMA DE TALENTO HUMANOBECASBECAS_
SISTEMA DE TALENTO HUMANOCONVOCATORIASCONVOCATIAS_
SISTEMA DE TALENTO HUMANOCUENTAS X COBRARCXCTALEN_
SISTEMA DE TALENTO HUMANODOTACIONDOTACION_
SISTEMA DE TALENTO HUMANOENCUESTAS
SISTEMA DE TALENTO HUMANOESTIMULO EDUCATIVO
SISTEMA DE TALENTO HUMANOEVALUACIONES
SISTEMA DE TALENTO HUMANOEVENTOS
SISTEMA DE TALENTO HUMANOFORMULARIOS
SISTEMA DE TALENTO HUMANOHOJAS DE VIDA
SISTEMA DE TALENTO HUMANOINCENTIVOS
SISTEMA DE TALENTO HUMANOINFORMES ADICIONALES
SISTEMA DE TALENTO HUMANOMOVIMIENTO RUBROS
SISTEMA DE TALENTO HUMANOOTROS CREDITOS
SISTEMA DE TALENTO HUMANOPROGRAMA DE VIVIENDA
SISTEMA DE TALENTO HUMANOSALUD OCUPACIONAL
SISTEMA DE TALENTO HUMANOSEGURIDAD Y SALUD EN EL TRABAJO

Ejemplo Script de Inserción

--==============================================================================
-- Fecha: 10:03 a. m. lunes, 30 de agosto de 2021 - carlos.torres@ada.co
-- Crear Mensaje para validar existencia del tercero.
--==============================================================================
INSERT INTO PRESUP01.MENSAJES_SISTEMA
   (CODIGO_MENSAJE, MENSAJE, INFORMATION, STOP, EXCLAMATION, 
    QUESTION, NONE, OK, CANCEL, YES, 
    NO, RETRY, ABORT, IGNORE, DEFAULTBUTTON, 
    CODIGO_MEMPRESA, FECHA_REGISTRO, TIPO_PROCESO, CODIGO, 
    TITULO)
 VALUES
   ((SELECT NVL(MAX(CODIGO_MENSAJE), 0) + 1 FROM  PRESUP01.MENSAJES_SISTEMA), 'No existe información del tercero con el Nit #1', 'N', 'S', 'N', 
    'N', 'N', 'S', 'N', 'N', 
    'N', 'N', 'N', 'N', 1, 
    '9999999999', SYSDATE, 'Tercero', 'TERCERO_NOT_FOUND', 
    'Validación del Tercero');
COMMIT;

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.1630347014.txt.gz · Última modificación: 2021/08/30 18:10 por administraidor