Especificaciones sobre las URLS que se utilizan para invocar Dashboards
Introducción
Hay cuatro URLs para acceder a los dashboards: dos en modo vista y dos para el modo edición. Hay dos de cada, ya que unas son URLs view o editfull que se invocan desde control panel y viewiframe y editfulliframe que se invocan embebidos en iframes o desde el wrapper del dashboard.
…/controlpanel/dashboards/view/{id}
…/controlpanel/dashboards/editfull/{id}
…/controlpanel/dashboards/viewiframe/{id}
…/controlpanel/dashboards/editfulliframe/{id}
En estas cuatro URLs, {id} es el identificador del dashboard.
…/controlpanel/dashboards/view/{id}
¿Cuándo utilizarla?
Esta URL se utiliza para acceder a un dashboard en modo vista, no pudiendo modificar gadgets ni dashboard.
Es la URL que se invoca desde control panel para abrir el dashboard en modo vista.
¿Qué seguridad se le aplica para poder acceder?
Se accede a partir de las cookies del navegador tras haber iniciado una sesión en plataforma.
También se puede acceder utilizando el parámetro oauthtoken. Por ejemplo, desde el navegador lanzaríamos esta URL (En este caso, usamos como host el lab de onesaitplatform):
https://lab.onesaitplatform.com/controlpanel/dashboards/view/6dba9148-b807-4104-a118-9d897cf44ee7?oauthtoken={OAuth2 Token}
{OAuth2 Token} es el token de oauth2, sin el prefijo Bearer. Por ejemplo, si nuestro token es :
“Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwcmluY2lwYWwiOiJhZG1pbmlzdHJhdG9yIiwiY2xpZW50SWQiOiJvbmVzYWl0cGxhdGZvcm0iLCJ1c2VyX25hbWUiOiJhZG1pbm...”
asignaríamos al parámetro el siguiente valor : https://lab.onesaitplatform.com/controlpanel/dashboards/view/6dba9148-b807-4104-a118-9d897cf44ee7?oauthtoken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwcmluY2lwYWwiOiJhZG1pbmlzdHJhdG9yIiwiY2xpZW50SWQiOiJvbmVzYWl0cGxhdGZvcm0iLCJ1c2VyX25hbWUiOiJhZG1pbm...
…/controlpanel/dashboards/editfull/{id}
¿Cuándo utilizarla?
Esta URL se utiliza para acceder a un dashboard en modo edición, permite modificar, añadir o eliminar gadgets, cambiar estilos, crear pestañas para tener varias páginas dentro del dashboard, etc .
Es la URL que se invoca desde control panel para abrir el dashboard en modo edición.
Con esta URL tenemos acceso a la botonera de edición del dashboard completa, sin ninguna limitación, la cual se mostrará ajustada en la parte superior derecha del dashboard, además permite editar los gadgets accediendo a los formularios para edición de gadgets del control panel, clicando en la opción edición del menú en la cabecera de los gadgets.
También permite crear gadgets o utilizar los ya creados arrastrandolos desde la opción añadir elemento.
¿Qué seguridad se le aplica para poder acceder?
Para tener acceso total a todas las opciones que se permiten desde el editor, es necesario tener iniciada una sesión en plataforma en el navegador.
También se puede acceder mediante el parámetro oauthtoken pero nos encontraremos con el problema de que parte de las opciones de edición no funcionarán como son crear un gadget nuevo de los tipos barra, pie, tabla…, o editar gadgets de estos tipos, debido a que al no haber creado una sesión no se tiene acceso a estas pantallas de control panel.
…/controlpanel/dashboards/viewiframe/{id}
¿Cuando utilizarla?
Esta URL se utiliza para acceder a un dashboard en modo vista, no pudiendo modificar gadgets ni dashboard. Se utiliza para mostrar un dashboard embebido en un iframe o un ejemplo de iframe desde el wrapper del dashboard:
<iframe id="sonIframe" src="https://lab.onesaitplatform.com/controlpanel/dashboards/viewiframe/6dba9148-b807-4104-a118-9d897cf44ee7?oauthtoken={OAuth2 Token}" style="height: 500px;width: 100%;background-color: #abcbea"></iframe>
Esta URL funciona igual que /view/ y se ha mantenido por retro compatibilidad con versiones anteriores de la plataforma, ya que en versiones anteriores no se podía acceder con el oauthtoken desde la URL /view/.
¿Qué seguridad se le aplica para poder acceder?
Se puede acceder utilizando el parámetro oauthtoken.
También se accede a partir de las cookies del navegador tras haber iniciado una sesión en la plataforma.
…/controlpanel/dashboards/editfulliframe/{id}
¿Cuando utilizarla?
Esta URL se utiliza para acceder a un dashboard en modo edición embebido en un iframe o desde el wrapper de dashboard. Permite modificar, añadir o eliminar gadgets, cambiar estilos, etc.
Es la URL que se invoca desde control panel para abrir el dashboard en modo edición.
Con esta URL, podemos tenemos acceso a la botonera de edición del dashboard limitada, o no mostrarla. Dentro de las limitaciones, no permite editar los gadgets accediendo a los formularios para edición de gadgets del control panel, y ciertos elementos del menú de los gadgets también están limitados.
En esta entrada se explica con mayor detalle como configurar qué ver y qué no ver, al acceder en modo edición embebida:
https://onesaitplatform.atlassian.net/l/c/v63QNRAb
Sin embargo, está preparado para poder comunicarse desde el elemento padre del iframe en caso de estar embebido en un iframe mediante mensajes, pudiendo crear y añadir gadgets al dashboard, editar los ya existente, guardar el dashboard, etc., como se explica en este post :
https://onesaitplatform.atlassian.net/l/c/VyVhXYqK
¿Qué seguridad se le aplica para poder acceder?
Para tener acceso total a todas las opciones que se permiten desde el editor, es necesario tener iniciada una sesión en plataforma en el navegador.
También se puede acceder mediante el parámetro oauthtoken pero entonce snos encontraremos con el problema de que parte de las opciones de edición no funcionarán, por ejemplo: crear un gadget nuevo de los tipos barra, pie, tabla, …, o editar gadgets de estos tipos, debido a que, al no haber creado una sesión, no se tiene acceso a estas pantallas de control panel.
Aplican a todos los tipos de URLs
Especificaciones uso de Multitenants
Cuando en la instalación de plataforma está configurada en modo multitenat, es necesario especificar los parámetros vertical y username en la URL para poder abrir los dashboards correspondientes al tenant y vertical correcto, por ejemplo:
https://lab.onesaitplatform.com/controlpanel/dashboards/viewiframe/6dba9148-b807-4104-a118-9d897cf44ee7?oauthtoken=ffqerqwerf…&vertical=vertical001&username=username001
Especificaciones sobre paso de parámetros por URL
Cuando se invoca un dashboard, se puede configurar para que éste reciba unos parámetros específicos y, con ellos, realizar filtrados en los datos de los gadgets.
Definiremos estos parámetros cuando estamos editando el dashboard en el icono de URL Parameters:
Podemos indicar si son obligatorios o no. Si son obligatorios y no viene definidos en la URL, el dashboard los pedirá mediante un popup.
En este post se explica más detalladamente este punto: