CreateCases
De
<keywords content="keywords">createCases, createCasesAsString, create Cases, Capa SOA, WorkflowEngineSOA, Workflow Engine SOA</keywords>
Contenido |
createCases
Método del servicio web WorkflowEngineSOA, usado para crear casos desde aplicaciones externas. Este artículo aplica también para el método createCasesAsString.
Descripción
Con este método es posible crear uno o más casos al mismo tiempo. También es posible guardar información en el nuevo caso (o casos). La única diferencia entre el método createCases y createCasesAsString es que el primero recibe y retorna un XML con formato XmlDocument mientras que el segundo recibe y retorna los mismos XML pero en formato string.
Parámetros de Entrada
El XML esperado debe ser generado de acuerdo al siguiente esquema XSD:
Parámetro 1 (XmlDocument o Tipo String)
BizAgiWSParam: Nodo raíz.
domain: Contiene el nombre del dominio del usuario Bizagi que será registrado como el creador del caso.
userName: Contiene el nombre (usado en Bizagi) del usuario que será registrado como el creador del caso.
cases: Este elemento será incluído para agrupar varios elementos case dependiendo del número de casos que serán creados.
case: En este elemento se incluye información del caso que será creado.
Process: En este elemento, escriba el nombre (no el nombre a mostrar) del proceso.
Entities: Incluya aquí la información que será almacenada en el modelo de datos del paso que se está creando.
Ejemplo
Con el siguiente XML se crearán dos casos en el proceso de "Credit". Sin embargo, para el segundo caso se ha incluído un error a propósito; se seteó la letra "a" como valor del elemento "BuroScore". Esto es un error dado que en Bizagi, el atributo "BuroScore" fue creado como un entero, esto implica que el intentar almacenar una letra en este atributo es un error. Por lo tanto, el caso no se puede crear.
Parámetros de Salida
El XML de respuesta debe ser generado de acuerdo al siguiente esquema XSD:
La respuesta incluye información básica del caso (y del proceso) que se acabó de crear. A continuación encontrará una descripción de cada uno de los elementos retornados en el XML de respuesta.
processes: Nodo raíz.
process: Este elemento se incluye para cada caso que se va a crear.
processId: Número de identificación del caso (idCase).
processRadNumber: Valor Alfanumérico que corresponde al número de creación del caso.
savedMessage: Reservado para una funcionalidad posterior.
Entities: Reservado para una funcionalidad posterior.
processWorkflowClass: Este nodo contiene 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: El orden en el cual aparece 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 está configurada).
workflowClassAllocationPrinciple: Reservado para una funcionalidad posterior
workflowClassProcessType: Tipo de proceso.
workflowClassDisplay: Indica si el 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.
Path: XPath del elemento en el XML de entrada que genera el error. Este elemento es visible cuando el error es generado por información incorrecta.
Attrib: Es el nombre del atributo en Bizagi donde se intentó realizar la operación de almacenamiento de datos. Este elemento es visible cuando el error es generado por información incorrecta.
Value: Es el valor que causa el error. Es visible cuando el error es generado por información incorrecta.
ErrorMessage: Mensaje que explíca por qué se presentó el error. Visible cuando el error es causado por información incorrecta.
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.
taskEstimatedDuration: Es la duración estimada, en minutos, de la tarea.
taskType: Tipo de tarea.
taskCost: Costo estimado de la tarea. Este valor, como el de las fechas estimadas, es configurado y determinado por el diseñador del proceso.
taskPriority: Prioridad de la tarea.
Ejemplo
A continuación encontrará el XML de respuesta a la invocación realizada previamente:
Existen dos nodos "process", el primero de ellos tiene información detallada del proceso para el cual fue creado el caso. Mientras que el segundo, incluye únicamente el mensaje de error, el atributo y el valor que generaron el error en el nodo llamado "processError".
Cómo crear un caso empleando SOA <comments />