De

<keywords content="keywords">GetQueryForms, getqueryforms, Get Query Forms, get query forms, Capa SOA, capa soa, RenderSOA, rendersoa, Render SOA, render soa</keywords> 

GetQueryForms

Método del servicio web RenderSOA utilizado para obtener los campos de una forma que es empleada para obtener un reporte, conocido también en Bizagi como una Forma de Consulta.

Descripción

Este método recibe un XML en formato string el cual contiene el número de identificación de la forma que se usa para la búsqueda. El mensaje de respuesta es un XML en formato.

Parámetros de Entrada

El XML esperado tiene el esquema a continuación:

Parámetro 1 (Tipo String)

BizAgiWSParam: Nodo raíz.

domain: Dominio del usuario Bizagi.

userName: Nombre del usuario Bizagi.

QueryForm: Incluye información sobre la forma de consulta deseada.

IdQueryForm: Número de identificación de la Forma.

Ejemplo

El proceso de ejemplo de seguros vehículo incluye una forma de consulta que tiene el número de identificación 34:

Output Data

The returned XML varies according to how the form was built up and on the renders it contains. Here is the description of each data the response may contain in the returned XML.

Elements

BizagiResponse: Nodo raíz.

Form: Contiene la información de la forma.

Tab: Indica que hay una pestaña en la forma.

Group: Indica si hay un grupo en la forma.

ExtendedText: Uno de los tipos de campo en Bizagi el cual es una caja de texto para textos largos.

Text: Caja de texto en una forma (ver Tipos de Campo).

ComboBox: Este tipo de campo es una lista desplegable en la forma.

Option: Este elemento es usado con los combos, si el combo es editable habrá una de estas opciones en la losta desplegable. Si no es editable, solamente habrá una con la opción seleccionada.

RadioButton: Otro tipo de campo que muestra las diferentes opciones que se pueden seleccionar.

Item: Este elemento es usado sea con el RadioButton o la colección de datos (GridSM). Para los radio buttons se incluye un elemento por cada opción posible. Para las colecciones, se incluye el elemento dentro de un elemento Fila que representa el valor de cada columna en la fila.

Money: Render usado para mostrar un atributo de tipo Currency, (ver tipos de campo).

Numeric: Render usado para mostrar cualquier otro atributo que representa un número (integer, float, real, etc.), (ver Tipos de Campo).

YesNo: Este tipo de campo es usado para Atributos Booleanos y consiste en un par de radio buttons Si/No.

Date: Representa un tipo de campo de fecha y hora.

SearchDialog: Representa un Join Search Dialog o un Join Search Field (ver tipos de campo).

Actions: Serie de acciones configuradas para el render.

Action: Acción en particular.

Behaviours: Serie de comportamientos configurados para el render.

Behaviour: Un comportamiento en particular.

ClientValidations: Serie de validaciones configuradas para el render.

ClientValidation: Una validación en particular.

Expression: Este elemento es usado para acciones, comportamientos y validaciones. Contiene la expresión que será evaluada.

Target: Elemento usado en acciones el cual incluye las acciones específias para el objetivo.

GridSM: Usado para indicar una grilla (tabla) el cual es un render para Colecciones.

DisplayForm: Este elemento es parte del GridSM y contiene los renders (columnas) de la tabla.

AddForm: Hace parte también de GridSM, contiene el número de identificación de la forma utilizada para añadir una nueva fila en la tabla.

EditForm: Hace parte también de GridSM, contiene el número de identificación de la forma utilizada para editar una fila en la tabla.

Values: Forma parte de GridSM, contiene todas las filas en la tabla.

Row: Este elemento indica una forma en una tabla (grilla).

CaseInfo: Información del caso.

IdCase: Identificación del número del caso.

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

RadicationNumber: Valor alfanumérico correspondiente al número de creación del caso.

SolutionDate: Fecha en la cual se completó el caso.

Creator: Información sobre el creador del caso.

Id: Número de identificación del creador del caso.

UserName: Nombre del usuario creador del caso.

Domain: Dominio al cual pertenece el creador del caso.

FullName: Nombre completo del creador del caso.

Activity: Información sobre la actividad consultada.

Id: Número de identificación de la tarea.

Name: Nombre de la tarea.

DisplayName: Nombre a mostrar de la tarea.

Description: Texto corto con alguna descripción de la tarea.

Process: Datos del proceso.

Id: Número que identifica el proceso.

Name: Nombre del proceso.

DisplayName: Texto con alguna explicación sobre el proceso.

Atributos

Los atributos pertenecen a los Elementos, y no todos los atributos se encuentran encada elemento. A continuación encontrará una explicación corta de los atributos que se pueden encontrar.

RenderId: Número de identificación del render, estos atributos se incluyen en todos los elementos que representan un tipo de campo: Forma, Fecha, Combo Box, Texto, etc.

ConfirmationRequired: Pertenece al elemento Forma y es un Booleano que indica si la actividad necesita confirmación del usuario cuando se presiona el botón Siguiente.

DisplayName: Casi todos los elementos tienen estos atributos, este es el texto que debe aparecer para un campo en caso que este se muestre.

Editable: Todos los elementos correspondientes a tipos de campos (excepto las GridSM) tienen este atributo Booleano el cual indica si el campo debe mostrarse como editable o no.

Required: Así como el elemento previo, este elemento es un Booleano el cual indica si un render debería mostrarse o no como requerido. Este se puede encontrar en todos los elementos de tipo campo, excepto GridSM y Form.

XPath: Contiene el mapeo del render hacia el modelo de datos, cada render tipo campo lo tiene excepto Form.

Description: Este atributo aparece para los elementos que representan un tipo de campo solamente si el texto de descripción fue incluído en las propiedades del render.

HelpText: Al igual que la Descripción, este elemento aparece únicamente si la información fue diligenciada en las propiedades del render.

LabelAlign: Texto que especifica la alineación del render (izquierda, centro, derecha o justificado).

LineBreak: Un booleano que indica si después de este render hay o no un cambio de línea (line break); es decir, si el render siguiente aparecerá en la misma linea o en una línea diferente.

ValueAlign: Texto que especifica la alineación del los valores del render (izquierda, centro, derecha o justificado).

DisplayOption: Algunos renders tienen maneras diferentes de ser mostrados, estas opciones son: ambas, que es la opción por defecto, muestra la etiqueta y a continuación el valor; label, muestra únicamente la etiqueta del render; value, muestra únicamente el valor del render; reversed, muestra primero el valor y luego la etiqueta; y vertical, la cual muestra el valor entre etiquetas, en una nueva línea.

ColSpan: Número indicando el número de columnas que usa un render, usualmente el número es (0).

Retype: Este atributo puede ser encontrado en algunos elementos que representan tipos de campos y es un Booleano que  indica si la información ingresada en este render debe ser digitada o no dos veces.

Size: Es un número que indica el tamaño para los tipos de campo donde se debe ingresar valores en las cajas: texto, texto extendido y moneda. También se puede encontrar en combos y tendrá un número distinto a (1) si el render se debe mostrar como una lista, este atributo indica el tamaño de la lista.

MaxLength: Atributo empleado para los elementos Texto y Texto Extendido el cual indica el número máximo de caracteres que se pueden ingresar en el render.

ColSize: Únicamente para los elementos de Texto Extendido, es un número que indica el tamaño horizontal del render, si el número es 0 entonces tiene asignado el valor por defecto que es de 42 caracteres.

ResetAppearance: Este se encuentra en los elementos Acción y Comportamiento; es un Booleano el cual indica si el render debe retornar a su apariencia original si la condición no se cumple.

Show: También hace parte del elementon de Comportamientos. Para las acciones se incluye en el elemento de Objetivo (Target). Este Booleano determina si el render al cual pertenece el Comportamiento o al cual se refiere el Objetivo, es o no visible.

Color: Atributo encontrado en el elemento de Comportamiento y en el elemento de Objetivo (Target) que hace parte del elemento de Acciones. Es un código hexadecimal con el color con el cual se mostrará el render en caso de cumplirse la condición.

OrderAttrib: Se puede encontrar en los elementos ComboBox, GridSM o SearchDialog. Contiene el nombre del atributo que debe ser usado para ordenar los elementos que contiene este campo.

SubmitOnChange: Es un Booleano que puede ser encontrado en varios elementos de tipo de campo para indicar si la forma se actualiza en el momento que se cambia el valor del campo.

Value: Este atributo se incluye en la mayoría de tipos de campo y contiene el valor actual del campo, en caso de no encontrarse este elemento quiere decir que el campo no tiene valor asociado en ese momento. También hace parte del elemento opción de los combos, y contiene el valor de la llave del registro.

Text: Texto que se muestra en las listas desplegables, este es el valor en el atributo a mostrar para una entidad; se incluye en el elemento de Opción.

AdditionalText: Para una lista desplegable es posible incluir un segundo texto que corresponde al valor de cualquier otro atributo en la entidad. Este atributo es para el elemento Opción.

Message:

IdDisplayForm:

IdRelatedEntity:

DisplayValue:

RelationDisplayName:

AllowAdd:

AddLabel:

AllowDelete:

EntityDisplayName:

Example

Para ver el XML de respuesta al que se envió en el ejemplo anterior, haga click en este enlace:

Ir a la CAPA SOA <comments />