Manuel de référence

# Gestion des tableaux de bord

# Ajouter/modifier un tableau de bord

L'ajout d'un tableau de bord et l'édition des rôles suffisants pour le consulter peut se faire de deux manières :

  • via un fichier de configuration
  • via l'interface d'administration (avec un utilisateur possédant le rôle dashboard-admin)

Nous ne présenterons ici que la méthode reposant sur un fichier de configuration, l'utilisation de l'interface d'administration étant détaillée ici.

# Modèle du fichier de configuration

La configuration de la liste des tableaux de bord et de leurs droits d'accès peut être réalisée avec un fichier de configuration XML. Ce fichier doit utiliser le namespace https://platform.anakeen.com/4/schemas/dashboard-config/1.0.

Les propriétés à référencer sont :

  • la liste des tableaux de bord en précisant au moins leur référence
  • la liste des rôles autorisés à consulter chacun d'entre eux
<?xml version="1.0" encoding="UTF-8"?>
<dashboard:list xmlns:dashboard="https://platform.anakeen.com/4/schemas/dashboard-config/1.0">

	<dashboard:config ref="ref1" title="Title 1">
		<dashboard:role name="role_1" />
	</dashboard:config>

	<dashboard:config ref="ref2">
		<dashboard:role name="role_2" />
		<dashboard:role name="role_3" />
        ...
	</dashboard:config>
    ...
</dashboard:list>

Attention

La référence doit être unique et les rôles référencés doivent exister. Le titre est optionnel.

# Importer la liste des tableaux de bord et de leurs accès

L'import de la configuration se fait à l'aide du script importDashboardAccess :

./ank.php --script=importDashboardAccess --file=<fichier>

Si les accès à Superset n'ont pas encore été définis, le script les demandera de façon interactive et les sauvegardera. Il est également possible de les préciser/remplacer en option.

# Options

  • --ss_login : nom d'utilisateur de l'administrateur Superset
  • --ss_password : mot de passe de l'administrateur Superset
  • --ss_domain : URL du serveur Superset

Informations

L'édition de la sécurité d'un tableau de bord peut également se faire via ce même fichier de configuration. Si la référence correspond à un tableau de bord existant sa liste de rôles sera remplacée.

# Mise en page

L'import de la liste des tableaux de bord ou l'ajout de nouveaux tableaux de bord dans l'interface d'administration initialise au niveau de Superset des tableaux vides prêts à être intégrés dans une application. L'étape suivante consiste à personnaliser leur mise en page dans l'application Superset.

Attention

Un tableau directement créé dans Superset ne sera pas référencé dans AP4 et ne pourra donc pas être intégré dans une application.

# Import/Export

# Export

L'export de l'ensemble des tableaux de bords, des graphiques associés ainsi que de leur accès se fait à l'aide du script exportDashboardConfig :

./ank.php --script=exportDashboardConfig

# Résultat

Génère une archive .zip comportant :

  • DashboardAccess.xml : un fichier de configuration contenant la liste des tableaux de bord et de leurs accès
  • DashboardAssets.zip : une archive générée par Superset contenant la description de l'ensemble des graphiques, de la mise en page respective de chaque tableau de bord, etc.

# Options

  • --dir : répertoire cible
  • --noAccess : ne pas exporter le fichier de configuration
  • --noAssets : ne pas exporter l'archive générée par Superset

# Import

L'import de l'archive (partielle ou non) créée lors de l'export se fait à l'aide du script importDashboardConfig :

./ank.php --script=importDashboardConfig --file=<configFile.zip>

Il est nécessaire de renseigner le mot de passe de la base de données dédiée à Superset, le script le demandera de façon interactive. Il est néanmoins possible de le préciser en option :

--db_password=<password>

Si les accès à Superset n'ont pas encore été définis, le script les demandera de façon interactive et les sauvegardera. Il est également possible de les préciser/remplacer avec les options :

--ss_login=<login>
--ss_password=<password>
--ss_domain=<url>

← API REST →