Comment ? / How To ?

Introduction

Cette partie du How To détaille la mise à place du module Dashboard de la création des données à visualiser à l'intégration de son composant dans une application AP4.

Prérequis

Recommandation

Si vous n’êtes pas familier avec le module Dashboard et le fonctionnement de son ETL, il est fortement recommandé de lire la documentation associée.

Pour suivre ce guide, il est nécessaire d'avoir ajouté le module @anakeen/dashboard à votre projet, par exemple via :

npx @anakeen/anakeen-platform install --flavour custom --cwd .

Il faut également avoir :

  • un serveur Superset actif
  • mis en place et configuré l'ETL

Pour ce faire, il est possible de configurer rapidement un environnement de développement en activant les extensions du module Dashboard.

Activer et configurer les extensions du module Dashboard

Les extensions suivantes sont disponibles pour nous aider au développement :

  • dashboard-etl : déploie un conteneur docker contenant l'ETL
  • superset : déploie deux conteneurs :
    • un conteneur superset exposant une application Superset sur le port 8088
    • un conteneur redis pour gérer le cache de Superset

Activer les extensions

Dans notre Makefile.local.mk, ajoutons les instructions suivantes pour activer les extensions dashboard-etl et superset:

include $(ADDONS_DIR)/dashboard-etl/Makefile.params.mk
include $(ADDONS_DIR)/superset/Makefile.params.mk

Connecter l'ETL

L'ETL a besoin d'un jeton HTTP pour communiquer de manière sécurisée avec AP4. Générons ce jeton :

make generate-etl-token

et renseignons-le dans notre Makefile.local.mk :

include $(ADDONS_DIR)/dashboard-etl/Makefile.params.mk
include $(ADDONS_DIR)/superset/Makefile.params.mk

DASHBOARD_ETL_TOKEN = <token>

Redémarrons ensuite l'environnement :

make env-stop
make env-start

Connecter Superset

Connecter la base de données

Connectons la base PostgreSQL dédiée à Superset :

make superset-init

Renseigner l'adresse publique

Dans l'interface d'administration Tableaux de bord > Configuration, modifions l'URL de Superset en renseignant son adresse publique :

http://supermain:8088    ->    http://192.______:8088

Attention

Pensez à tester la connexion avec Superset une fois l'URL modifiée.

Information

Cette modification est nécessaire pour, à terme, visualiser les tableaux de bord dans votre application.

Vérifier les connexions

Le statut de l'ETL ainsi que celui de Superset sont visibles dans l'interface d'administration, onglet Tableaux de bord.

Et ensuite ?

Comment ajouter des données à visualiser ?