¡Esta es una revisión vieja del documento!
Esta sección describe el API de mensajes que debe ser utilizada en las aplicaciones de la compañia.
A continuación se listan los tipos de mensajes que deben ser considerados en el log.
Este servicio debe consumirse en las generaciones de errores de:
El API soporta las siguientes operaciones:
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.
OWNER | PRESUP01 | TABLE | MENSAJES_SISTEMA | COMMENTS | Tabla que contiene los mensajes de los procesos de SICOF |
---|---|---|---|---|---|
# | NAME | NULLEABLE | TYPE | COMMENTS | |
1 | CODIGO_MENSAJE | N | NUMBER | Código Interno del Mensaje (Es unico en la tabla y se asigna de forma manual) | |
2 | MENSAJE | Y | VARCHAR2(1024) | Descripción del mensaje que se representa puede registrar expresiones de sustitución con la regla #identificador númerico Ej Hola #1 | |
3 | INFORMATION | Y | CHAR(1) | Bandera que puede ser utilizada por el frontend: indica que el mensaje es de tipo: Información | |
4 | STOP | Y | CHAR(1) | Bandera que puede ser utilizada por el frontend: indica que el mensaje es de tipo: Error | |
5 | EXCLAMATION | Y | CHAR(1) | Bandera que puede ser utilizada por el frontend: indica que el mensaje es de tipo: Advertencia | |
6 | QUESTION | Y | CHAR(1) | Bandera que puede ser utilizada por el frontend: indica que el mensaje es de tipo: Pregunta o Interrogación | |
7 | NONE | Y | CHAR(1) | Bandera que puede ser utilizada por el frontend: indica que el mensaje no especifica su tipo: Por lo general se usa Información | |
8 | OK | Y | CHAR(1) | Bandera que puede ser utilizada por el frontend: indica que el mensaje utiliza boton: Aceptar | |
9 | CANCEL | Y | CHAR(1) | Bandera que puede ser utilizada por el frontend: indica que el mensaje utiliza boton: Cancelar | |
10 | YES | Y | CHAR(1) | Bandera que puede ser utilizada por el frontend: indica que el mensaje utiliza boton: Si | |
11 | NO | Y | CHAR(1) | Bandera que puede ser utilizada por el frontend: indica que el mensaje utiliza boton: No | |
12 | RETRY | Y | CHAR(1) | Bandera que puede ser utilizada por el frontend: indica que el mensaje utiliza boton: Reintentar | |
13 | ABORT | Y | CHAR(1) | Bandera que puede ser utilizada por el frontend: indica que el mensaje utiliza boton: Abortar | |
14 | IGNORE | Y | CHAR(1) | Bandera que puede ser utilizada por el frontend: indica que el mensaje utiliza boton: Ignorar | |
15 | DEFAULTBUTTON | Y | NUMBER(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 | |
16 | CODIGO_BASE_DATOS | Y | NUMBER(10,0) | Código interno de base de datos que está asociado al mensaje | |
17 | USUARIO_EMPRESA | Y | VARCHAR2(30) | Usuario Empresa | |
18 | CODIGO_MEMPRESA | Y | VARCHAR2(50) | Código de la emprsa por defecto '9999999999' para entorno uniempresa. | |
19 | FECHA_REGISTRO | Y | DATE | Fecha del sistema | |
20 | TIPO_PROCESO | Y | VARCHAR2(256) | Clasificación del mensaje Ej: Disponiiblidad, Compromiso etc. | |
21 | CODIGO | Y | VARCHAR2(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 | |
22 | TITULO | Y | VARCHAR2(256) | Campo que puede ser utilizada por el frontend para visualizar un titulo en el mensaje. | |
23 | OBSERVACIONES | Y | VARCHAR2(4000) | Información complementaria que orienta al usuario sobre la situación notificada en el mensaje. Puede llevar pasos, consejos o indicaciones. |
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 | |
---|---|---|---|
1 | CODIGO_MENSAJE | Requerido: 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 | |
2 | MENSAJE | Requerido: El mensaje debe claro y conciso. No debe generar ambiguedades en los usuarios y no debe estar expresado en lenguaje técnico. | |
3 | INFORMATION | Esta columna debe ser enviada con el valor 'S' si el mensaje es informativo. De lo contrario debe ser enviado en 'N' | |
4 | STOP | Esta columna debe ser enviada con el valor 'S' si el mensaje es de error. De lo contrario debe ser enviado en 'N' | |
5 | EXCLAMATION | Esta columna debe ser enviada con el valor 'S' si el mensaje es de advertencia. De lo contrario debe ser enviado en 'N' | |
6 | QUESTION | Esta columna debe ser enviada con el valor 'S' si el mensaje es de confirmación. De lo contrario debe ser enviado en 'N' | |
7 | NONE | Esta columna debe ser enviada con el valor 'S' si el mensaje no lleva ícono. De lo contrario debe ser enviado en 'N' | |
8 | OK | Esta columna debe ser enviada con el valor 'S' cuando el mensaje visualiza boton Aceptar. De lo contrario debe ser enviado en 'N' | |
9 | CANCEL | Esta columna debe ser enviada con el valor 'S' cuando el mensaje visualiza boton Cancelar. De lo contrario debe ser enviado en 'N' | |
10 | YES | Esta columna debe ser enviada con el valor 'S' cuando el mensaje visualiza boton Si. De lo contrario debe ser enviado en 'N' | |
11 | NO | Esta columna debe ser enviada con el valor 'S' cuando el mensaje visualiza boton No. De lo contrario debe ser enviado en 'N' | |
12 | RETRY | Esta columna debe ser enviada con el valor 'S' cuando el mensaje visualiza boton Reintentar. De lo contrario debe ser enviado en 'N' | |
13 | ABORT | Esta columna debe ser enviada con el valor 'S' cuando el mensaje visualiza boton Abortar. De lo contrario debe ser enviado en 'N' | |
14 | IGNORE | Esta columna debe ser enviada con el valor 'S' cuando el mensaje visualiza boton Ignorar. De lo contrario debe ser enviado en 'N' | |
15 | DEFAULTBUTTON | Esta 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. | |
16 | CODIGO_BASE_DATOS | Solo se utiliza cuando el mensaje está asociado a un Código de error de base de datos. De lo contrario se ignora esta columna. | |
17 | USUARIO_EMPRESA | Enviar 'PRESUP01' | |
18 | CODIGO_MEMPRESA | Enviar '9999999999' | |
19 | FECHA_REGISTRO | Enviar SYSDATE | |
20 | TIPO_PROCESO | Requerido: Clasificación del mensaje Ej: Disponiiblidad, Compromiso etc. | |
21 | CODIGO | Requerido: Código Texto del Mensaje Ej: TERCERO_NOT_FOUND, CDP_NO_BALANCE etc. | |
22 | TITULO | Requerido: Título del mensaje el cuál es utilizado en la barra de titulo de la ventana. | |
23 | OBSERVACIONES | Este 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. |
Esta columna debe contener el nombre de la funcionalidad a la cuál pertenece el mensaje, Ejmeplos:
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:
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ódulo | Funcionalidad | Identificador |
---|---|---|
SISTEMA DE CONTROL PRESUPUESTAL | ADMINISTRACION CONTROL PRESUPUESTAL | ADMINISTRACIONCONTROLPRESUPUESTAL_ |
SISTEMA DE CONTROL PRESUPUESTAL | ADMINISTRADOR DEL SISTEMA | ADMINISTRADORDELSISTEMA_ |
SISTEMA DE CONTROL PRESUPUESTAL | ANTICIPOS | ANTICIPOS_ |
SISTEMA DE CONTROL PRESUPUESTAL | COMPROMISOS | COMPROMISOS_ |
SISTEMA DE CONTROL PRESUPUESTAL | CONTABILIDAD | CONTABILIDAD_ |
SISTEMA DE CONTROL PRESUPUESTAL | CONTRALORIA | CONTRALORIA_ |
SISTEMA DE CONTROL PRESUPUESTAL | CUENTAS POR COBRAR | CUENTASPORCOBRAR_ |
SISTEMA DE CONTROL PRESUPUESTAL | DISPONIBILIDADES | DISPONIBILIDADES_ |
SISTEMA DE CONTROL PRESUPUESTAL | INFORMES DE CONTABILIDAD | INFORMESDECONTABILIDAD_ |
SISTEMA DE CONTROL PRESUPUESTAL | MAESTROS | MAESTROS_ |
SISTEMA DE CONTROL PRESUPUESTAL | MOVIMIENTO RUBROS | MOVIMIENTORUBROS_ |
SISTEMA DE CONTROL PRESUPUESTAL | ORDENES DE PAGO | ORDENESDEPAGO_ |
SISTEMA DE CONTROL PRESUPUESTAL | PAGOS NOMINA | PAGOSNOMINA_ |
SISTEMA DE CONTROL PRESUPUESTAL | PRESUPUESTO INGRESOS | PRESUPUESTOINGRESOS_ |
SISTEMA DE CONTROL PRESUPUESTAL | PROGRAMACION PAC | PROGRAMACIONPAC_ |
SISTEMA DE CONTROL PRESUPUESTAL | REINTEGROS | REINTEGROS_ |
SISTEMA DE CONTROL PRESUPUESTAL | REPORTES | REPORTES_ |
SISTEMA DE CONTROL PRESUPUESTAL | REPORTES CIERRE VIGENCIA | REPORTESCIERREVIGENCIA_ |
SISTEMA DE CONTROL PRESUPUESTAL | RESERVAS | RESERVAS_ |
SISTEMA DE CONTROL DE TESORERIA | ADMINISTRADOR DEL SISTEMA | ADMINISTRADORDELSISTEMA_ |
SISTEMA DE CONTROL DE TESORERIA | BANCOS | BANCOS_ |
SISTEMA DE CONTROL DE TESORERIA | CAJAS MENORES | CAJASMENORES_ |
SISTEMA DE CONTROL DE TESORERIA | COMPROBANTE DE EGRESO | COMPROBANTEDEEGRESO_ |
SISTEMA DE CONTROL DE TESORERIA | COMPROBANTE DE INGRESO | COMPROBANTEDEINGRESO_ |
SISTEMA DE CONTROL DE TESORERIA | CONCILIACION BANCARIA | CONCILIACIONBANCARIA_ |
SISTEMA DE CONTROL DE TESORERIA | DEUDA PÚBLICA | DEUDAPÚBLICA_ |
SISTEMA DE CONTROL DE TESORERIA | FONDO DE CONTINGENCIAS | FONDODECONTINGENCIAS_ |
SISTEMA DE CONTROL DE TESORERIA | INTERFACE | INTERFACE_ |
SISTEMA DE CONTROL DE TESORERIA | MAESTROS | MAESTROS_ |
SISTEMA DE CONTROL DE TESORERIA | MANTENIMIENTO P.A.C. | MANTENIMIENTOPAC_ |
SISTEMA DE CONTROL DE TESORERIA | PAGO ELECTRONICO | PAGOELECTRONICO_ |
SISTEMA DE CONTROL DE TESORERIA | REPORTES (Bancos) | REPORTESBANCOS_ |
SISTEMA DE CONTROL DE TESORERIA | REPORTES (Comprobantes de Contabilidad) | REPORTESCOMPROBANTESDECONTABILIDAD_ |
SISTEMA DE CONTROL DE TESORERIA | REPORTES ESTADISTICOS | REPORTESESTADISTICOS_ |
SISTEMA DE CONTROL DE TESORERIA | REPORTES (Pago Electronico) | REPORTESPAGOELECTRONICO_ |
SISTEMA DE CONTROL DE TESORERIA | REPORTES (Pagos y Taquillas) | REPORTESPAGOSYTAQUILLAS_ |
SISTEMA DE CONTROL DE TESORERIA | REPORTES (Plan Anual de Caja) | REPORTESPLANANUALDECAJA_ |
SISTEMA DE CONTROL DE TESORERIA | REPORTES (Rendicion de Cuentas) | REPORTESRENDICIONDECUENTAS_ |
SISTEMA DE CONTROL DE TESORERIA | REPORTES (Retencion en la Fuente) | REPORTESRETENCIONENLAFUENTE_ |
SISTEMA DE CONTROL DE CONTABLE | ADMINISTRADOR DEL SISTEMA | ADMINISTRADORDELSISTEMA_ |
SISTEMA DE CONTROL DE CONTABLE | ASIENTOS CONTABLES | ASIENTOSCONTABLES_ |
SISTEMA DE CONTROL DE CONTABLE | CONSULTAS | CONSULTAS_ |
SISTEMA DE CONTROL DE CONTABLE | DETERIORO | DETERIORO_ |
SISTEMA DE CONTROL DE CONTABLE | MAESTROS | MAESTROS_ |
SISTEMA DE CONTROL DE CONTABLE | MEDIOS MAGNETICOS DIAN | MEDIOSMAGNETICOSDIAN_ |
SISTEMA DE CONTROL DE CONTABLE | PLAN CUENTAS CONTABLES | PLANCUENTASCONTABLES_ |
SISTEMA DE CONTROL DE CONTABLE | REPORTES | REPORTES_ |
SISTEMA DE COMPRAS | ACTIVOS FIJOS | ACTIVOSFIJOS_ |
SISTEMA DE COMPRAS | ADMINISTRADOR DEL SISTEMA | ADMINISTRADORDELSISTEMA_ |
SISTEMA DE COMPRAS | COTIZACIONES | COTIZACIONES_ |
SISTEMA DE COMPRAS | INVENTARIOS | INVENTARIOS_ |
SISTEMA DE COMPRAS | MAESTROS | MAESTROS_ |
SISTEMA DE COMPRAS | REPORTES | REPORTES_ |
SISTEMA DE COMPRAS | SOLICITUD DE BIENES | SOLICITUDDEBIENES_ |
SISTEMA DE COMPRAS | SOLICITUD DE COMPRA | SOLICITUDDECOMPRA_ |
SISTEMA DE NOMINA | ADMINISTRADOR DEL SISTEMA | ADMINISTRADORDELSISTEMA_ |
SISTEMA DE NOMINA | CONFIGURACIÓN | CONFIGURACION_ |
SISTEMA DE NOMINA | INFORMES | INFORMES_ |
SISTEMA DE NOMINA | NOVEDADES | NOVEDADES_ |
SISTEMA DE NOMINA | OPERACION | OPERACION_ |
SISTEMA DE NOMINA | PAGO AUTOMATICO SIIF | PAGOAUTOMATICOSIIF_ |
SISTEMA DE NOMINA | PRESTACIONES SOCIALES | PRESTACIONESSOCIALES_ |
SISTEMA DE NOMINA | SEGURIDAD SOCIAL | SEGURIDADSOCIAL_ |
SISTEMA DE NOMINA | UTILIDADES | UTILIDADES_ |
SISTEMA DE TALENTO HUMANO | ADMINISTRADOR DEL SISTEMA | ADMINISTRADORDELSISTEMA_ |
SISTEMA DE TALENTO HUMANO | APOYO ESTUDIANTIL | APOYOESTUDIANTIL_ |
SISTEMA DE TALENTO HUMANO | APROVECHAMIENTO TIEMPO LIBRE | APROVECHAMIENTOTIEMPOLIBRE_ |
SISTEMA DE TALENTO HUMANO | BECAS | BECAS_ |
SISTEMA DE TALENTO HUMANO | CONVOCATORIAS | CONVOCATORIAS_ |
SISTEMA DE TALENTO HUMANO | CUENTAS X COBRAR | CUENTASXCOBRAR_ |
SISTEMA DE TALENTO HUMANO | DOTACION | DOTACION_ |
SISTEMA DE TALENTO HUMANO | ENCUESTAS | ENCUESTAS_ |
SISTEMA DE TALENTO HUMANO | ESTIMULO EDUCATIVO | ESTIMULOEDUCATIVO_ |
SISTEMA DE TALENTO HUMANO | EVALUACIONES | EVALUACIONES_ |
SISTEMA DE TALENTO HUMANO | EVENTOS | EVENTOS_ |
SISTEMA DE TALENTO HUMANO | FORMULARIOS | FORMULARIOS_ |
SISTEMA DE TALENTO HUMANO | HOJAS DE VIDA | HOJASDEVIDA_ |
SISTEMA DE TALENTO HUMANO | INCENTIVOS | INCENTIVOS_ |
SISTEMA DE TALENTO HUMANO | INFORMES ADICIONALES | INFORMESADICIONALES_ |
SISTEMA DE TALENTO HUMANO | MOVIMIENTO RUBROS | MOVIMIENTORUBROS_ |
SISTEMA DE TALENTO HUMANO | OTROS CREDITOS | OTROSCREDITOS_ |
SISTEMA DE TALENTO HUMANO | PROGRAMA DE VIVIENDA | PROGRAMADEVIVIENDA_ |
SISTEMA DE TALENTO HUMANO | SALUD OCUPACIONAL | SALUDOCUPACIONAL_ |
SISTEMA DE TALENTO HUMANO | SEGURIDAD Y SALUD EN EL TRABAJO | SEGURIDADYSALUDENELTRABAJO_ |
--============================================================================== -- 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', 'MAESTROTERCERO_NOT_FOUND', 'Validación del Tercero'); COMMIT;
Para las aplicaciones desarrolladas en la tecnología Java el log de sesión será implementado por medio de un servicio web.