De

<keywords content="keywords"> getEvents, getEventsAsString, get Events, SOA Layer, WorkflowEngineSOA, Workflow Engine SOA </keywords> 

getEvents

Método del servicio web WorkflowEngineSOA usado para recibir información de eventos intermedios desde una aplicación externa. Este artículo aplica también para el método getEventsAsString.

Descripción

Este método recibe un XML con varios filtros que serán utilizados para obtener información de los eventos que cumplen con estos criterios de búsqueda. El método getEvents recibe y retorna un XmlDocument mientras que getEventsAsString recibe y retorna un XML con formato string.

Parámetros de Entrada

A continuación se presenta el esquema del XML esperado:

Parámetro 1 (XmlDocument o Tipo String)

BizAgiWSParam: Nodo raíz. En este nodo se deben incluir todos los filtros necesarios. Estos filtros son opcionales. Si se utiliza mas de un criterio de búsqueda, el resultado serían únicamente las actividades que cumplan con todas las condiciones.

domain: Eventos de búsqueda cuyo usuario asignado pertenezca a este dominio.

userName: Eventos de búsqueda cuyo usuario asignado es el que se encuentra indicado en este elemento.

radNumber: Eventos que pertenecen a este número de creación (número de caso).

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

Ejemplo

Con el siguiente XML se retornan los eventos del caso número 351 :

Parámetros de Salida

El esquema del XML de respuesta tiene la siguiente estructura:

La respuesta incluye información de los eventos que cumplen con los criterios de búsqueda. A continuación encontrará una descripción de cada uno de los elementos que se encuentran en el XML de respuesta.

workItems: Nodo raíz de la respuesta; contienen un nodo "workItem" para cada evento incluído en el resultado.

workItem: Evento específico (instancia de una tarea) del proceso que se encuentra activo para el caso.

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

workItemState: Estado en el que se encuentra la tarea.

workItemEntryDate: Fecha y hora cuando se ingresa a la tarea por primera vez.

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

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

workItemSolutionDate: Fecha en la cual se completó la tarea.

task: Contiene información sobre la tarea que corresponde a este evento.

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, en miniutos , para la tarea.

taskType: Tipo de tarea.

taskCost: Costo estimado de la tarea. Este valor, como el de la fecha estimada, se confiigura y determina por la persona que diseña el proceso.

taskPriority: Prioridad de cumplimiento de la tarea.

taskTransactional: Indica si la tarea es transaccional.

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

taskTimerEventDuration: Si se trata de un temporizador, este contendrá la duración en minutos.

AllowsReassign: Una marca que muestra si la tarea puede ser asignada a un usuario diferente.

SendNotification: Indica si se debe enviar un email a un usuario informándole que la tarea se encuentra disponible.

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

ExtendedEstimatedDuration: Tiempo estimado de duración extendida.

Form: Resevado para uso futuro.

IsAsynchTask: Especifica si se trata de una trea asincrónica. Usualmente utilizado para interfaces.

NumberOfRetries: Aplica para tareas asincrónicas. Es el número de reintentos automáticos para una tarea en caso de falla o 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 se informará al usuario 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

El siguiente es el XML de respuesta al que se envió en el ejemplo previo en este mismo artículo:

<comments />