¿Qué es y para qué sirve el contenedor de aplicaciones?

El contenedor de aplicaciones es la barra de navegación que puede verse en la parte superior de esta página. Su labor es unificar el acceso a todos los sistemas de información de la organización en un único punto, facilitando el acceso por parte de los técnicos a cualquiera de las aplicaciones.

¿Cómo hacer uso del contenedor de aplicaciones?

Para integrarlo en una aplicación, deberemos cargar el Javascript asociado, definir el elemento HTML donde queremos que aparezca, y ejecutar el script de carga.

¿Cómo obtener la ruta desde donde se sirve el recurso?

La organización cuenta con un sistema denominado Gestor de Metadatos Comunes que permite manejar absolutamente todas las propiedades relativas a las configuraciones de las aplicaciones y obtener los valores de las propiedades que nos interesan mediante una API REST.

El uso del Gestor de metadatos comunes permite que las aplicaciones NO almacenen valores de propiedades de configuración. Con esto se consigue que la actualización de dichas propiedades sea mucho más sencilla porque se realiza en un único lugar.

Para obtener el valor concreto de una de las propiedades de configuración, deberá realizarse una consulta a la API de de metadatos comunes (API pública y sin autenticación) para obtener el valor de la propiedad que le interesa.

Para realizar dicha consulta, sólo necesitaremos dos cosas:

• Conocer dónde se encuentra desplegada la Api de metadatos comunes
• Conocer la clave de la propiedad a consultar

La información sobre el endpoint de la API de metadatos comunes así como de las claves a consultar debe almacenarse en un fichero de propiedades de configuración que permita que la actualización de las mismas se pueda realizar sin modificar el código de la aplicación. Esto es muy importante, que el valor pueda modificarse sin modificar el código de la aplicación porque los valores son dependientes del entorno.

Definimos en un fichero de propiedades externo a la aplicación los siguientes pares de clave/valor:

    common-metadata.endpoint=‘//estadisticas.arte-consultores.com/cmetadata/v1.0/properties/’
    common-metadata.propertie.navigation-bar-internal=‘metamac.navbar.url’        

Realizamos una petición a la API, construyendo la URL correcta

    // common-metadata.endpoint + common-metadata.propertie.navigation-bar-internal
    http://estadisticas.arte-consultores.com/cmetadata/v1.0/properties/metamac.navbar.url
        

Lo cual nos daría el siguiente resultado

    <cmetadata:property xmlns:cdomain="http://www.siemac.org/metamac/rest/common/v1.0/domain" xmlns:cmetadata="http://www.siemac.org/metamac/rest/common-metadata/v1.0/domain" kind="commonMetadata#property">
        <cmetadata:key>metamac.navbar.url</cmetadata:key>
        <cmetadata:value>//estadisticas.arte-consultores.com/navigation-bar-internal/</cmetadata:value>
    </cmetadata:property>
        

¿Cómo cargar el contenedor de aplicaciones?

Ahora que sabemos la URL desde donde se sirve el contenedor de aplicaciones, basta con incluir la ruta al script del contenedor en la página, por ejemplo:

    <script src="//estadisticas.arte-consultores.com/navigation-bar-internal/js/metamac-navbar.js"></script>

Y a continuación, comenzar la carga del contenedor mediante:

    <div id="metamacNavBar"></div>
    <script>        
        MetamacNavBar.loadNavbar();
    </script>

Esto cargará los estilos asociados a la barra de navegación y dibujará el contenedor en el elemento HTML con id metamacNavBar. El método loadNavbar también permite recibir opciones de configuración en el caso de querer modificar el elemento HTML donde ha de dibujarse. Por ejemplo:

    <div id="myCustomId"></div>
    <script>                        
        MetamacNavBar.loadNavbar({
            element: "myCustomId"
        });
    </script>