QueryCasesAsString

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi desde aplicaciones externas > API de Bizagi para aplicaciones externas > Servicios web disponibles > Métodos Web de QuerySOA >

QueryCasesAsString

Introducción

Este método se utiliza para obtener detalle de los casos de Procesos tanto con información de negocio como detalle general (fecha de creación, de solución, etc),  desde una aplicación externa.

A través de este método se obtienen resultados a manera de reporte apoyándose en el motor de consultas de Bizagi.

 

Este método recibe un único parámetro de entrada el cual contiene principalmente: el usuario que ejecuta la forma de consulta, criterios de filtro generales para la búsqueda (por ejemplo, rangos de fechas de creación), criterios de filtros específicos al Proceso (por ejemplo, filtros con información de negocio), y parámetros para el manejo de los resultados (cuantas ocurrencias, cómo manejar la paginación, etc).

 

note_pin

La descripción en este artículo aplica también para el método Web queryCases, el cual está disponible en la edición Bizagi .NET.

Para el método queryCases, el XML que se maneja en la solicitud (request) y en la respuesta (response) son del tipo XmlDocument (nativa de .NET).

Para el método queryCasesAsString la misma estructura de XMLs se maneja, sin embargo este parámetro es de tipo cadena (string).

 

Datos de entrada

 

Esquema de entrada

La estructura del XML que se envia a Bizagi debe ser cumplir con este XSD:

QuerySOA_input

 

 

 

Parámetros de entrada

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 los nodos "Internals" y "XPaths".

Internals: Contiene 1 o más nodos de tipo "Internal", que se utilizan para especificar los filtros relacionados a los datos de proceso (por medio de renders internos).

Internal: Especifica en su atributo "Name", el render interno. El valor del filtro va como el valor del nodo y es sensible a mayúsculas.

Los posible valores para el atributo "Name" de Internal son:

oProcessState: Permite filtrar los casos que estén abietos ("Running"), cerrados ("Completed") o que hayan sido abortados ("Aborted"). "ALL" se utliza como defecto, en cuyo caso no habría filtro para este criterio.

oRadNumber: Permite filtrar para obtener un caso específico.

oCreationDate: Permite filtrar de acuerdo a la fecha de creación del caso.

oExpiryDate: Permite filtrar de acuerdo a la fecha de vencimiento del caso.

oExpiryDays: Permite filtrar de acuerdo al número de días que quedan para el vencimiento del caso.

oUsers: Permite filtrar de acuerdo a los usuarios (especificando el UserId) que estén actualmente trabajando en los casos.

oCreatorfullname: nombre completo (fullname) del creador del caso.

oCreatorposition: posición del creador del caso.

oCreatorloginname: nombre de usuario (username) del creador del caso.

oUserfullname: nombre completo (fullname) del usuario actualmente loggeado (currentuser).

oUserposition: posición del usuario actualmente loggeado (currentuser).

oUserloginname: nombre de usuario (username) del usuario actualmente loggeado (currentuser).

oidWfClass: Permite filtrar de acuerdo al id de proceso (wfclass).

oidApplication: Permite filtrar de acuerdo al id de la aplicación Bizagi.

oidCategory: Permite filtrar de acuerdo al id de la categoría de proceso.

oidTask: Permite filtrar de acuerdo a la actividad actual.

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:

o"Include": Se puede incluir y definirse como "true" para incluir los resultados de ese atributo en la respuesta.

o"Approx": Se puede incluir y definirse como "true" para realizar una búsqueda aproximada en atributos de tipo "string" (cadenas de texto).

o"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.

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:

o"idEnt": Un parámetro obligatorio. Indica el ID de la Entidad.

o"PageSize": define el número de registros que componen cada página de la ejecución)

o"pag": define un número de página específico que contiene los casos

o"Culture": define la cultura global para el soporte multi-lenguage de los resultados( por ejemplo: "en-Us", "es-Es").

o"searchAllUsers" (para .NET): Aunque es opcional se recomienda su uso. Permite valores de true o false, para sobreescribir la definición de la propiedad para buscar para todos los usuarios de la misma forma d consulta (Search all users). Cuando este valor no es especificado, (y tampoco se invoca a la forma de consulta por su id interno), entonces se traen los casos que corresponden al usuario especificado en el XML.

 

 

Ejemplo

Con el siguiente ejemplo, se invoca una forma de consulta, donde queremos los registros que:

 

Estén en un estatus pendiente (Running).

Tengan una fecha de creación (atributo OpeningDate) que sea posterior a Noviembre 1 de 2011.

 

QuerySOA_example_input_2

 

Datos de salida

 

Esquema de salida

La estructura del XML que se retorna en Bizagi cumple con este XSD:

QuerySOA_output

 

 

Parámetros de salida

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".

CaseTable: Contiene 1 ocurrencia del nodo "Columns", y ocurrencias indefinidas del nodo "Rows" (una ocurrencia para cada registro resultado).

Los siguientes subnodos se incluyen en este nodo:

oRADNUMBER: Número (cadena) de radicación.

oBAWORKFLOWPATH: Path del proceso.

oWFCLSDISPLAYNAME: El nombre para mostrar del proceso.

oCASCREATIONDATE: Fecha de creación del caso.

oCASSOLUCIONDATE: Fecha de solución del caso.

oIDWFCLASS: Id del proceso.

oIDCASE: Número de creación del caso.

oIDCASESTATE: El estado del caso manejado por Bizagi. Los siguientes código de estados son válidos: Iniciado "Initiated" (1), "Ejecutándose" Running (2), Suspendido "Suspended" (3), Abortado "Aborted" (4), Cerrado "Completed" (5), No-iniciado "NotInitiated" (6), Cancelado por evento de compensación "CancelledByCompensation" (7), Cancelado por excepción "CancelledByException" (8).

TaskTable: Contiene 1 ocurrencia del nodo "Columns", y ocurrencias indefinidas del nodo "Rows" (una para cada actividad).

Los siguiente subnodos se incluyen en este nodo: TaskState: Estado actual de la actividad. CurrentTask: El nombre para mostrar de la actividad. wiEstimatedSolutionDate: Fecha de solución estimada para la actividad. idTaskType: Tipo de actividad. idTask: Id de la actividad. idWorkItem: Id del workitem. idCase: Número de caso relacionado a esa instancia de actividad.

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

Con el siguiente ejemplo, se ilustra la respuesta que retorna la invocación de este método en Bizagi;

QuerySOA_example_output_2

 

 

Métodos Web relacionados

Si no requiere obtener información de negocio de los casos consultados, use los métodos getCasesAsString o getCases de los servicios Web de WorkflowEngineSOA.

Para más información sobre esta opción, consulte WorkflowEngineSOA.

 

Si desea obtener más información específica de un solo caso, use los métodos getCaseDataUsingSchemaAsString o getCaseDataUsingXPathsAsString de los servicios Web de EntityManagerSOA.

Para más información sobre esta opción, consulte EntityManagerSOA.