Toda la información de producto en wiki.bizagi.com aplica para Bizagi BPM Suite 9.1.X.
Para las nuevas versiones de Bizagi BPM Suite (10.X y superior) visite la Guía de Usuario.
 

GetCaseDataUsingXPaths

De

<keywords content="keywords">getCaseDataUsingXPaths, getCaseDataUsingXPathsAsString, get Case Data Using XPaths,capa SOA, EntityManagerSOA, Entity Manager SOA</keywords> 

Contenido

getCaseDataUsingXPaths

Este es un nuevo método del servicio web EntityManagerSOA. Se utiliza para buscar información de un caso en Bizagi recibiendo como parámetros el número de identificación del caso y el XPath o XPaths que contienen la información requerida. Este artículo también aplica para el método getCaseDataUsingXPathsAsString.

Descripción

Este método recibe un XML con formato XmlDocument (.NET) con la información requerida para identificar el caso junto con los XPaths de la información que será retornada. También hay un método que recibe el mismo XML pero con formato string, este método se llama getCaseDataUsingXPathsAsString.

Datos de Entrada

Este es el esquema del XML esperado:



Nodo CaseInfo

IdCase: Número de identificación Interna (id en la base de datos) del caso en Bizagi.

CaseNumber: Número de caso o número de creación del caso. Si se utiliza el IdCase, este no será necesario.

TaskName: Este elemento debe ser utilizado en conjunto con el IdCase o el número del caso (CaseNumber). Cuando se incluye en la consulta, la infomación retornada será la información guardada en una tarea en curso (únicamente para actividades manuales o eventos intermedios disponibles), der lo contrario, se retorna únicamente la información existente en la base de datos.

IdTask: Es posible utilizar el número de identificación interno de la Actividad (en la base de datos) en lugar del nombre de la Tarea.

IdWorkItem: Otra forma de obtener la información de una tarea específica en el caso es enviando el número de identificación del workitem (la tabla WORKITEM almacena la información sobre las tareas en curso y ejecutadas para cada caso). Si se envía este elemento, entonces es necesario llenar el nombre de la tarea o el id, y no el id del caso (idCase) o el número de creación. Es importante que el id que se envía sea el de un workitem que se encuentre abierto, no el de uno que ya haya sido ejecutado.

Por lo tanto, en este nodo, las únicas posibilidades son:

- Llenar únicamente el IdCase (la respuesta incluiría  solamente información de las tareas terminadas).

- Llenar el número del caso, en inglés CaseNumber (la respuesta incluiría solamente información de las tareas terminadas).

- Llenar el IdCase o el número del caso junto con el Nombre de la tarea (TaskName) o el IdTask.  (La respuesta incluiría información de las tareas activas).

- Llenar únicamente el IdWorkItem (La respuesta incluiría información de las tareas activas).

Nodos XPath 

XPath: Incluya este elemento para cada XPath en la consulta. Este elemento tiene a su vez un atributo llamado XPath. El valor de este atributo será el XPath de Bizagi  solicitado.

Ejemplo

Para un proceso con este modelo de datos:



Se utiliza el siguiente XML para consultar la información del caso número 8451 en la tarea 180. La información solicitada es BuroScore, BuroFile, DocumentNumber y DocsDelivieryDate de la Entidad Applicant; así como todos los solicitantes (relacionados al caso) y el Número de Documento (DocumentNumber) de los solicitantes con BuroScore menor de 100 de la Entidad Request.


Caracteres especiales en un Special XML

En la imagen previa, es posible ver un elemento con un filtro (BuroScore &lt; 100). En este filtro es necesario usar el caracter <, pero este es un caracter especial en XML y debe ser usado en formato XML (&lt;). A continuación encontrará una tabla con los caracteres especiales equivalentes en XML.

Caracter

Formato XML

Descripción

"

&quot;

Doble comilla 

'

&apos;

Apóstrofe o comilla simple

&

&amp;

Ampersand

<

&lt;

Menor que 

>

&gt;

Mayor que 

Parámetros de Salida

Este es el esquema del XML de respuesta:



Para cada XPath consultado, habrá un elemento XPath junto con su contenido. Es posible que el XPath retorne mas de un elemento, como archivos y colecciones. En este caso se añade un sub-elemento llamado Items (tradúcción a ingles de elementos). Para una Colección, cada elemento dentro de items tendrá un atributo XML llamado id mientras no se especifique ningún atributo en el momento de invocar el servicio. Este id corresponde a la llave almacenada en la base de datos.

Ejemplo

Para el ejemplo encontrado previamente en esta página, donde se provee el XML de entrada, la respuesta es:


Notas

  • Los XPaths usan un punto (.) como separador.
  • Los nombres de los elementos y atributos XML, así como los XPaths de Bizagi, son sensibles a las mayúsculas (case-sensitive).
  • Los valores de tipo String son incluídos en una sección CDATA, esto se da porque es posible que la cadena contenga caracteres especiales XML tales como ampersand (&), menor que (<), mayor que (>), apostrofe (') o doble comilla (").
  • Los archivos se incluyen en la respuesta XML como una secuencia de Bytes de Base 64.
  • Las Fechas se incluyen con el formato utilizado en XML, e.g. 2010-03-16T00:00:00.
  • Si un XPath en el XML de envío tiene un error, entonces, en la respuesta, en lugar de tener un elemento XPath para este XPath, habrá un elemento de Error con el código y mensaje correspondientes al mismo.

<comments />