QueryEntities
De
<keywords content="keywords"> querySOA, query SOA, queries SOA, queryEntities, query Entities, queryEntitiesAsString, SOA Layer, soa, queries, reportes, buscar registros, consultar, consulta de registros de entidad, consulta entidad, consultar entidades, consulta entidades, consultar entidad, </keywords>
Contenido |
QueryEntities
Es un método del servicio web QuerySOA web que se utiliza para ejecutar una forma de consulta de entidad de Bizagi existente.
La invocación a este método retorna los registros con su detalle tal como es posible mediante la forma de consulta a nivel de entidad que se ejecuta. Se permite filtrar los registros de acuerdo a los datos en la entidad, y también es posible manejar la paginación de los resultados (dado que la consulta puede arrojar una cantidad significativa de registros).
La información de este documento también aplica para el método QueryEntitiesAsString.
Descripción
Este método realiza la ejecución de una forma de consulta a nivel de entidad para la búsqueda de registros la entidad especificada. Este método es poderoso y muy útil para la generación de reportes via la capa SOA.
Vea mayor información sobre formas de consulta en Bizagi (reportes).
El método QueryEntities recibe y retorna un documento XML (XmlDocument), mientras que el método QueryEntitiesAsString recibe y retorna una cadena (string) cuya información viene en formato XML.
Datos de entrada (Input)
El siguiente esquema define la estructura XML que espera como dato de entrada este método:
Parámetro 1 (XmlDocument o String )
BizAgiWSParam: Es el nodo raíz que contiene toda la información para ejecutar la forma de consulta. Contiene los nodos "domain", "userName", "QueryParams", y "Parameters".
domain: Acá se especifica el dominio del usuario en Bizagi que ejecuta la consulta.
userName: El nombre de usuario que ejecuta la consulta.
QueryParams: Contiene la información para los filtros de la búsqueda al ejecutar la consulta. Contiene el nodo "XPaths".
XPaths: Contiene 1 o más nodos "XPath", que se utilizan para especificar filtros relacionados a datos de negocio.
XPath: Especifica en su atributo "Path", la ruta XPath del atributo en el modelo de datos tal como se filtra en la forma de consulta. El XPath utiliza el caracter punto (.) como separador. El valor del filtro va como "Value" del nodo y es sensible a mayúsculas. Únicamente cuando se especifique un rango de valores (para filtrar una fecha), será necesario incluír los subnodos "<From>" y/o "<To>" para que éstos contengan los valores de los límites del rango.
Otros atributos adicionales en este nodo son:
+ "Include": Se puede incluir y definirse como "true" para incluir los resultados de ese atributo en la respuesta.
+ "Approx": Se puede incluir y definirse como "true" para realizar una búsqueda aproximada en atributos de tipo "string" (cadenas de texto).
+ "Sort": Se puede incluir y definirse como "Desc" (descendiente) or "Asc" (ascendiente) para ordenar los resultados de acuerdo al valor del atributo. Cuando no se especifica esta opción, el ordenamiento de los registros por defecto tendrá en cuenta el "RadNumber" de manera ascendenete.
Tenga en cuenta que el XPath para una forma de consulta a nivel de entidad, parte de la entidad misma.
Parameters: Contiene 1 o más nodos "Parameter", que se utilizan para especificar los parámetros de la ejecución de la forma de consulta y el manejo de los resultados.
Parameter: Especifica en su atributo "Name", las diversas opciones para manejar los resultados de la forma de consulta. El valor del filtro va como "Value" del nodo y es sensible a mayúsculas.
Los posibles valores para el atributo "Name" son: "idQueryForm" (define un número que corresponde al id de la forma de consulta), "PageSize" (define el número de registros que componen cada página de la ejecución), "pag" (define un número de página específico que contiene los casos), "Culture" (define la cultura global para el soporte multi-lenguage de los resultados, por ejemplo: "en-Us").
Ejemplo
Con el siguiente XML de ejemplo, el usuario domain\admon ejecutará una forma de consulta a nivel de entidad:
Datos de salida (Output)
El siguiente esquema define la estructura XML que se retorna por este método:
La respuesta (response) incluye la información de los casos e información sobre el resultado de la consulta.
BizAgiWSResponse: Es el nodo raíz que contiene toda la información para ejecutar la forma de consulta. Contiene los nodos "Results", y "Parameters".
Results: Contiene los nodos "RowsCount", "PageCount" y "Tables" con la información de los casos.
RowsCount: Número total de registros (casos) retornados por la ejecución de la forma de consulta.
PageCount: Número total de páginas retornadas por la ejecución de la forma de consulta.
Tables: Contiene los nodos "CaseTable" y "TaskTable".
ResponseTable: Contiene 1 ocurrencia del nodo "Columns", y ocurrencias indefinidas del nodo "Rows" (una ocurrencia para cada registro resultado).
Los nodos al interior del ResponseTable tendrán la información de los atributos de la entidad de la consulta.
Parameters: Contiene 1 o más nodos "Parameter", los cuales se utilizaron como parámetros para la ejecución de la consulta.
Parameter: Especifica en su atributo "Name", las parametrizaciones usadas para el manejo de los resultados de la ejecución de la consulta.
Ejemplo
El siguiente XML, es un ejemplo de la respuesta retornada por este método. En este caso, es la respuesta de nuestro ejemplo de entrada anterior:
Artículos Relacionados
<comments />
