De

<keywords content="keywords">getCases, getCasesAsString, obtener Casos,capa SOA, WorkflowEngineSOA, Workflow Engine SOA</keywords> 

getCases

Método del servicio web WorkflowEngineSOA, utilizado para consultar los casos pendientes en un proyecto Bizagi desde una aplicación externa. Este artículo aplica también para el método getCasesAsString.

Descripción

Este método recibe un XML con varios filtros que será utilizado para obtener únicamente los casos que cumplan con los criterios de búsqueda. El método getCases recibe y retorna un XmlDocument mientras que getCasesAsString recibe y retorna un XML con formato string.

Parámetros de Entrada 

El XML esperado debe cumplir con el siguiente esquema XSD:

Parámetro 1 (XmlDocument o Tipo String)

BizAgiWSParam: Nodo raíz. En este nodo se incluyen todos los filtros posibles. Estos filtros son opcionales. Si se utiliza más de un criterio de búsqueda, la respuesta debería incluir únicamente aquellos casos que cumplan con todas las condiciones.

domain: Busqueda de los casos  cuyo usuario asignado pertenezca a este dominio.

userName: Busca los casos cuyo usuario asignado sea el usuario que se indica en este elemento.

radNumber: Casos que pertenezcan a este número de creación (número de caso).

applicationName: Casos que pertenezcan a la aplicación con este nombre (ingrese el nombre, no el nombre a mostrar).

categoryName: Busca todos los casos abiertos en esta categoría (ingrese el nombre, no el nombre a mostrar).

processName: Obtiene los casos de este proceso (ingrese el nombre, no el nombre a mostrar).

idCase: Retorna el caso con este idCase (número de identificación del caso).

creationDate: Se refiere a la fecha cuando se creó el caso.

expirationDate: Fecha programada para la expiración del caso (de acuerdo a la duraión configurada).

From: Será utilizado como un sub-nodo ya sea de la fecha de creación o de la fecha de expiración; permite que se pueda ingresar un rango de fechas. Esta será la fecha inicial para la búsqueda (la más antigua).

To: Será utilizado como un sub-nodo ya sea de la fecha de creación o de la fecha de expiración; permite que se pueda ingresar un rango de fechas. Esta será la fecha final para la bpusqueda (la más reciente).

Ejemplo

Para consultar los casos creadas entre el 17 de Mayo a las 4 pm y el 21 de Mayo a las 4 pm, con usuario asignado "Raulp" la solicitud XML debe ser:

Parámetros de Salida

El XML de respuesta debe cumplir con el esquema XSD siguiente:

La respuesta incluye información básica de los casos (y procesos) que cumplen con los criterios de búsqueda. A continuación encontrará una descripción de la información contenida en el XML de respuesta.

processes: Nodo raíz de la respuesta, contiene un nodo "process" para cada actividad incluída en el resultado.

process: Se incluye este elemento para cada uno de los casos retornados.

processId: Número de identificación del caso (idCase).

processRadNumber: Valor alfanumérico correspondiente al número de creación del caso.

savedMessage: Reservado para uso futuro.

Entities: Reservado para uso futuro.

processCreationDate: Fecha de creación del caso.

processSolutionDate: Fecha de solución (cierre) del caso.

processWorkflowClass: Este nodo contiene únicamente información del proceso (metadata), no información del caso en particular.

workflowClassId: Número de identificación (o llave) del proceso.

workflowClassName: Nombre del proceso.

workflowClassDisplayName: Nombre a mostrar del proceso.

workflowClassDescription: Descripción del proceso.

workflowClassHelpText: Texto de ayuda del proceso.

workflowClassHelpURL: URL de ayuda del proceso.

workflowClassDisplayOrder: El orden en el cual aparece el proceso en la aplicación web.

workflowClassCreationDate: Fecha de creación del proceso.

workflowClassAllocationPrinciple: Reservado para uso futuro.

workflowClassProcessType: Tipo de proceso.

workflowClassDisplay: Indica si un proceso es visible o no.

workflowClassUseParentRadicationNumber: Indica si un caso de este proceso utiliza su propio número de creación o si es el mismo número que el proceso padre (para subprocesos).

workflowClassSupportScopes: Indica si el proceso soporta los "scopes" de Bizagi, los cuales son un método eficiente de persistencia de datos.

processError: Si se presentó un error en el momento de cancelar un caso, este elemento mostrará información del error.

errorCode: Código del error presentado, Si no hubo error, este nodo estará vacío.

errorMessage: Mensaje del error presentado. Si no hubo error, este nodo estará vacío.

CurrentWorkItems: Serie de actividades disponibles para un caso.

workItem: Es una actividad específica del proceso (una instancia de una tarea) que se encuentra activa para el caso.

workItemId: Número de identificación de la llave de la actividad.

workItemState: Estado en el cual se encuentra la actividad.

workItemEntryDate: Fecha y hora en la que el caso llegó a esta actividad.

workItemDuration: Duración estimada, en minutos, para la actividad.

workItemEstimatedSolutionDate: Es la fecha estimada de solución para el caso.

task: Contiene información sobre la tarea.

taskId: Número de identificación o llave de la tarea.

taskName: Nombre de la tarea.

taskDisplayName: Nombre a mostrar de la tarea.

taskDescription: Texto descriptivo de la tarea.

taskHelpText: Texto de ayuda de la tarea.

HelpUrl: URL con información de la actividad.

taskEstimatedDuration: Duración estimada de la tarea, en minutos.

taskType: Tipo de tarea.

taskCost: The estimated cost of the task. This value, like the estimated dates, is configured and determined by the designer of the process.

taskPriority: Prioridad de la tarea.

taskTransactional: Indicador de comienzo si la tarea es transaccional.

taskCompensation: Indica si es una tarea de compensación.

taskTimerEventDuration: Si es una tarea de temporizador, contendrá la duración en minutos.

AllowsReassign: Una marca que muestra si la tarea puede ser reasignada a otro usuario.

SendNotification: Indica si se debe enviar un email a un usuario informándole sobre la disponibilidad de la tarea.

SendAlarms: Indica si se debe enviar un email a un usuario informándole que la tarea esta próxima a vencerse.

ExtendedEstimatedDuration: Tiempo extendido de duración estimada.

Form: Reservada para uso futuro.

IsAsynchTask: Especifica si es una tarea asincrónica o no. Se utiliza normalmente para interfaces..

NumberOfRetries: Aplica para tareas asincrónicas. Es el número de reintentos automáticos para una tarea en caso de error (se arroja una excepción).

RetryInterval: Aplica para tareas asincrónicas. Es el tiempo (en minutos) entre cada reintento.

ShowFeedback: Aplica para tareas asincrónicas. indica si el usuario será informado cuando se presente un error.

TimeoutSeconds: Aplica para tareas asincrónicas. Tiempo (en segundos) que la tarea asincrónica esperará por una respuesta del sistema externo.

Ejemplo

A continuación se muestra el XML de respuesta a la invocación explicada anteriormente:

En este caso la respuesta incluye un caso únicamente. <comments />