CL.SL 1.0.4

Acerca de CL.SL

Conjunto de funcionalidades que nos permiten conectarnos a service layer e interactuar con los distintos procesos que este nos ofrece.

¿Qué resuelve?

La gestión de las configuraciones requeridas para poder interactuar con SAP a traves de service layer.

A su vez nos brinda una serie de extensiones para faciliar el control de operaciones post, patch y get.

Rutinas de extensión

* Consultas con service layer

Permite consumir una vista expuesta de service layer. Obtiene todos los registros sin aplicar ningún filtro.

* Detalles de implementación

Extiende a: CL.STRUCTURES.CLASSES.PresentationEntities.ClUserContext

Función: Get : CL.STRUCTURES.CLASSES.ServiceLayer.SLRequestObject

* Ejemplo:

// La función ConfigurarContexto conecta a la base de datos y obtiene licencia, series, entre otros. Crear su propia función que realice este proceso.
ClUserContext oClUserContext = FuncionQueConfiguraObjeto(); // En la siguiente línea podemos ver como la extensión nos devuelve el objeto configurado // Importante tomar en cuenta que el objeto oClUserContext debe tener completa la variable Resource con el nombre de la vista de sap
SLRequestObject oSLRequestObject = oClUserContext.Get();
<a href="#send-sigle-object">¿Y ahora cómo envió mi objeto recién configurado a service layer?</a>

* Consultas con service layer

Permite consumir vistas usando un modelo para mapearlo hacia ciertos filtros en el query string.

* Detalles de implementación

Extiende a: CL.STRUCTURES.CLASSES.PresentationEntities.ClUserContext

Función: Get : CL.STRUCTURES.CLASSES.ServiceLayer.SLRequestObject

Parámetros:

- TObject _target(Opcional): Objecto que va a ser reemplazado en el query string. Si no se pasa este objeto el mapeador va a buscar en el diccionario de items de la sessión algún objeto expuesto mediante CL.COMMON.ActionFilters.QueryStringExposer

* Ejemplo:

// La función ConfigurarContexto conecta a la base de datos y obtiene licencia, series, entre otros. Crear su propia función que realice este proceso.
ClUserContext oClUserContext = FuncionQueConfiguraObjeto(); // En la siguiente línea podemos ver como la extensión nos devuelve el objeto configurado // Importante tomar en cuenta que el objeto oClUserContext debe tener completa la variable Resource con el nombre de la vista de sap
SLRequestObject oSLRequestObject = oClUserContext.Get();
<a href="#send-sigle-object">¿Y ahora cómo envió mi objeto recién configurado a service layer?</a>

* Consultas paginadas con service layer

Nos permite realizar consultas a vistas expuestas de service layer implementando un mecanismo de paginación integrado con service layer

* Detalles de implementación

* Configuración inicial

- En nuestro WebApi.Config antes de habilitar el cors en la línea "config.EnableCors(corsAttr);" tenemos que llamar a "corsAttr.ClHeadersSetter();". Esto con la idea de poder exponer los encabezados que nos brindan el contexto sobre el estado de la paginación.

- Es requerido que en cada endpoint que represente nuestra consulta agregar la anotación [EnablePagination]

- Se deben agregar los siguientes encabezados: cl-sl-pagination-page: (número de página), cl-sl-pagination-page-size: (tamaño de la página)

* En la respuesta de la petición se retorna una serie de encebezados que contienen los datos respectivos a la paginación solicitada.

Extiende a: CL.STRUCTURES.CLASSES.PresentationEntities.ClUserContext

Función: Get : CL.STRUCTURES.CLASSES.ServiceLayer.SLRequestObject

Parámetros:

- TObject _target(Opcional): Objecto que va a ser reemplazado en el query string. Si no se pasa este objeto el mapeador va a buscar en el diccionario de items de la sessión algún objeto expuesto mediante CL.COMMON.ActionFilters.QueryStringExposer

* Ejemplo:

// La función ConfigurarContexto conecta a la base de datos y obtiene licencia, series, entre otros. Crear su propia función que realice este proceso.
ClUserContext oClUserContext = FuncionQueConfiguraObjeto(); // En la siguiente línea podemos ver como la extensión nos devuelve el objeto configurado // Importante tomar en cuenta que el objeto oClUserContext debe tener completa la variable Resource con el nombre de la vista de sap
SLRequestObject oSLRequestObject = oClUserContext.Get();
<a href="#send-sigle-object">¿Y ahora cómo envió mi objeto recién configurado a service layer?</a>

* Crear con service layer

Para poder crear objetos con service layer es requerido configurar el contexto. Dicho contexto es el que contiene toda la información necesaria para conectarnos con service layer, especificar el objeto que ocupamos crear y tipo de operación a realizar con service layer.

Esta función nos termina devolviendo un objeto configurado listo para ser procesado.

* Detalles de implementación

Extiende a: CL.STRUCTURES.CLASSES.PresentationEntities.ClUserContext

Función: Post : CL.STRUCTURES.CLASSES.ServiceLayer.SLRequestObject

Parámetros:

- TObject _target: Objeto que va a ser creado en sap.

- System.String _fieldsToRemoveInHeaders(Opcional): Nombres de las propiedades que serán eliminadas de la cabecera de TObject separadas por comas. Ejemplo: "DocEntry,DocNum".

- System.String _fieldsToRemoveInLines(Opcional):Nombres de las propiedades que serán eliminadas de las líneas de TObject separadas por comas. Ejemplo: "LineNum,U_Udf". NOTA: El mapeador va a buscar una propiedad que se llama DocumentLines para realizar el proceso de eliminación de propieades

Ejemplo:

// La función ConfigurarContexto conecta a la base de datos y obtiene licencia, series, entre otros. Crear su propia función que realice este proceso.
ClUserContext oClUserContext = FuncionQueConfiguraObjeto(); // En la siguiente línea podemos ver como la extensión nos devuelve el objeto configurado
SLRequestObject oSLRequestObject = oClUserContext.Post(oInvoice,_fieldsToRemoveInHeaders: "DocEntry,DocNum");
<a href="#send-sigle-object">¿Y ahora cómo envió mi objeto recién configurado a service layer?</a>

* Actualizar con service layer

Para poder actualizar objetos con service layer es requerido configurar el contexto. Dicho contexto es el que contiene toda la información necesaria para conectarnos con service layer, especificar el objeto que ocupamos actualizar y tipo de operación a realizar con service layer.

Esta función nos termina devolviendo un objeto configurado listo para ser procesado.

* Detalles de implementación

Extiende a: CL.STRUCTURES.CLASSES.PresentationEntities.ClUserContext

Función: Patch : CL.STRUCTURES.CLASSES.ServiceLayer.SLRequestObject

Parámetros:

- TObject _target: Objeto que va a ser actualizado en sap.

- System.String _fieldsToRemoveInHeaders(Opcional): Nombres de las propiedades que serán eliminadas de la cabecera de TObject separadas por comas. Ejemplo: "DocEntry,DocNum".

- System.String _fieldsToRemoveInLines(Opcional):Nombres de las propiedades que serán eliminadas de las líneas de TObject separadas por comas. Ejemplo: "LineNum,U_Udf". NOTA: El mapeador va a buscar una propiedad que se llama DocumentLines para realizar el proceso de eliminación de propieades

* Ejemplo:

// La función ConfigurarContexto conecta a la base de datos y obtiene licencia, series, entre otros. Crear su propia función que realice este proceso.
ClUserContext oClUserContext = FuncionQueConfiguraObjeto(); // En la siguiente línea podemos ver como la extensión nos devuelve el objeto configurado
SLRequestObject oSLRequestObject = oClUserContext.Patch<Invoice>();
<a href="#send-sigle-object">¿Y ahora cómo envió mi objeto recién configurado a service layer?</a>

* Enviar transacciones a service layer

Permite enviar un transacción de tipo GET, POST, PATCH

a service layer retornándonos un objeto de tipo T.

* Detalles de implementación

Extiende a: CL.STRUCTURES.CLASSES.ServiceLayer.SLRequestObject

Función: SendAsync : System.Threading.Tasks.Task<CL.STRUCTURES.CLASSES.Rebound.CLContext<T>>

* Ejemplo:

// El siguente metodo hace una consulta hacia sap mediante service layer SLRequestObject oSLRequestObject = FuncionQueConfiguraObjeto();
// Este método debe estar en el Process
// El generic que se le da el metodo es para indicar el eventual objeto que nos puede devolver sap
return await oSLRequestObject.SendAsync<Document>();
<a href="#send-sigle-object">¿Y ahora cómo envió mi objeto recién configurado a service layer?</a>

<div id="send-sigle-object" class="bar"> * Enviar transacciones a service layer

Permite enviar un transacción de tipo GET, POST, PATCH, a service layer retornándonos una lista de objetos de tipo T.

* Detalles de implementación

Extiende a: CL.STRUCTURES.CLASSES.ServiceLayer.SLRequestObject

Función: SendAsync : System.Threading.Tasks.Task<CL.STRUCTURES.CLASSES.Rebound.CLContextVSystem.Collections.Generics.ListVTVV

* Ejemplo:

// El siguente método hace una consulta hacia sap mediante service layer SLRequestObject oSLRequestObject = FuncionQueConfiguraObjeto();
// Este método debe estar en el Process
// El generic que se le da el método es para indicar el eventual objeto que nos puede devolver sap
return await oSLRequestObject.SendAsyncVListVDocumentVV();</div>

Clavis Consultores ©