[También se aplica a la versión 8]{class="badge positive" title="También se aplica a Campaign v8"}

Estructura del formulario form-structure

La descripción de un formulario es un documento XML estructurado que observa la gramática del esquema del formulario xtk:formulario.

El documento XML del formulario de entrada debe contener la variable <form> elemento raíz con la variable name y namespace atributos para rellenar el nombre del formulario y el área de nombres.

<form name="form_name" namespace="name_space">
…
</form>

De forma predeterminada, un formulario está asociado al esquema de datos con el mismo nombre y área de nombres. Para asociar un formulario con un nombre diferente, establezca entity-schema atributo del <form> al nombre de la clave de esquema. Para ilustrar la estructura de un formulario de entrada, describamos una interfaz con el esquema de ejemplo "cus:recipient":

<srcSchema name="recipient" namespace="cus">
  <enumeration name="gender" basetype="byte">
    <value name="unknown" label="Not specified" value="0"/>
    <value name="male" label="Male" value="1"/>
    <value name="female" label="Female" value="2"/>
  </enumeration>

  <element name="recipient">
    <attribute name="email" type="string" length="80" label="Email" desc="Email address of recipient"/>
    <attribute name="birthDate" type="datetime" label="Date"/>
    <attribute name="gender" type="byte" label="Gender" enum="gender"/>
  </element>
</srcSchema>

El formulario de entrada se basa en el esquema de ejemplo:

<form name="recipient" namespace="cus">
  <input xpath="@gender"/>
  <input xpath="@birthDate"/>
  <input xpath="@email"/>
</form>

La descripción de los controles de edición comienza desde el <form> elemento raíz. Se introduce un control de edición en el elemento <input> con el atributo xpath que contiene la ruta de acceso al esquema.

El control de edición se adapta automáticamente al tipo de datos correspondiente y utiliza la etiqueta definida en el esquema.

De forma predeterminada, cada campo se muestra en una sola línea y ocupa todo el espacio disponible en función del tipo de datos.

Formato formatting

El diseño de los controles se parece al diseño utilizado en las tablas de HTML, con la posibilidad de dividir un control en varias columnas, entrelazar elementos o especificar la ocupación del espacio disponible. Sin embargo, recuerde que el formato sólo permite dividir el área por proporciones; no se pueden especificar dimensiones fijas para un objeto.

Para mostrar los controles del ejemplo anterior en dos columnas:

<form name="recipient" namespace="cus">
  <container colcount="2">
    <input xpath="@gender"/>
    <input xpath="@birthDate"/>
    <input xpath="@email"/>
  </container>
</form>

El <container> con el elemento cómputo permite forzar la visualización de los controles secundarios en dos columnas.

El colSpan en un control extiende el control por el número de columnas introducidas en su valor:

<form name="recipient" namespace="cus">
  <container colcount="2">
    <input xpath="@gender"/>
    <input xpath="@birthDate"/>
    <input xpath="@email" colspan="2"/>
  </container>
</form>

Rellenando el type="frame" , el contenedor agrega un marco alrededor de los controles secundarios con la etiqueta contenida en el etiqueta atributo:

<form name="recipient" namespace="cus">
  <container colcount="2" type="frame" label="General">
    <input xpath="@gender"/>
    <input xpath="@birthDate"/>
    <input xpath="@email" colspan="2"/>
  </container>
</form>

A <static> para dar formato al formulario de entrada:

<form name="recipient" namespace="cus">
  <static type="separator" colspan="2" label="General"/>
  <input xpath="@gender"/>
  <input xpath="@birthDate"/>
  <input xpath="@email" colspan="2"/>
  <static type="help" label="General information about recipient with date of birth, gender, and email address." colspan="2"/>
</form>

El <static> etiqueta con el separador type permite añadir una barra de separación con una etiqueta contenida en la variable etiqueta atributo.

Se ha añadido un texto de ayuda utilizando <static> etiqueta con tipo de ayuda. El contenido del texto se introduce en etiqueta atributo.

Contenedores containers

Los contenedores permiten agrupar un conjunto de controles. Están representados por el <container> Elemento. Se utilizaron anteriormente para dar formato a los controles en varias columnas.

El xpath atributo en un <container> permite simplificar la referencia de los controles secundarios. La referencia a los controles es relativa al elemento principal <container> Elemento.

Ejemplo de un contenedor sin "xpath":

<container colcount="2">
  <input xpath="location/@zipCode"/>
  <input xpath="location/@city"/>
</container>

Ejemplo con la adición de "xpath" al elemento llamado "location":

<container colcount="2" xpath="location">
  <input xpath="@zipCode"/>
  <input xpath="@city"/>
</container>

Tipos de contenedor types-of-container

Los contenedores se utilizan para construir controles complejos mediante un conjunto de campos con formato en páginas.

Contenedor de fichas tab-container

Un contenedor de pestañas da formato a los datos en páginas a las que se puede acceder desde pestañas.

<container type="notebook">
  <container colcount="2" label="General">
    <input xpath="@gender"/>
    <input xpath="@birthDate"/>
    <input xpath="@email" colspan="2"/>
  </container>
  <container colcount="2" label="Location">
    …
  </container>
</container>

El contenedor principal se define mediante la variable type="bloc de notas" atributo. Las pestañas se declaran en los contenedores secundarios y la etiqueta de las pestañas se rellena desde el etiqueta atributo.

Lista de iconos icon-list

Este contenedor muestra una barra de iconos vertical que permite seleccionar las páginas que se van a mostrar.

<container type="iconbox">
  <container colcount="2" label="General" img="xtk:properties.png">
    <input xpath="@gender"/>
    <input xpath="@birthDate"/>
    <input xpath="@email" colspan="2"/>
  </container>
  <container colcount="2" label="Location" img="nms:msgfolder.png">
    …
  </container>
</container>

El contenedor principal se define mediante la variable type="iconbox" atributo. Las páginas asociadas con los iconos se declaran en los contenedores secundarios. La etiqueta de los iconos se rellena desde el etiqueta atributo.

El icono de una página se rellena desde el img="<image>" atributo, donde <image> es el nombre de la imagen correspondiente a su clave formada por el nombre y el área de nombres (por ejemplo, "xtk:properties.png").

Las imágenes están disponibles en el Administration > Configuration > Images nodo.

Contenedor de visibilidad visibility-container

Puede enmascarar un conjunto de controles mediante una condición dinámica.

Este ejemplo ilustra la visibilidad de los controles en el valor del campo "Gender":

<container type="visibleGroup" visibleIf="@gender=1">
  …
</container>
<container type="visibleGroup" visibleIf="@gender=2">
  …
</container>

Un contenedor de visibilidad se define mediante el atributo type="visibleGroup". El visibleIf contiene la condición de visibilidad.

Ejemplos de sintaxis de condición:

Habilitando contenedor enabling-container

Este contenedor permite habilitar o deshabilitar un conjunto de datos de una condición dinámica. Al deshabilitar un control se impide su edición. El ejemplo siguiente ilustra la activación de controles a partir del valor del campo "Gender":

<container type="enabledGroup" enabledIf="@gender=1">
  …
</container>
<container type="enabledGroup" enabledIf="@gender=2">
  …
</container>

Un contenedor de activación se define mediante la variable type="enabledGroup" atributo. El enabledIf contiene la condición de activación.

Edición de un vínculo editing-a-link

Recuerde que un vínculo se declara en el esquema de datos de la siguiente manera:

<element label="Company" name="company" target="cus:company" type="link"/>

El control de edición del vínculo en su formulario de entrada es el siguiente:

<input xpath="company"/>

Se puede acceder a la selección de destino mediante el campo de edición. La entrada se realiza con ayuda de escritura anticipada, de modo que se pueda encontrar fácilmente un elemento de destino a partir de los primeros caracteres introducidos. La búsqueda se basa entonces en Cadena Compute definido en el esquema de destino. Si el esquema no existe después de la validación en el control, se muestra un mensaje de confirmación de creación de destino sobre la marcha. La confirmación crea un nuevo registro en la tabla de destino y lo asocia al vínculo.

Se utiliza una lista desplegable para seleccionar un elemento de destino de la lista de registros ya creados.

El Modify the link El icono (carpeta) inicia un formulario de selección con la lista de elementos de destino y una zona de filtro:

El Edit link El icono (lupa) inicia el formulario de edición del elemento vinculado. El formulario utilizado se deduce de forma predeterminada en la clave del esquema de destino. El formulario El atributo permite forzar el nombre del formulario de edición (por ejemplo "cus:company2").

Puede restringir la selección de elementos de destino añadiendo <sysfilter> de la definición del vínculo en el formulario de entrada:

<input xpath="company">
  <sysFilter>
    <condition expr="[location/@city] =  'Newton"/>
  </sysFilter>
</input>

También puede ordenar la lista con el <orderby> elemento:

<input xpath="company">
  <orderBy>
    <node expr="[location/@zipCode]"/>
  </orderBy>
</input>

Propiedades de control control-properties

Lista de vínculos list-of-links

Un vínculo introducido en el esquema de datos como elemento de colección (unbound="true") debe pasar por una lista para ver todos los elementos asociados a él.

El principio consiste en mostrar la lista de elementos vinculados con carga de datos optimizada (descarga por lote de datos, ejecución de la lista solo si está visible).

Ejemplo de un vínculo de colección en un esquema:

<element label="Events" name="rcpEvent" target="cus:event" type="link" unbound="true">
…
</element>

La lista en su formulario de entrada:

 <input xpath="rcpEvent" type="linklist">
  <input xpath="@label"/>
  <input xpath="@date"/>
</input>

El control de lista se define mediante la variable type="linklist" atributo. La ruta de la lista debe hacer referencia al vínculo de colección.

Las columnas se declaran mediante la variable <input> elementos de la lista. El xpath attribute hace referencia a la ruta del campo en el esquema de destinatario.

Una barra de herramientas con una etiqueta (definida en el vínculo del esquema) se coloca automáticamente encima de la lista.

La lista se puede filtrar mediante el Filters y configuradas para añadir y ordenar las columnas.

El Add y Delete Los botones permiten añadir y eliminar elementos de colección en el vínculo. De forma predeterminada, al agregar un elemento, se inicia el formulario de edición del esquema de destino.

El Detail se añade automáticamente cuando el zoom="true" se completa en el <input> tag of the list: permite iniciar el formulario de edición de la línea seleccionada.

El filtrado y la ordenación se pueden aplicar cuando se carga la lista:

 <input xpath="rcpEvent" type="linklist">
  <input xpath="@label"/>
  <input xpath="@date"/>
  <sysFilter>
    <condition expr="@type = 1"/>
  </sysFilter>
  <orderBy>
    <node expr="@date" sortDesc="true"/>
  </orderBy>
</input>

Tabla de relaciones relationship-table

Una tabla de relación permite vincular dos tablas con la cardinalidad N-N. La tabla de relaciones sólo contiene los vínculos a las dos tablas.

Por lo tanto, añadir un elemento a la lista debería permitirle completar una lista desde uno de los dos vínculos de la tabla de relaciones.

Ejemplo de una tabla de relaciones en un esquema:

<srcSchema name="subscription" namespace="cus">
  <element name="recipient" type="link" target="cus:recipient" label="Recipient"/>
  <element name="service" type="link" target="cus:service" label="Subscription service"/>
</srcSchema>

Para nuestro ejemplo, empezamos con el formulario de entrada del esquema "cus:recipient". La lista debe mostrar las asociaciones con suscripciones a servicios y debe permitirle agregar una suscripción seleccionando un servicio existente.

<input type="linklist" xpath="subscription" xpathChoiceTarget="service" xpathEditTarget="service" zoom="true">
  <input xpath="recipient"/>
  <input xpath="service"/>
</input>

El xpathChoiceTarget El atributo permite iniciar un formulario de selección desde el vínculo introducido. Al crear el registro de la tabla de relaciones, se actualizará automáticamente el vínculo al destinatario actual y al servicio seleccionado.

Propiedades de lista list-properties

Controles de lista de memoria memory-list-controls

Las listas de memoria permiten editar los elementos de recopilación mediante la precarga de datos de lista. Esta lista no se puede filtrar ni configurar.

Estas listas se utilizan en elementos de colección asignados en XML o en vínculos de bajo volumen.

Lista de columnas column-list

Este control muestra una lista de columnas editable con una barra de herramientas que contiene los botones Añadir y Eliminar.

<input xpath="rcpEvent" type="list">
  <input xpath="@label"/>
  <input xpath="@date"/>
</input>

El control de lista debe rellenarse con el atributo type="list" y la ruta de la lista debe hacer referencia al elemento de colección.

Las columnas se declaran en el elemento secundario <input> etiquetas de la lista. La etiqueta de columna y el tamaño se pueden forzar con la etiqueta etiqueta y colSize atributos.

Los botones de la barra de herramientas se pueden alinear horizontalmente:

<input nolabel="true" toolbarCaption="List of events" type="list" xpath="rcpEvent" zoom="true">
  <input xpath="@label"/>
  <input xpath="@date"/>
</input>

El toolbarCaption fuerza la alineación horizontal de la barra de herramientas e introduce el título encima de la lista.

Aumento de una lista zoom-in-a-list

La inserción y edición de los datos en una lista se puede introducir en un formulario de edición independiente.

<input nolabel="true" toolbarCaption="List of events" type="list" xpath="rcpEvent" zoom="true" zoomOnAdd="true">
  <input xpath="@label"/>
  <input xpath="@date"/>

  <form colcount="2" label="Event">
    <input xpath="@label"/>
    <input xpath="@date"/>
  </form>
</input>

El formulario de edición se completa desde el <form> elemento bajo definición de lista. Su estructura es idéntica a la de un formulario de entrada. El Detail se añade automáticamente cuando el zoom="true" se completa en el <input> de la lista. Este atributo permite iniciar el formulario de edición de la línea seleccionada.

Propiedades de lista list-properties-1

Campos no editables non-editable-fields

Para mostrar un campo y evitar que se edite, utilice el <value> etiquete o complete el readOnly="true" en el <input> etiqueta.

Ejemplo en el campo "Género":

<value value="@gender"/>
<input xpath="@gender" readOnly="true"/>

Botón de opción radio-button

Un botón de opción le permite elegir entre varias opciones. El <input> se utilizan para enumerar las posibles opciones y la variable checkValue especifica el valor asociado con la opción.

Ejemplo en el campo "Género":

<input type="RadioButton" xpath="@gender" checkedValue="0" label="Choice 1"/>
<input type="RadioButton" xpath="@gender" checkedValue="1" label="Choice 2"/>
<input type="RadioButton" xpath="@gender" checkedValue="2" label="Choice 3"/>

Casilla de verificación checkbox

Una casilla de verificación refleja un estado booleano (seleccionado o no). De forma predeterminada, los campos "booleanos" (true/false) utilizan este control. Con este botón se puede asociar una variable que tenga un valor predeterminado de 0 o 1. Este valor se puede sobrecargar mediante la variable checkValue atributos.

<input xpath="@boolean1"/>
<input xpath="@field1" type="checkbox" checkedValue="Y"/>

Lista desglosada enumeration

Edición de jerarquía de navegación navigation-hierarchy-edit

Este control genera un árbol en un conjunto de campos que se van a editar.

Los controles que se van a editar se agrupan en una <container> introducido en la sección <input> etiqueta del control de árbol:

<input nolabel="true" type="treeEdit">
  <container label="Text fields">
    <input xpath="@text1"/>
    <input xpath="@text2"/>
  </container>
  <container label="Boolean fields">
    <input xpath="@boolean1"/>
    <input xpath="@boolean2"/>
  </container>
</input>

Campo de expresión expression-field

Un campo de expresión actualiza un campo dinámicamente desde una expresión; la variable <input> se utiliza con una etiqueta xpath para introducir la ruta del campo que se va a actualizar y un expo atributo que contiene la expresión update.

<!-- Example: updating the boolean1 field from the value contained in the field with path /tmp/@flag -->
<input expr="Iif([/tmp/@flag]=='On', true, false)" type="expr" xpath="@boolean1"/>
<input expr="[/ignored/@action] == 'FCP'" type="expr" xpath="@launchFCP"/>

Contexto de los formularios context-of-forms

La ejecución de un formulario de entrada inicializa un documento XML que contiene los datos de la entidad que se está editando. Este documento representa el contexto del formulario y se puede utilizar como espacio de trabajo.

Actualización del contexto updating-the-context

Para modificar el contexto del formulario, utilice el <set expr="<value>" xpath="<field>"/> etiqueta, donde <field> es el campo de destino, y <value> es la expresión o el valor de actualización.

Ejemplos de uso del <set> etiqueta:

El contexto del formulario se puede actualizar al inicializar y cerrar el formulario mediante el <enter> y <leave> etiquetas.

<form name="recipient" namespace="cus">
  <enter>
    <set…
  </enter>
  …
  <leave>
    <set…
  </leave>
</form>

Lenguaje de expresión expression-language-

Se puede utilizar un lenguaje de macro en la definición del formulario para realizar pruebas condicionales.

El <if expr="<expression>" /> ejecuta las instrucciones especificadas en la etiqueta si se verifica la expresión:

<if expr="([/tmp/@test] == 'Test' or @lastName != 'Doe') and @boolean2 == true">
  <set xpath="@boolean1" expr="true"/>
</if>

El <check expr="<condition>" /> combinado con la etiqueta <error> impide la validación del formulario y muestra un mensaje de error si la condición no se cumple:

<leave>
  <check expr="/tmp/@test != ''">
    <error>You must populate the 'Test' field!</error>
  </check>
</leave>

Asistentes wizards

Un asistente le guía a través de un conjunto de pasos de entrada de datos en forma de páginas. Los datos introducidos se guardan al validar el formulario.

Un asistente tiene la siguiente estructura:

<form type="wizard" name="example" namespace="cus" img="nms:rcpgroup32.png" label="Wizard example" entity-schema="nms:recipient">
  <container title="Title of page 1" desc="Long description of page 1">
    <input xpath="@lastName"/>
    <input xpath="comment"/>
  </container>
  <container title="Title of page 2" desc="Long description of page 2">
    …
  </container>
  …
</form>

La presencia del type="wizard" en el <form> permite definir el modo de asistente en la construcción del formulario. Las páginas se completan desde <container> elementos, que son secundarios del <form> Elemento. El <container> de una página se rellena con los atributos title para que el título y desc muestren la descripción debajo del título de la página. El Previous y Next se añaden automáticamente para permitir la exploración entre páginas.

El Finish guarda los datos introducidos y cierra el formulario.

Métodos SOAP soap-methods

La ejecución del método SOAP se puede iniciar desde un <leave> al final de una página.

El <soapcall> contiene la llamada para el método con los siguientes parámetros de entrada:

<soapCall name="<name>" service="<schema>">
  <param  type="<type>" exprIn="<xpath>"/>
  …
</soapCall>

El nombre del servicio y su esquema de implementación se introducen mediante la variable name y servicio atributos del <soapcall> etiqueta.

Los parámetros de entrada se describen en la <param> elementos bajo el <soapcall> etiqueta.

El tipo de parámetro debe especificarse mediante la variable type atributo. Los tipos posibles son los siguientes:

El exprIn contiene la ubicación de los datos que se van a pasar como parámetro.

Ejemplo:

<leave>
  <soapCall name="RegisterGroup" service="nms:recipient">
    <param  type="DOMElement"    exprIn="/tmp/entityList"/>
    <param  type="DOMElement"    exprIn="/tmp/choiceList"/>
    <param  type="boolean"       exprIn="true"/>
  </soapCall>
</leave>