De

<keywords content="keywords">setEvent, setevent, setEventAsString, seteventasstring, set Event, set event, capa SOA, capa soa, WorkflowEngineSOA, workflowenginesoa, Workflow Engine SOA, workflow engine soa</keywords> 

setEvent

Método del servicio web WorkflowEngineSOA utilizado para avanzar, desde una aplicación externa, un evento disponible en Bizagi. Este documento aplica también para el método setEventAsString.

Descripción

Este método activa uno o más Eventos en Bizagi para uno o más casos, empleando un XML como parámetro de entrada, y al mismo tiempo es posible almacenar información de negocio para estos eventos. El método setEvent recibe y retorna un XmlDocument mientras que setEventAsString recibe y retorna un XML en formato string.

Parámetros de Entrada

A continuación encontrará el esquema del XML esperado (se puede copiar desde el siguiente link):

Parámetro 1 (XmlDocument o Tipo String)

BizAgiWSParam: Nodo raíz.

domain: Nombre del dominio del usuario Bizagi que será registrado como aquel que avanzó el Evento.

userName: Nombre del usuario registrado como aquel que avanzó el Evento.

Events: Contiene información de todos los Eventos.

Event: Contiene información de un Evento en particular.

EventData: Contiene la información necesaria para localizar el Evento.

idCase: Es el número de identificación del caso para el Evento que se desea avanzar. Es necesario que se incluya este elemento, o en su defecto el radNumber.

radNumber: alternativa al idCase. es el número de creación (número de caso) del caso que contiene el Evento pendiente que se desea avanzar. Cuando se usa el mismo número de creación para varios casos (como cuando un subproceso utiliza el número del caso padre) el idCase debe ser utilizado para distinguir a cual caso pertenece el evento.

taskId: Número de identificación del Event que se desea avanzar. Este elemento es necesario; Si no se conoce este número, se debe incluir el eventName.

eventName: Empleado como alternativa al identificador de la tarea (taskId), es el número del evento pendiente que se va a avanzar.

Entities: Es el nodo que contiene la información de negocio que se va a guardar en el caso.

Ejemplo

Con el siguiente XML, el usuario domain\Raulp activará dos Eventos para dos casos diferentes. Un evento llamado Event2 del caso con número de creación 501; y el Evento con id 145 del caso con id 201. Adicionalmente, para el segundo Evento, se seteará el atributo 'BuroScore' con el valor '5959':

Parámetros de Salida

El esquema del XML de respuesta se muestra a continuación (se puede copiar desde el siguiente link):

The response includes basic information of the case (and process) just continued. Here is the description of each data contained in the returned XML.

processes: Nodo raíz, contiene información sobre los procesos a los cuales pertenecen los eventos.

process: Este elemento incluye información del proceso.

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.

processWorkflowClass: Toda la información en este nodo es información del proceso (metadata), no es 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: Orden en el cual aparecen los procesos en Bizagi Studio.

workflowClassCreationDate: Fecha de creación del proceso.

workflowClassGlobalForm: Número de identificación de la forma global del proceso (cero si no se encuentra configurada).

workflowClassAllocationPrinciple: Reservado para uso futuro.

workflowClassProcessType: Tipo de proceso.

workflowClassDisplay: Indica si el proceso es visible o no.

workflowClassUseParentRadicationNumber: Indica si un caso del proceso utiliza su propio número de creación, o si es el mismo número que el del proceso padre (en caso de ser un subproceso).

processError: Si el proceso de guardar información en la actividad no fue exitoso, este elemento contendrá información del error.

errorCode: Código del error ocurrido. En caso de no haber error, este elemento estará vacío.

errorMessage: Mensaje del error ocurrido, En caso de no haber error, este elemento estará vacío.

Path: XPath del elemento que generó el error desde el XML de envío. Visible cuando el error es generado por información errada.

Attrib: Nombre del atributo en Bizagi donde se intentó almacenar la información que generó el error. Visible cuando el error es generado por información errada.

Value: Es el valor que causó el error. Visible cuando el error es causado por información errada.

ErrorMessage: Mensaje donde se describe por qué se ha presentado el error. Visible cuando el error es generado por información incorrecta.

CurrentWorkItems: Serie de actividades disponibles para el caso.

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

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

workItemState: Estado en el cual se encuentra la actividad.

workItemEntryDate: Fecha y hora en la cual el caso llegó a esta actividad por primera vez.

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

workItemEstimatedSolutionDate: Fecha estimada de solución del caso.

Task: Contiene información sobre la tarea que corresponde a la actividad.

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.

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

taskType: Tipo de tarea.

taskCost: Costo estimado de la tarea. Este valor, así como las fechas estimadas, es configurado y determinado por las persona que diseña el proceso.

taskPriority: Prioridad de terminación de la tarea.

taskTransactional: Indica si la tarea es transaccional o no.

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

taskTimerEventDuration: Si es un temporizador, su duración estará en minutos.

AllowsReassign: Marca que muestra si la tarea puede ser reasignada a un usuario distinto.

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

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

ExtendedEstimatedDuration: Tiempo de duración extendida estimado.

Form: Reservado para uso futuro.

IsAsynchTask: Especifica si se trata o no de una tarea asincrónica. Utilizado normalmente para interfaces.

NumberOfRetries: Aplica para tareas asincrónicas. Número automático de reintentos para la tarea en case de fallar (se arroja una excepción).

RetryInterval: Aplica para tareas asincrónicas. 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 encontrará el XML de respuesta al XML enviado en el ejemplo anterior:

Como este método es como hacer click en el botón Siguiente en la interfaz de usuario, bajo el elemento CurrentWorkItems se encontrará la información de la actividad a la cual llega el caso, en este ejemplo para ninguno de los casos hay más actividdes pendientes.

IR A CAPA SOA  <comments />