Ver código fuente

<keywords content="keywords">
getClosedActivities, getClosedActivitiesAsString, get Closed Activities, SOA Layer, WorkflowEngineSOA, Workflow Engine SOA
</keywords>&nbsp; 

= getClosedActivities  =

Método del servicio web WorkflowEngineSOA utilizado para consultar actividades cerradas o terminadas en Bizagi desde una aplicación externa. Este documento aplica también para el método '''getClosedActivitiesAsString'''<span style="font-size: 13px" class="Apple-style-span">.</span><br>

== Descripción  ==

Este método recibe un XML con el idCase (número de identificación interna del caso<span style="font-size: 13px" class="Apple-style-span">) para el cual se desean consultar las actividades cerradas. El método '''getClosedActivities''' recibe y retorna un XmlDocument y el método '''getClosedActivitiesAsString''' recibe y retorna un XML con formato string.</span> 

== Parámetros de Entrada  ==

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

<br>

[[Image:GetClosedActivities Image001.jpg|center]] 

<br>

===== Parámetro 1 (XmlDocument o&nbsp;de Tipo String)  =====

'''BizAgiWSParam''': Nodo raíz. 

'''idCase''': idCase&nbsp;(número de identificación del caso)&nbsp;al cual pertenecen las actividades cerradas deseadas. 

'''subprocessDepth''': Es un indicador de nivel de profundidad de los subprocesos. Se utiliza cuando existen tareas de tipo subproceso<span style="font-size: 13px" class="Apple-style-span">, para poder&nbsp;retornar información de actividades en los subrpocesos que&nbsp;&nbsp;pueda tener el caso. Por defecto, la consulta retorna un nivel de profundidad, es decir, el resultado contiene las actividades de de los subprocesos relacionados al proceso del caso actual; pero no incluye las actividades de los subprocesos dentro de los subprocesos (2 niveles de profundidad). El valor de este elemento puede ser cualquier número entero, pero es importante tener presente que entre más niveles de profundidad, más demorada será la respuesta. por lo tanto se recomienda un número pequeño.</span> 

===== Ejemplo  =====

Con el siguiente XML se obtendrán las actividades cerradas del caso número 9201. Dado que se definen dos niveles de profundidad, se retornará también la información de las actividades cerradas de los subprocesos dentro de los subprocesos: 

<br>

[[Image:GetClosedActivities Image002.jpg|center]] 

== Parámetros de Salida  ==

El esquema del XML de respuesta tiene la siguiente estructura: 

<br>

[[Image:GetClosedActivities Image003.jpg|center]] 

<br>

La respuesta incluye información de todas las actividades cerradas que cumplen con los criterios de búsqueda. A continuación se describen cada uno de los elementos en el XML de respuesta. 

'''workItems''': Nodo raíz de la respuesta; contiene un nodo "workItem" para cada actividad incluída en el resultado. 

'''workItem''': Actividad específica (instancia de una tarea) del proceso activo para el caso. 

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

'''workItemState''': Estado en el que se encuentra la actividad. 

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

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

'''workItemSubprocesses''': Si la actividad es de tipo subproceso, este elemento incluirá información de las actividades cerradas del subproceso. Tiene un nodo hijo llamado "workItems" de manera que desde allí en adelante, la estructura es la misma que la descrita anteriormente a partir del workitem de la actividad que cumple con los criterios de búsqueda. 

'''workItemEstimatedSolutionDate''': Fecha estimada de solución de la actividad. 

'''workItemSolutionDate''':&nbsp;Fecha&nbsp;en&nbsp;la cual se completó la actividad. 

'''task''': Contiene información acerca de la tarea correspondiente 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. 

'''HelpUrl''': URL con información de la tarea. 

'''taskEstimatedDuration''': Duración estimada de la tarea, en minutos, for the task. 

'''taskType''': Tipo de tarea. 

'''taskCost''': Costo estimado de la tarea. Este valor, como el de las fechas estimadas, se configura y determina por la persona que diseña en proceso. 

'''taskPriority''': Prioridad de la tarea. 

'''taskTransactional''': Indica si la tarea es transaccional. 

'''taskCompensation''': Indica si se trata de una tarea de compensación. 

'''taskTimerEventDuration''': Se usa si la tarea es un temporizador, la duración se incluye en minutos. 

'''AllowsReassign''': Marca que muestra si la tarea puede ser reasignada a otro usuario. 

'''SendNotification''': Indica si un se debe enviar un email a un usuario informando sobre la disponibilidad de la tarea. 

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

'''ExtendedEstimatedDuration''': Tiempo estimado de duración extendida. 

'''Form''': Reservado para uso futuro. 

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

'''NumberOfRetries''': Aplica para tareas asincrónicas. Es el número de reintentos automáticos de la tarea en caso de presentarse una falla (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 en caso de presentarse un error. 

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

'''process''': Tiene información sobre el proceso al cual pertenece la actividad. 

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

'''processCreationDate''': Fecha de creación del caso. 

'''processSolutionDate''': Fecha de solución del caso. 

'''processWorkflowClass''': Este nodo contiene básicamente información sobre el proceso (metadata) y no sobre el 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 aparecerá el proceso en la aplicación web. 

'''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 de este proceso es creado utilizando si 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 para la persistencia de datos. 

'''processError''': Contiene información de los errores que ocurren durante el procesamiento de este método. 

'''errorCode''': Código del error, en caso de presentarse alguno. 

'''errorMessage''': Mensaje de error, en caso de presentarse alguno. 

===== Ejemplo  =====

A continuación se muestra un XML de respuesta al ejemplo presentado anteriormente en este artículo: 

<br>

[[Image:GetActivities Image004.jpg|center]]&nbsp;
<comments />