De

<keywords content="keywords"> saveActivity, saveactivity, saveActivityAsString, saveactivityasstring, save Activity, SOA Layer, soa layer, WorkflowEngineSOA, workflowenginesoa, Workflow Engine SOA, workflow engine soa </keywords> 

saveActivity

Método del servicio web WorkflowEngineSOA utilizado para almacenar información de negocio en una actividad en Bizagi desde una aplicación externa. Este documento aplica también para el método saveActivityAsString.

Descripción

Este método recibe un XML con la información para identificar la actividad y también con la información que se va a guardar en esta actividad. Este método equivale al botón Guardar en la interfaz de usuario de la actividad. El método saveActivity recibe y retorna un XmlDocument y saveActivityAsString recibe y retorna un XML en formato string.

Parámetros de Entrada

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

Parámetro 1 (XmlDocument Tipo String)

BizAgiWSParam: Nodo raíz.

domain: Nombre del dominio del usuario de Bizagi que se va a registrar como el usuario que guardó la información en la actividad.

userName: Nombre del usuario que se va a registrar como el usuario que guardó la información en la actividad.

ActivityData: Contiene toda la información necesaria para encontrar la actividad.

radNumber: Número de creación (número del caso) del caso que contiene la actividad pendiente en la cual se almacenará la información. Este elemento es requerido.

taskName: Nombre de la actividad pendiente en la cual se almacenará la información.

Entities: Nodo que contiene los valores de la información de negocio que se va a guardar en el caso.

Ejemplo

El usuario domain\Raulp almacenará el valor 180 en el atributo BuroScore para el solicitante con Número de Documento (DocumentNumber) 123456 dentro de la colección de solicitantes (Applicants) de la solicitud, en la actividad Task3 del caso con número de creación  9301, empleando el siguiente XML:

Parámetros de Salida

El esquema del XML de retorno es (puede copiarlo desde este link):

La respuesta incluye información del proceso al cual pertenece la actividad. A continuación encontrará una descripción de la información contenida en el XML de respuesta.

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.

processCreationDate: Fecha de creación del caso.

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

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

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

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:

IR A CAPA SOA <comments />