El Web Client de InterAction se puede configurar editando archivos de configuración XML. InterAction utiliza una serie de archivos XML para determinar las páginas que los usuarios ven al trabajar en el Web Client. Estos archivos se almacenan en el Servidor de Aplicaciones.
XML (Lenguaje de Marcado Extensible) es un lenguaje de marcado similar a HTML. La diferencia clave es que XML es más estructurado y ampliable: un documento XML puede usar un conjunto personalizado de etiquetas de marcado. Para obtener más información sobre XML en general, consulta Descripción general de la edición de archivos XML.
Hay tres tipos principales de archivos XML que normalmente se utilizan al configurar el Web Client:
- Declaraciones de métodos de página que definen las páginas que ves al trabajar en el Web Client. Un método de página determina la estructura general y el contenido de la página.
- Declaraciones de listas de nuggets que definen listas de enlaces que se pueden colocar en una página.
- Declaraciones de listas de búsqueda que también definen listas de enlaces. Normalmente se usan para listas más simples que las listas de nuggets, como los enlaces en la página de inicio.
Esta referencia describe cada uno de los elementos XML (también llamados etiquetas) disponibles en los archivos de configuración.
Otro tipo de declaración se utiliza para configurar menús. Las declaraciones de menús no se cubren en esta referencia, pero para obtener detalles sobre cómo configurar el menú lateral, consulta Descripción general de la personalización del menú principal de Web Client.
Antes de usar esta referencia y configurar el Web Client, deberías estar familiarizado con los conceptos básicos de XML. Deberías entender los siguientes términos y conceptos:
- Elementos y etiquetas
- La diferencia entre etiquetas de apertura y cierre
- Anidar una etiqueta dentro de otra etiqueta
- Atributos
- Asignar valores a los atributos
- Hacer que un documento XML esté bien formado
Si no estás familiarizado con estos conceptos, consulta Descripción general de la edición de archivos XML para obtener una visión general. Ten en cuenta que necesitas sentirte cómodo trabajando con XML para poder configurar el Web Client de InterAction.
Ten en cuenta que no necesitas editar los archivos XML para crear o editar perfiles de Web Client o formularios de búsqueda.
Uso de la referencia XML
Existen varias formas de obtener información sobre los archivos XML utilizados para configurar el Web Client de InterAction.
Para una visión general de alto nivel de los tres tipos principales de archivos de declaración XML, consulta las siguientes secciones:
- Descripción general de las declaraciones de métodos de página
- Descripción general de las declaraciones de listas de nuggets
- Descripción general de las declaraciones de listas de búsqueda
Para obtener detalles sobre los elementos y atributos individuales que puedes usar dentro de cada uno de estos tipos de archivos, consulta:
- Elementos y atributos para una declaración de método de página
- Elementos y atributos para una declaración de lista de nuggets
- Elementos y atributos para una declaración de lista de búsqueda
Estas secciones proporcionan ejemplos de código e información detallada sobre los elementos y atributos. Para cada elemento, la referencia proporciona lo siguiente:
- Nombre y descripción del elemento.
- La lista de otros elementos que se pueden anidar dentro del elemento.
- Los atributos que se pueden establecer para el elemento.
- Cualquier otra nota o ejemplo necesario.
Cómo buscar información XML
Puedes buscar etiquetas XML en las secciones que siguen. Utiliza esta información sobre XML para encontrar lo siguiente:
-
Elementos XML (etiquetas) que puedes usar en los archivos de configuración. Por ejemplo, puedes buscar <description>. Dado que los métodos de página, las listas de nuggets y las declaraciones de listas de búsqueda usan etiquetas con nombres idénticos, se listan en el índice con el tipo de declaración entre paréntesis, de la siguiente manera:
<description> (listas de nuggets)
<description> (métodos de página)
-
Atributos que puedes establecer para una etiqueta XML. Las etiquetas a las que se aplica un atributo aparecen debajo del nombre. Por ejemplo, el atributo class se puede establecer para tres etiquetas diferentes, por lo que aparece así:
-
Palabras clave que puedes usar al establecer valores de etiquetas o atributos. Estas se muestran de forma similar a los atributos. Por ejemplo, la palabra clave modal se puede usar con dos etiquetas diferentes, por lo que aparece así:
- Nuggets y parámetros de nuggets que se mencionan en las distintas secciones de referencia. Ten en cuenta que esta guía no proporciona una referencia completa de todos los nuggets disponibles, aunque los nuggets más utilizados se explican en las secciones de referencia.
Cómo ingresar URLs en las declaraciones del Servidor de Aplicaciones
Varias declaraciones del Servidor de Aplicaciones requieren que ingreses URLs a otras páginas del Web Client. Por ejemplo, en una declaración de lista de búsqueda, debes proporcionar una URL para la página que debe mostrar un enlace.
Para usar la URL de otra página del Web Client, normalmente proporcionas un valor como el siguiente:
$(PAGE_SERVER)/contact-lists-home?folderclass=1&
searchdescription=Contact+Types&folderType=All
Este valor se desglosa de la siguiente manera:
- $(PAGE_SERVER) es una variable que se reemplazará por la ubicación real del servidor de páginas en tu entorno.
- contact-lists-home es el nombre del método de página para la página que se va a mostrar.
- Los valores restantes después del signo de interrogación (?) son parámetros que envían información a la página. Esto se conoce como cadena de consulta.
Si tu Servidor de Aplicaciones se llamara “AppServer1”, la URL anterior se resolvería como:
http://AppServer1/InterAction/contact-lists-home?folderclass=1&
searchdescription=Contact+Types&folderType=All