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.

• 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.

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

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

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)

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.

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 segun el tipo de mensaje:

Si un mensaje debe mostrar más información respecto a la situación notificada se debe utilizar esta columna. Sin embargo debe tener presente la siguientes indicaciones:

• Si el mensaje requiere gestión de un proceso esta columna se debe describir con una serie de pasos de las acciones a realizar.
• Si el mensaje indica una situación puntual esta columna debe indicar la razon de la situación presentada e indicar al usuario la acción a seguir.
• La información debe ser clara y evitar ambiguedades.
• Se Debe utilizar un lenguaje acorde al usuario.

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

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

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

Debe empezar con el identificador “SICOF” en mayúsculas seguido por el número de la aplicación de la tabla SICOF.MAE_APLICACIONES columna CODIGO¹⁾, no debe tener espacios ni separadores al comienzo e intermedio del texto y debe finalizar con el separador _ Ejemplos:

El nombre del código del error debe ser un resumen del mensaje que se adiciona al identificador, este (si aplica) solo puede llevar el separador _ y se deben evitar los caraceres especiales y tildes. Tener en cuenta las siguientes consideraciones:

• Nombre nemotécnico²⁾ del error³⁾.
• Resumen del error⁴⁾.
• Palabras clave del error⁵⁾.

Para el mensaje “No existe el tercero con el nit.” se crearía el CODIGO de la siguiente forma:

• Identificador: SICOF000_ Ya que es una funcionalidad transversal.
• Nombre: TERCERO_NOT_FOUND⁶⁾

Mensaje: No existe el tercero con el nit. Código de Error: SICOF000_TERCERO_NOT_FOUND

--==============================================================================
-- Fecha: 10:03 a. m. lunes, 30 de agosto de 2021 - carlos.torres@ada.co
-- Crear Mensaje de Error 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', 'SICOF000_TERCERO_NOT_FOUND', 
    'Validación del Tercero');
COMMIT;

Para visualizar la documentación debe descargar el siguiente repositorio Documentación, abrir la pagina Index.html en su navegador web la cual es similar a la siguiente imagen:

En ella encontrará la documentación de las librerias que hacen parte del framework Objetos SICOF el cuál se irá actualizando frecuentmente a medida que se documenten las clases.

La Libreria que contiene la funcionalidad del API de mensajes es la librería sf00util.pbl

Los Objetos relacionados en el API son:

• n_cst_app: Clase contenedora del API de mensajes
• n_cst_msg: Clase utilizada para la gestion de los mensajes que se visualizan en las aplicaciones.

Para facilitar la implementación y uso del API de gestión de mensajes se crea un objeto interno privado en la clase global guo_app el cual puede ser accedido por el método of_msg() que devuelve la instancia del objeto. Sin embargo para implementaciones específicas se puede optar por crear y administrar la clase de mensajes n_cst_msg según considere el desarrollador.

A continuación se listan ejemplos de uso el cuál presenta las forma de utilizar el API, para más información debe consultar la documentación en el repositorio.

/*Ejemplos de uso utilizando la instancia genérica de la clase guo_app*/
guo_app.of_msg( ).of_msg_advertencia("Esto es una Advertencia.")
guo_app.of_msg( ).of_msg_informacion("Esto es una Información.")
guo_app.of_msg( ).of_msg_error("Esto es un Error.")
 
/*Ejemplo de uso utilizando el API de mensajes*/
guo_app.of_msg( ).of_mensajes_sistema(10)
guo_app.of_msg( ).of_mensajes_sistema(10, "Error al insert el encabezado")
guo_app.of_msg( ).of_mensajes_sistema('SICOF000_TERCERO_NOT_FOUND')
 
/*Ejemplo de uso definiendo la clase de mensaje.*/
n_cst_msg luo_msg
luo_msg = Create n_cst_msg
luo_msg.of_msg_advertencia("Esto es una Advertencia.")
luo_msg.of_msg_informacion("Esto es una Información.")
luo_msg.of_msg_error("Esto es un Error.")
luo_msg.of_mensajes_sistema(10)
luo_msg.of_mensajes_sistema(10, "Error al insert el encabezado")
luo_msg.of_mensajes_sistema('SICOF000_TERCERO_NOT_FOUND')
destroy luo_msg

• El API puede ser activada o desactivada por medio de la constante: API_MESSAGE (Solo en aplicaciones SICOF ERP (Appeon/Powerbuilder)) siempre y cuando se utilice la implementación de la clase guo_app.
• El desarrollador es el encargado de gestionar la transacción que realiza las consultas e inicialización del objeto.
• Se unifica el desarrollo para que la función global f_mensajes_sistema tome los nuevos cambios sin afectar su definición.
• Cada módulo (Contabilidad, Prespuesto, Tesorería, Compras, Talento y Nómina) debe implementar el método de inicialización guo_app.of_init_logs(SQLCA) en el método of_process_step_init_transaction de la clase guo_app especializada por cada módulo. A continuación se muestra una imagen de referencia de la implementación del módulo de presupuesto. Utilice esta guía para implementaciones en otros módulos teniendo presente que la clase n_cst_app se especializa con el nombre de la aplicación que la contiene. Ejemplo: en presupuesto la clase especializada es n_cst_app_presupuesto, por lo general la clase esta en la libreria principal que contiene el objeto Application.

Para las aplicaciones desarrolladas en las tecnologías (Web):

• Java
• .Net
• PHP

el log de sesión será implementado por medio de un Servicio Web el cual deberá considerar las reglas de Columna: WS

←Volver atras