¡Esta es una revisión vieja del documento!
Este es el log utilizado para registrar los logs en las transacciones de modificación de información de los procesos de las aplicaciones.
A continuación se listan los tipos de transacciones que deben ser considerados en el log.
Este servicio debe consumirse en los procesos de cargas de:
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 | SICOF | TABLE | TRANSACTIONAL_LOG | COMMENTS | Contiene el log de transacciones de las aplicaciones de la compañia |
---|---|---|---|---|---|
# | NAME | NULLEABLE | TYPE | COMMENTS | WS1) |
1 | ID | N | NUMBER | Código interno del registro (Se controla por secuencia) | Interno, Autoincremental |
2 | FECHA | Y | DATE | Fecha en la cuál se genera la transacción | No utilizado |
3 | NOMBRE_PROCESO | Y | VARCHAR2(256) | Nombre del proceso que realiza la transacción | Externo, Requerido |
4 | TIPO_TRANSACCION | Y | VARCHAR2(256) | Identifica el tipo de operación (Insert, Select, Update, Delete, Execute) | Externo, Requerido |
5 | LOG_TABLA | Y | VARCHAR2(256) | Nombre de la Tabla | Externo, Requerido |
6 | LOG_COLUMNA | Y | VARCHAR2(256) | Nombre de la columna | Obsoleto, Externo |
7 | LOG_VALOR_ANT | Y | VARCHAR2(4000) | Valor anterior de la columna | Obsoleto, Externo, Requerido |
8 | LOG_VALOR_ACT | Y | VARCHAR2(4000) | Valor actual de la columna | Obsoleto, Externo |
9 | LOG_PETICION | Y | CLOB | Se utiliza en caso de ser necesario para almacenar el bloque de la petición completa realizada | Externo, Requerido |
10 | LOGIN_USUARIO | Y | VARCHAR2(256) | Login del usuario que realiza el proceso | Externo, Requerido |
11 | HOST_CLIENTE | Y | VARCHAR2(50) | Host del cliente (Dirección IP) | Externo, Requerido |
12 | FECHA_REGISTRO | Y | DATE | Fecha del sistema DB | Interno, Formato dd/mm/yyyy hh:mm:ss, Requerido |
13 | CODIGO_USUARIO | Y | NUMBER | Código del usuario de la sesión en la cuál se genera el error | Externo, Requerido |
14 | CODIGO_MEMPRESA | Y | VARCHAR2(64) | Código de la empresa de la sesión en la cuál se genera el error | Externo, Requerido |
15 | CODIGO_APLICACION | Y | NUMBER | Código de la aplicación (Identificador interno numérico) | Externo, Requerido |
16 | INFO_APP | Y | VARCHAR2(256) | Información de la aplicación (En las situaciónes donde no se identifique código interno se puede enviar el nombre de la aplicación o información adicional) | Externo |
17 | SESSION_MAC | Y | VARCHAR2(64) | MAC del equipo del usuario | Externo |
18 | SESSION_BROWSERVERSION | Y | VARCHAR2(64) | Versión del Navegador | Externo, Requerido |
19 | SESSION_OSTYPE | Y | VARCHAR2(64) | Sistema Operativo | Externo, Requerido |
Se adiciona esta columna para identificar reglas asociadas a la implementación de los servicios web que permiten gestionar el almacenamiento de los logs. La columna es una referencia y no hace parte del servicio sin embargo las reglas que se definen en ella si aplican para la columna relacionada:
Esta columna sirve para almacenar la información de la peticion2) que se realiza en el registro que va a la base de datos. Se define la siguiente estructura base ejemplo:
{ "columns":[ { "column_name":"Requerido: Nombre de la columna", "column_old_value": "Valor anterior de la columna", "column_new_value": "Valor actual de la columna" } ] }
Donde:
Ejemplo:
{ "columns":[ { "column_name":"codigo_tercero", "column_old_value": "1234", "column_new_value": "3456" }, { "column_name":"valor_debito", "column_old_value": "0", "column_new_value": "100000" } ] }
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 de los logs es la librería sf00util.pbl
Los Objetos relacionados en el API son:
Para facilitar la implementación y uso del API de gestión de log de transacciones se crea un objeto interno privado en la clase global guo_app el cual puede ser accedido por el método of_log_transactional() que devuelve la instancia del objeto. Sin embargo para implementaciones específicas se puede optar por crear y administrar la clase n_cst_log_transactional 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_log_transactional( ).of_add_log(f_hoy(), "Causación por Plantilla", "Update", "PRESUP01.MAESTRO_ASIENTO_CONTABLE", "codigo_tercero", "0", "6949", true, SQLCA) guo_app.of_log_transactional( ).of_add_log(f_hoy(), "Causación por Plantilla", "Update", "PRESUP01.MAESTRO_ASIENTO_CONTABLE", ljson, true, SQLCA) /*Ejemplo de uso definiendo la clase*/ n_cst_log_transactional luo_log_transactional luo_log_transactional = Create n_cst_log_transactional luo_log_transactional.of_add_log(f_hoy(), "Causación por Plantilla", "Update", "PRESUP01.MAESTRO_ASIENTO_CONTABLE", ljson, true, SQLCA) destroy luo_log_transactional
Se adicionan métodos de procesamiento de bloques en formato json los cuales pueden ser utilizados para registrar trazas de error a continuación se muestran ejemplos de uso del API.
sailjson ljson, ljson1 String ls_content ljson = create sailjson ljson.setattribute( 'version', '1001') //add json object ljson1 = ljson.addobject( 'header') ljson1.setattribute( 'count', 3) ljson1.setattribute( 'comment', 'items count') //add json object array, first item ljson1 = ljson.addarrayitem( 'data') ljson1.setattribute( 'colid', 1) ljson1.setattribute( 'colname', 'aaaaaa') ljson1.setattribute( 'coladdr', '') //add second item of the array ljson1 = ljson.addarrayitem( 'data') ljson1.setattribute( 'colid', 2) ljson1.setattribute( 'colname', 'bbbbbbbb') setnull(ls) ljson1.setattribute( 'coladdr', ls) //add third item of the array ljson1 = ljson.addarrayitem( 'data') ljson1.setattribute( 'colid', 3) ljson1.setattribute( 'colname', 'cccccc') ljson.setattribute( 'creattime', string(now(), 'yyyymmdd.hhmmss')) ls_content = ljson.getformatjson('' ) destroy ljson
/*Ejemplo de Uso del API con el Log de Cargas*/ sailjson ljson, ljson1, ljson2 ljson = create sailjson //add json object array, first item ljson1 = ljson.addarrayitem('columns') ljson1.setattribute( 'column_name', 'codigo_tercero') ljson1.setattribute( 'column_old_value', '0') ljson1.setattribute( 'column_new_value', '1234') //add second item of the array ljson1 = ljson.addarrayitem( 'columns') ljson1.setattribute( 'column_name', 'valor_debito') ljson1.setattribute( 'column_old_value', '0') ljson1.setattribute( 'column_new_value', '100000') //Consumir Log de Cargas con traza en formato json guo_app.of_log_transactional( ).of_add_log(f_hoy(), "Causación por Plantilla", "Update", "PRESUP01.DET_ASIENTO_CONTABLE", ljson, true, SQLCA)
Para las aplicaciones desarrolladas en las tecnologías (Web):
el log de sesión será implementado por medio de un Servicio Web el cual deberá considerar las reglas de Columna: WS