CL.COMMON 1.0.10

Acerca de CL.COMMON

Ofrece una serie de funciones a modo de utilería las cuales nos permiten realizar flujos que son habituales en todos los proyectos, como mapeo de genéricos, logs entre otros.

¿Qué resuelve?

La creación repetitiva de código de uso común a través de los distintos proyectos de los clientes y que a su vez en cada implementación presentan la posibilidad de no replicar el código con exactitud generando errores.

Rutinas de Core

GetConfigKeyValue:System.Data.String

• System.Reflection.MethodBase _invoker:Usado para determinar que función ha llamado este método
• System.String _configKey: Nombre de la llave en el config

Usado para acceder a configuraciones del web.config.

Ejemplo:

// Obtiene la llave del Web.config llamanda 'spGetNameDbObjectApp'
System.String valor = CL.COMMON.Core.GetConfigKeyValue(System.Reflection.MethodBase.GetCurrentMethod(), "spGetNameDbObjectApp");

FileToBase64:System.String

• System.String _filePath: Ruta física del archivo

Usado para convertir un archivo en base64

Ejemplo:

// Convirtiendo un archivo a base64 System.String base64pdf = CL.COMMON.Core.FileToBase64("C:\mipdf.pdf");

GetExceptionMessage:System.String

• System.Exception _exception: Objeto con la excepción a mapear

Obiene el detalle de la excepción y la retorna en un System.String.

Ejemplo:

// Mapeando la excepcion a un System.String
System.String message = CL.COMMON.Core.GetExceptionMessage(exception)

InflateObject:T

T:new(): Objeto que va a ser llenado con el System.Data.DataTable

• System.Data.DataTable _dt: Origen de datos que van a ser cargados en T

Los registros de un query cargados en System.Data.DataTable serán cargados en el objeto de tipo T.

Ejemplo:

// Obtiene el modelo retornado por el datable
T oT = CL.COMMON.Core.InflateObject<T>(oDataTable);

InflateList:System.Collections.Generic.List<T>

T:new(): Objeto que va a ser llenado con el System.Data.DataTable

• System.Data.DataTable _dt: Origen de datos que van a ser cargados en T

Los registros de un query serán mapeados a una lista de tipo T.

Ejemplo:

// Convirtiendo los registros de un datable a una lista de tipo T.
System.Collections.Generic.List<T> tList = CL.COMMON.Core.InflateList<T>(oDataTable);

ParametersBuilder:System.Collections.Generic.List<System.String>

T:new(): Objeto que va a ser mapeado a un query.

U:CL.STRUCTURES.INTERFACES.ICLMaster: I

• System.String _invoker: Usado para determinar que métod ha invocado es función y podar dar el error respectivo en caso de...
• T _object: Objeto del cual se van a mapear las propieadas a una lista.
• System.String[] _toIgnore: Lista de propiedades a incluir/excluir según el tipo de inteface que indiquemos.

Convierte las propieades de un objeto a una lista de string.

// Convirtiendo las propiedades de un objeto a una lista.
System.String[] properties = CL.COMMON.Core.ParametersBuilder<T, V>(System.Reflection.MethodBase.GetCurrentMethod().Name, _object, _toIgnore)

Rutinas de LogManager

Esta funcionalidad requiere de ciertas configuraciones iniciales, como por ejemplo agregar una llave en el web.config con el nombre LogPath, para poder obtener la ruta donde se van a escribir los logs. De manera opcional se puede escoger el intervalo de generación de archivos, por defecto es diario. Puede ser cambiado agregando la propiedad SeriLogRollingInterval en en el webconfig. Posibles valores(Infinite, Year, Month, Day, Hour, Minute).

Todas las sobrecargas del método Commit intentan sacar el usuario del contexto del pipe, accediendo a un Claim llamado 'UserEmail', el cual puede ser configurado al momento de iniciar sesión en la la aplicación. En caso de no suministrar un usuario el valor por defecto de este será 'no_user_found'.

Además permite registrar encabezados de la petición, para esto es requerido que los mismos encabezados tengan el prefijo 'Cl-' para que sean reconocidos por log manager. Ejemplo: Para indicar el momento en el que salió una petición desde el ui, agregar un encabezado a la petición en el interceptor con el nombre 'Cl-Ui-Request-Time'.

Glosario

Para mantener el orden y simetría en los logs se han definido una serie de abreviaciones para estos.

• USR: Usuario al que se le relaciona con los logs(miusuario@correo.com)

• PTH: Dirección física del endpoint(/api/Item/GetItemInfo)

• QRS: Query string de la dirección física del endpoint(?param1=ejemplo&param2=1234)

• VRB: Verbo http de la petición(GET, POST, ...)

• MDL: Modelo contenido en la petición que solo es visible en operaciones de escritura ({"prop1": "value"}).

• AYV: Versión del emsamblado de Log Manager.

Enter:void

Agrega un enter los logs almacenados hasta el momento.

Ejemplo:

// Dando un enter
CL.COMMON.LogManager.Enter();

Record:void

• System.String _message: Mensage que será escrito un medio externo.

Agrega un mensaje al contexto actual del log al final de este.

Ejemplo:

// Agregando un mensaje de prueba
CL.COMMON.LogManger.Record("Hola Sap B1");

Record:void

• System.String _message: Mensage que será escrito un medio externo.
• CL.STRUCTURES.TabLevel: Indica si el mensaje recién registrado va a tener un margen izquierdo(Cantidad de tabs).

Agrega un mensaje al contexto actual del log al final de este con N tabs de desplazamiento.

Ejemplo:

// Agregando un mensaje de prueba con un nivel de tab
CL.COMMON.LogManger.Record("Hola Sap B1", CL.STRUCTURES.TabLevel.One);

Commit:void

• System.Net.Http.HttpRequestMessage _httpRequestMessage: Contexto actual de la petición.
• System.String _user: Usuario al que se le asignaran los logs.

En caso de no suministrar un usuario al método este intentará buscarlo en un Claim llamado 'UserEmail' y en caso final de no encontrarlo, este asignará el valor de 'no_user_found' al usuario que registrará el log.

Ejemplo

// Registrando un evento suministrando un usuario.
CL.COMMON.LogManager.Commit(Request, "eaguilar@clavisco.com");
// Registrando un evento en el que log manager intentará obtener el usuario del claim.
CL.COMMON.LogManager.Commit(Request);

Commit:void

• System.String _fileName: Tipo de operación que nos encontramos realizando.
• System.String _user: Usuario al que se le asignaran los logs.

Este método es exclusivo para escenarios en donde no tenemos un contexto web claro, por ejemplo en un servicio en donde solo necesitamos registrar nuestros eventos y asignarlos al servicio. Por este motivo es requerido pasar estos parámetros de forma manual.

Ejemplo

// Registrando un evento suministrando un usuario.
CL.COMMON.LogManager.Commit("ORDR", "usuario\servicio");

Código completo de implementación

Este código debe ponerse en el controlador o en el llamado de un servicio para que se haga el commit al final del proceso. Y ya luego el método CL.COMMON.LogManger.Record puede ser llamando en la capa que ocupemos para poder registrar nuestros eventos.

try {
CL.COMMON.LogManager.Record("Controlador iniciado");
CLContext<Document> oCLContext = PROCESS.Process.CreateDocument(document);
CL.COMMON.LogManager.Record("Controlador terminado");
return CL.COMMON.Core.ContextBroker(oCLContext);
}
catch(System.Exception exception) {
return CL.COMMON.Core.ContextBroker(ex);
}
finally {
CL.COMMON.LogManager.Commit(Request, document); }

Clavis Consultores ©