Configurar qué información de negocio se retorna

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Bizagi Studio > Bizagi desde aplicaciones externas > API de Bizagi para aplicaciones externas > Servicios OData > Conceptos básicos >

Configurar qué información de negocio se retorna

Introducción

Cuando se invocan los servicios OData, específicamente aquellos que traen información de los Servicios de datos, es posible elegir cuáles atributos se retornan.

Esta configuración es totalmente opcional y aplica para:

1. Invocaciones sobre Mis Cosas.

2. Invocaciones sobre Búsquedas.

3. Invocaciones sobre datos de los procesos (casos).

 

Por defecto, los atributos que se retornan son aquellos que se han configurado en la plantilla que muestra la información de una entidad por defecto.

Se puede sobrescribir esta definición, al configurar para cada entidad la información que estará disponible para las invocaciones OData.

 

Cambiar la definición de la plantilla

Para cambiar la información que es retornada, cree una plantilla de tipo Contenido (Content) para dicha entidad, o modifique la que ya pueda existir (es decir, si dicha entidad ya tiene una configurada).

 

Configurar los atributos expuestos

Para llevar acabo una configuración explícita que sobrescriba la definición de la plantilla, ubique la entidad que tiene la información que quiere incluir o excluir explícitamente.

Diríjase a la Vista de Experto y en el módulo de Entidades, haga clic derecho sobre la entidad elegida.

Seleccione la opción Atributos expuestos por OData:

 

OData_Studio1

 

En la ventana emergente, haga clic sobre Personalizar para cambiar la definición de los atributos que se retornarán para que no todos sean considerados.

 

OData_Studio2

 

Desmarque los atributos en el panel de la izquierda para que no sean retornados por los servicios OData:

 

OData_Studio3

 

Note que el panel de la derecha mostrará automáticamente la Datos Seleccionados y los atributos elegidos.

De manera similar podrá marcar otros atributos que desee incluir.

Haga clic sobre Ok cuando haya terminado.

 

Referencias enlazadas (para entidades y colecciones)

Cuando un item del modelo de datos muestra otros items a su interior (sub-items), significa que dicho item principal es un atributo relacionado que apunta a otra entidad.

 

Considere que los atributos de tipo colección no se muestran por este editor con sus sub-items sino que se muestran como si fuesen de algún tipo de dato simple.

Las colecciones se muestran con el siguiente ícono representándolas: OData_EditorIconColl.

 

Por lo tanto y si usted marca la casilla de un item sin expandirse, entonces todos sus sub-items quedarán sin marcarse y únicamente el item actual quedará seleccionado (como una referencia enlazada):

 

OData_Studio7

 

Lo cuál podrá confirmar cuando expanda el item (observando que los sub-items quedan sin marcarse):

 

OData_Studio7

 

Al realizar lo anterior, está implícitamente definiendo que desea incluir información de una entidad relacionada como un enlace a la misma; de manera que pueda navegar al interior del detalle a través de siguientes invocaciones de OData.

Este concepto se presenta como navegaciones (Navigations).

 

Algo totalmente diferente sucede si marca el item cuando este se encuentre expandido, donde notará que sus sub-items se tornan elegibles para ser marcados e incluidos (se marcan de manera automáticamente por defecto):

 

OData_Studio9

 

Cuando se incluye algún sub-item explícitamente como se muestra en la imagen anterior, entonces usted no utilizará el concepto de navigations y tal detalle de la entidad referenciada se obtendrá desde la misma invocación del servicio OData (no se necesitarán invocaciones adicionales).

Las colecciones por ejemplo, usan siempre el tratamiento de navigations, dado que siempre se retornan como entidades enlazadas (no permiten escoger sub-items).

La siguiente imagen muestra como se enseña MedicalEquipment, que es de tipo colección:

 

OData_Studio10

 

Para mayor detalle sobre cómo tratar este concepto de navigations, y las invocaciones a entidades enlazadas, consulte Navegando hacia información enlazada.

 

Ejemplo

El siguiente ejemplo muestra como esta configuración se puede aplicar en la búsqueda de las características del Diseño de Experiencia.

Una búsqueda llamada Search Requests está configurada para basarse en la entidad SimplePurchaseRequest larga como se muestra a continuación:

 

OData_Studio6

 

Por lo tanto, para reducir y especificar exactamente cuáles partes de información de negocio se retornan cuando se busca información sobre la entidad SimplePurchaseRequest, se puede hacer uso de la opción Atributos expuestos por OData.

En este caso, los atributos han sido personalizados para la búsqueda anterior, como se muestra en Studio:

 

OData_Studio4

 

Cuando se invoca la búsqueda Search Requests, note que los atributos a ser retornados coinciden con el grupo personalizado anteriormente:

 

OData_Studio5