Wiki

Has cargado una revisión vieja del documento! Si la guardas crearás una versión nueva con estos datos.

====== Fábrica - Modelos Logs - Log de Registro de Errores ======
Este es el log utilizado para registrar los errores generados en los procesos de las aplicaciones de la compañia.

===== ¿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

==== 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 [[#Modo de uso: Powerbuilder - Documentación|API]] para realizar las llamadas.

==== Columna: WS  ====
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:

=== Reglas ===

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

=== Nota ===
  * 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.

==== Columna: ERROR_LOG ====
Esta columna sirve para almacenar información extra del error generado((Trazas)) que se generar en los procesos. Se define la siguiente estructura base ejemplo:

<code yaml>
{
  "errors":[
    {
      "error_code":"Requerido: Número del error o nombre de la excepción",
      "error_description": "Requerido: Descripción técnica del error",
      "error_tracer": "Pila de mensajes capturada en el error"
      "error_line": "Linea del proceso donde se genera el error"
      "error_method": "Método donde se genera el error"
    }
  ]
}
</code>

Donde:

* **errors**: Array de errores en el proceso
  * **error_code**: Propiedad contenida en cada indice del array json. Representa el código del error, alguna aplicaciones pueden represnetar este código como un número o como nombre de excepción.
  * **error_description**: Propiedad contenida en cada indice del array json. Representa el mensaje técnico del error generado.
  * **error_tracer**: Propiedad contenida en cada indice del array json. Representa la traza del error generado.
  * **error_line**: Propiedad contenida en cada indice del array json. Representa la linea donde se ha generado el  error.
  * **error_method**: Propiedad contenida en cada indice del array json. Representa el método donde se ha generado el error.

Ejemplo:

<code yaml>
{
  "errors":[
    {
      "error_code":"2501",
      "error_description": "Error actualizando saldos de rubros.",
      "error_tracer": "ORA-0001 PK Constrainst Invalid"
      "error_line": "25"
      "error_method": "of_calcular_saldos"
    },
    {
      "error_code":"java.lang.NullPointerException",
      "error_description": "Error actualizando saldos de rubros.",
      "error_tracer": "Exception in thread main java.lang.NullPointerException
    at Printer.printString(Printer.java:13)
    at Printer.print(Printer.java:9)
    at Printer.main(Printer.java:19)"
      "error_line": "23"
      "error_method": "of_calcular_saldos"
    }
  ]
}
</code>

=== Notas ===
  * Los valores de las columnas deben ser registrados como String

==== Modo de uso: Powerbuilder - Documentación ====
Para visualizar la documentación debe descargar el siguiente repositorio [[http://adacsc.co:1443/svn/repository/ADA/SICOF/Objetos%20SICOF/FUENTES/branches/branches%2012.5.2.5.0/doc/documentacion|Documentación]], abrir la pagina Index.html en su navegador web la cual es similar a la siguiente imagen:

{{ :ada:howto:sicoferp:factory:logmodels:pbdoc_objetos_sicof.png?600 |}}

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_errores**: Clase para la gestión de errores

=== Ejemplos de Uso ===
Para facilitar la implementación y uso del API de gestión de errores se crea un objeto interno privado en la clase global **guo_app** el cual puede ser accedido por el método **of_log_error()** que devuelve la instancia del objeto. Sin embargo para implementaciones específicas se puede optar por crear y administrar la clase de error **n_cst_log_error** 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.

<code java>
/*Ejemplos de uso utilizando la instancia genérica de la clase guo_app*/
guo_app.of_log_error( ).of_add_log("EJEMPLO_CODE", 10, true, SQLCA)
guo_app.of_log_error( ).of_add_log("EJEMPLO_CODE", "ERROR_DB", true, SQLCA)
guo_app.of_log_error( ).of_add_log("EJEMPLO_CODE", 10, ls_args, true, SQLCA)
guo_app.of_log_error( ).of_add_log_text("Ejemplo", "ERROR_DB", "Presupuesto", true, SQLCA)
guo_app.of_log_error( ).of_add_log_text( sqldbcode, sqlerrtext, dataobject, sqlsyntax, ls_ventana, true, lts_db)

/*Ejemplo de uso definiendo la clase de error, 
instancia el array de formateo de mensaje y 
registra en el log el mensaje formateado. 
Posteriormente elimina la instancia de la clase de gestión de error.
"El array de formateo se utiliza cuando el mensaje se genera por expresiones: 
Ejemplo:
Mensaje Base = Hola #1 (identificado con el código de mensaje SALUDO_CODE), 
se crea un array con un expresión de la siguiente forma 
array[1] = "Mundo", 
de esta forma al usar el método of_add_log se genera el mensaje: Hola Mundo".
*/
n_cst_log_error luo_log_error
String ls_args[]
ls_args[1] = "Mundo"
luo_log_error = Create n_cst_log_error
luo_log_error.of_add_log("SALUDO_CODE", 10, ls_args, true, SQLCA)
destroy luo_log_error

/*Ejemplo de uso definiendo la clase de error y 
registra en el log el mensaje por medio de un código de mensaje. 
Posteriormente elimina la instancia de la clase de gestión de error.*/
n_cst_log_error luo_log_error
luo_log_error = Create n_cst_log_error
luo_log_error.of_add_log("EJEMPLO_CODE", 10, true, SQLCA)
destroy luo_log_error

/*Ejemplo de uso definiendo la clase de error y 
registra en el log el mensaje por medio de un código de mensaje. 
Posteriormente elimina la instancia de la clase de gestión de error.*/
n_cst_log_error luo_log_error
luo_log_error = Create n_cst_log_error
luo_log_error.of_add_log("EJEMPLO_CODE", "ERROR_DB", true, SQLCA)
destroy luo_log_error
</code>

== Consideraciones ==
  * El API puede ser activada o desactivada por medio de la constante: **LOG_ERRORS** (Solo en aplicaciones SICOF ERP (Appeon/Powerbuilder)).
  * El desarrollador es el encargado de gestionar la transacción que realiza la persistencia.
  * Se automatiza el registro de errores en los objetos **uo_datawindow** y **uo_datastore** en toda su herencia.
  * Se automatiza el registro de errores genéricos no controlados lanzados por el evento **systemerror** de Powerbuilder.
  * Para el procesamiento de logs de bloques se implementa Clase sailjson para procesamiento de cadenas de texto en ese formato.

== API Json ==
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.

<code java>
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
</code>

<code java>
/*Ejemplo de Uso del API con el Log de Errores*/
sailjson ljson, ljson1 
ljson = create sailjson
//add json object array, first item
ljson1 = ljson.addarrayitem( 'errors')
ljson1.setattribute( 'error_code', '-1')
ljson1.setattribute( 'error_description', 'Error actualizando base de datos')
ljson1.setattribute( 'error_line', '100')
ljson1.setattribute( 'error_method', 'SystemError')
ljson1.setattribute( 'error_tracer', '')
//add second item of the array
ljson1 = ljson.addarrayitem( 'errors')
ljson1.setattribute( 'error_code', '-10')
ljson1.setattribute( 'error_description', 'Error general del sistema')
ljson1.setattribute( 'error_line', '101')
ljson1.setattribute( 'error_method', 'SystemError')
ljson1.setattribute( 'error_tracer', 'SystemOutMemoryError')
guo_app.of_log_error( ).of_add_log("EJEMPLO_CODE", 10, lson, true, SQLCA)
</code>

==== Modo de uso: Java ====
Para las aplicaciones desarrolladas en las tecnologías (Web):

* Java 
  * .Net
  * PHP

el log de sesión será implementado por medio de un [[http://10.1.20.89/doku.php?id=ada:howto:sicoferp:factory:integrations:logs|Servicio Web]] el cual deberá considerar las reglas de [[#Columna: WS|Columna: WS]]

[[ada:howto:sicoferp:factory:logmodels|←Volver atras]]

Resumen de la edición

Wiki

Herramientas de usuario

Herramientas del sitio

Herramientas de la página