Definición del menú

El menú de navegación para una aplicación AWE se define en archivos XML. Los dos archivos XML del menú son:

• public.xml: Contiene las pantallas públicas (aquellas a las que se puede acceder sin iniciar sesión en el sistema).
• private.xml: Pantallas dentro de la protección de una sesión del sistema

:::Nota: Todos los descriptores XML del menú están definidos en la carpeta de menú. Ver la estructura de proyecto para más información. :::

Estructura del menú

Los archivos de menú deben tener la siguiente estructura:

<menu screen="[initial-screen]" context="[default-context]" default-action="[default-action]">
</menu>

Atributo	Uso	Tipo	Descripción	Valores
screen	Obligatorio	String	Es la pantalla por defecto que se mostrará al principio
context	Opcional	String	Es el contexto donde se lanzarán todas las opciones (si no se define un contexto específico)	Ver contextos
default-action	Opcional	String	Es la acción a la que llamarán todas las opciones (si no se define una acción específica)

Hay una nueva etiqueta también para definir la posición, y el tipo de menú dentro de una pantalla: menu-container:

<menu-container type="[orientation]"/>

Donde [orientation] puede ser vertical u horizontal. Otra forma de cambiar el tipo de menú es seleccionando la pantalla de menú inicial en el archivo private.xml:

<menu screen="HomHor"…

Para menú horizontal

<menu screen="HomVer"…

Para menú vertical

Contextos

El atributo context define dónde se van a lanzar las opciones definidas dentro del menú. Hay varios contextos definidos que pueden ser usados dependiendo del tipo de menú:

Ruta del contexto	Menú	Descripción
screen	public	Útil para una sola página de inicio de sesión sin menú
screen/public/home	public	Este contexto se utiliza cuando la página principal debe tener un menú. En este caso, el parámetro screen.configuration.home no debe **** estar vacío, ya que esta será la pantalla mostrada dentro del menú. La pantalla inicial del contenedor de menú será la definida en el atributo de la pantalla de menú
screen/private/home	private	Este contexto se utilizará cuando se registre en la aplicación. En este caso el parámetro screen.configuration.information no debe **** estar vacío, ya que esta será la pantalla mostrada dentro del menú privado (cuando el usuario y el perfil no tienen ninguna definición inicial de pantalla). La pantalla inicial del contenedor de menú será la definida en el atributo de la pantalla de menú

Estructura de opciones

Esta es la estructura de código de un conjunto de opciones:

<option module="[module]" name="[Option name]" label="[Option label] icon="[Icon option]">
  <option name="[Option name]" label="[Option label]" screen="[Screen name]"/>
  ---
</option>
---
<option/>

Dentro de la opción de herramientas hay un conjunto de opciones, algunas de ellas son "invisibles". Es necesario definir todas las pantallas a las que puede acceder el usuario, porque si una pantalla no está definida en el menú no será accesible para ningún usuario. Además, puedes añadir opciones dentro de las opciones, creando un menú de varios niveles.

Atributo	Uso	Tipo	Descripción	Valores
name	Obligatorio	String	Es el nombre de la opción, que se utiliza en los archivos de perfil y en la tabla AweScrRes para restringir el acceso a una opción. Si una opción padre está restringida, todas las opciones hijas también están restringidas
screen	Opcional	String	Define la pantalla a la que se accederá cuando el usuario haga clic en la opción
label	Opcional	String	Es un literal que contiene el nombre de la opción	Note: You can use i18n files (locales)
module	Opcional	String	Define el nombre del módulo. Se pueden definir varias opciones de menú por cada módulo	Estos nombres de módulos deben configurarse en la tabla AweMod y debe haber definida una variable de sesión para el módulo
separator	Opcional	Boolean	Si se establece en true, la opción se convierte en una línea separadora	El valor predeterminado es falso
icon	Opcional	String	Define un icono que se mostrará antes del texto de la opción	Puedes ver toda la lista de iconos aquí

Ejemplos

<menu screen="home_horizontal" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:noNamespaceSchemaLocation = "../../sch/menu.xsd" context="screen/home" default-action="screen">
  <option name="information" screen="info" invisible="true" />
  <option module="Inf" name="information_restricted" screen="info" invisible="true" />
  <option module="Inf Changed" name="information_restricted_changed" screen="info" invisible="true" />
  <option name="tools" label="MENU_TOOLS" icon="wrench">    
    <option name="themes" label="MENU_TOOLS_THEMES" screen="Thm" icon="picture-o"/>
    <option name="new_theme" screen="ThmNew" invisible="true" />
    <option name="update_theme" screen="ThmUpd" invisible="true" />
    <option name="view_theme" screen="ThmViw" invisible="true" />
    <option name="security" label="MENU_TOOLS_SECURITY" icon="unlock-alt">
      <option name="screen_access" label="MENU_TOOLS_SCREENS_ACCESS" screen="ScrAccRes" icon="eye-slash"/>
      <option name="encrypt_tools" label="MENU_TOOLS_SCREEN_ENCRYPT" screen="ScrEncTxt" icon="lock"/>
    </option>    
  </option>
  <option name="HlpSep" separator="true"/>
  <option name="help" label="MENU_HELP" icon="question-circle">
    <option name="user_help" label="MENU_USER_HELP" screen="Hlp" icon="question"/>
    <option name="application_help" label="MENU_HELP_APPLICATION" screen="AppHlp" icon="question"/>
    <option name="application_info" label="MENU_APP_INF" screen="ViwAppInf" icon="info"/>
  </option>
</menu>