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.

===== Diccionario de Datos =====
^OWNER |SICOF ^TABLE |MOV_LOG_ERRORES ^COMMENTS |Contiene el registro de errores genrados en los procesos de las aplicaciones SICOF |
^# ^NAME ^NULLEABLE ^TYPE ^COMMENTS ^^  
|1|CODIGO_INTERNO|N|NUMBER(38,0)|Identificador interno del registro (autoincrementado por secuencia)||
|2|COD_ORA_ERROR|Y|NUMBER|Código del error (Puede usuarse para errores del manejador de base de datos pero el campo es multiproposito)||
|3|MSJ_ORA_ERROR|Y|VARCHAR2(1024)|Mensaje simple del error (Resumen)||
|4|NOM_PROCEDIMIENTO|Y|VARCHAR2(128)|Nombre del método, procedimiento, claseo contexto de ejecución local donde se genera el error||
|5|FECHA|Y|DATE|Fecha en la cuál se genera el error||
|6|USUARIO_BD|Y|VARCHAR2(32)|Usuario de conexión de la base de datos||
|7|OBSERVACION|Y|VARCHAR2(2048)|Mensaje extendido del error (Detalle)||
|8|HOST_CLIENTE|Y|VARCHAR2(50)|Host del cliente (Dirección IP)|
|9|FECHA_REGISTRO|Y|DATE|Fecha del sistema DB||
|10|CODIGO_USUARIO|Y|NUMBER|Código del usuario de la sesión en la cuál se genera el error||
|11|CODIGO_MEMPRESA|Y|VARCHAR2(64)|Código de la empresa de la sesión en la cuál se genera el error||
|12|CODIGO_APLICACION|Y|NUMBER|Código de la aplicación (Identificador interno numérico)||
|13|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)||
|14|SESSION_MAC|Y|VARCHAR2(64)|MAC del equipo del usuario||
|15|SESSION_BROWSERVERSION|Y|VARCHAR2(64)|Versión del Navegador||
|16|SESSION_OSTYPE|Y|VARCHAR2(64)|Sistema Operativo||
|17|ERROR_LOG|Y|CLOB|Utilizada solo para casos especiales donde sea necesaria registrar información amplia del error||
|18|ERROR_TYPE|Y|VARCHAR2(64)|Tipo del error (LEVE, MODERADO, CRITICO por defecto)||

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

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", 10, true, SQLCA)
guo_app.of_log_error( ).of_add_log("Ejemplo", "ERROR_DB", true, SQLCA)
guo_app.of_log_error( ).of_add_log("Ejemplo", 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, 
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] = "Expresión 1"
luo_log_error = Create n_cst_log_error
luo_log_error.of_add_log("Ejemplo Hola #1", 10, ls_args, true, SQLCA)
destroy luo_log_error

/*Ejemplo de uso definiendo la clase de error y 
registra en el log el 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", 10, true, SQLCA)
destroy luo_log_error

/*Ejemplo de uso definiendo la clase de error y 
registra en el log el 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", "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.

==== Modo de uso: Java (Próximamente) ====
Para las aplicaciones desarrolladas en la tecnología Java el log de sesión será implementado por medio de un servicio web.

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

Resumen de la edición

Wiki

Herramientas de usuario

Herramientas del sitio

Herramientas de la página