Fábrica - Modelos Logs - Log de Cargas de Procesos (Archivos)

Este es el log utilizado para registrar las notificaciones que puedan presentar en los procesos de cargas de información.

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

• Inicio de Carga
• Fin de Carga
• Errores en las lineas procesadas
• Errores en columnas de las lineas procesadas

Este servicio debe consumirse en los procesos de cargas de:

• Aplicaciones Java
• Aplicaciones .Net
• Web Service
• Aplicaciones Móbiles
• Aplicaciones Powerbuilder (Ver Nota siguiente)
• Soluciones que afecten los productos SICOF

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.

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:

• Interno: Indica que el campo se gestiona dentro del servicio y por lo tanto no se pedira en los parametros.
• Autoincremental: Indica que el campo se comporta como una secuencia.
• Externo: Indica que el campo debe estar en los parametros del consumo.
• Requerido: Indica que el campo debe ser enviado en el consumo y el servicio debe validarlo para continuar.
• Obsoleto: Indica que el campo ya no es utilizado en la nueva implementación.
• No utilizado: Indica que el campo no será utilizado en ninguna implementación.

• Todas las operaciones del servicio que gestiona la persistencia de la tabla deben estar documentadas incluyendo la definición de los campos, formatos, longitudes de columnas e indicar si es requerido o no.

Esta columna sirve para almacenar todas la notificaciones que se pueden presentar al procesar una linea del archivo de la carga. Se define la siguiente estructura base ejemplo:

{
  "columns":[
    {
      "column_name":"Requerido: Nombre de la columna",
      "column_value": "Requerido: Valor de la columna",
      "column_notifications":
        [
          {"msg":"Requerido: Mensaje de Notificación 1"},
          {"msg":"Requerido: Mensaje de Notificación 2"},
          {"msg":"Requerido: Mensaje de Notificación N"}
        ]
    }
  ]
}

Donde:

• columns: Arrya de Columnas del archivo de carga
• column_name: Propiedad contenida en cada indice del array json que representa el nombre de la columna analizada del proceso de carga.
• column_value: Propiedad contenida en cada indice del array json que representa el valor de la columna analizada del proceso de carga.
• column_notifications: Propiedad contenida en cada indice del array json que representa el array de notificaciones de la columna analizada del proceso de carga.
• msg: Propiedad contenida en cada indice de column_notifications de la columna analizada del proceso de carga.

Ejemplo:

{
  "columns":[
    {
      "column_name":"fecha_sistema",
      "column_value": "01/01/20",
      "column_notifications":
        [
          {"msg":"El año de la fecha es menor a la vigencia actual"},
          {"msg":"La fecha no tiene el formato dd/mm/yyyy"}
        ]
    }
  ]
}

• Los valores de las columnas deben ser registrados como String

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:

• n_cst_app: Clase contenedora de objetos logs
• n_cst_log_file_upload: Clase para la gestión de log de cargas

Para facilitar la implementación y uso del API de gestión de log de cargas se crea un objeto interno privado en la clase global guo_app el cual puede ser accedido por el método of_log_file_upload() que devuelve la instancia del objeto. Sin embargo para implementaciones específicas se puede optar por crear y administrar la clase n_cst_log_file_upload 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_file_upload( ).of_set_process_header(f_hoy(), "carga_prueba.txt", "Carga de Terceros")
guo_app.of_log_file_upload( ).of_add_log(10, "codigo_tercero", "columna nula", true, SQLCA)
guo_app.of_log_file_upload( ).of_add_log(f_hoy(), "carga_prueba.txt", "Carga de Terceros", 10, "codigo_tercero", "columna nula", true, SQLCA)
guo_app.of_log_file_upload( ).of_add_log(f_hoy(), "carga_prueba.txt", "Carga de Terceros", 10, ljson, true, SQLCA)
 
/*Ejemplo de uso definiendo la clase*/
n_cst_log_file_upload luo_log_file_upload
luo_log_file_upload= Create n_cst_log_file_upload 
luo_log_file_upload.of_add_log(f_hoy(), "carga_prueba.txt", "Carga de Terceros", 10, ljson, true, SQLCA)
destroy luo_log_file_upload

• El API puede ser activada o desactivada por medio de la constante: LOG_UPLOAD_FILE (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 la persistencia.
• Para el procesamiento de logs de bloques se implementa Clase sailjson para procesamiento de cadenas de texto en ese formato.
• Cada módulo (Contabilidad, Prespuesto, Tesorería, Compras, Talento y Nómina) debe implementar el método de inicialización 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.

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

Se identifica que actualmente la versión de Appeon (2013/2016) presenta problemas con el procesamiento del API Json para estructuras complejas como Arrays por esta razon cada procesamiento del API debe ser realizado a un solo nivel de complejidad. A continuacion se muestra un ejemplo de uso funcional en Appeon/Powerbuilder que puede ser tomado como referencia.

/*PASO 1: Definir un objeto de la clase sailjson en la zona de instancia del componente donde se va utilizar el API como una ventana, objeto no visual, etc*/
sailjson iuo_json

/*PASO 2: Incializar el objeto iuo_json antes de utilizarlo*/
iuo_json= create sailjson

/*
PASO 3: No es obligatorio, pero se recomienda crear un método local de asignación para simplificar el proceso como ejemplo se define metodo of_add_log_file_upload con los siguientes argumentos
Integer ai_indx
String as_column_name
String as_column_value
String as_column_notifications[]
*/
 
//Validaciones previas de control
if IsNull(ai_indx) then ai_indx = 0
if IsNull(as_column_name) then return
if IsNull(as_column_value) then as_column_value = ""
if IsNull(as_column_notifications) then return
if UpperBound(as_column_notifications) = 0 then return
 
//Registrar las propiedades de la notificación con el indice
iuo_json.setattribute("column" + String(ai_indx) + "_name", as_column_name)
iuo_json.setattribute("column" + String(ai_indx) + "_value", as_column_value)
 
//Registrar los mensajes de notificación con los indices
Integer li_i, li_count
String ls_msg
li_count = UpperBound(as_column_notifications)
for li_i = 1 to li_count
  ls_msg = as_column_notifications[li_i]
  iuo_json.setattribute("column" + String(ai_indx) + "_notifications" + String(li_i), ls_msg)
next

//En el metodo donde se gestionan las notificaciones se consume el API Log de Cargas con traza en formato json, se recomienda utilizar una transacción diferente a la del proceso para que se pueda almacenar la notificación
guo_app.of_log_file_upload( ).of_add_log(f_hoy(), "carga_prueba.txt", "Carga de Terceros", 10, iuo_json, true, SQLCA)
 
//Por último se debe reiniciar el componente para otro proceso
iuo_json = Create sailjson

//Invocar el método local of_add_log_file_upload 
of_add_log_file_upload (1, 'codigo_tercero', '', ls_notificaciones)

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