Les interactions entre tableaux de bord intégrés en API

Sur les tableaux de bord intégrés en API (embedded analytics), vous avez la possibilité d'ajouter sur les entêtes de lignes des tableaux croisés un bouton vous permettant d'effectuer l'action de votre choix, comme par exemple afficher un nouveau tableau de bord contextualisé en fontion de l'élément cliqué par l'utilisateur.

Configuration du tableau de bord

Pour configurer cette option dans un tableau de bord, vous devez d'abord cocher l'option "Accessible en API" dans le menu "Partager", puis cliquez sur le bouton "Configurer les interactions et la mise en page" (voir Interactivité d'un composant) d'un tableau croisé.

En cliquant sur le bouton "Configurer", vous pouvez choisir le ou les niveaux sur lesquels sera affiché le bouton, ainsi que le tooltip de ces boutons.

Une fois configuré, le bouton apparaitra, sur le tableau de bord intégré, au survol de la souris pour les entêtes choisies.

Affichage du bouton au survol de la cellule "Phoenix"

Limitations

• Les éléments de données de type Date ne sont pas compatibles avec cette fonctionnalité.

• Si vous souhaitez exploiter les éléments des niveaux inférieurs au niveau cliqué, ces éléments ne doivent être présents que dans un seul niveau supérieur.

Implémentation dans l'application parente

Lorsque l'utilisateur clique sur un des boutons d'entête, un message de type "PivotHeaderClicked" est envoyé à la fenêtre contenant l'Iframe du tableau de bord.

Vous devez ensuite appeler la fonction GetTokenAdditionalData pour récupérer les informations concernant l'entête de ligne sur laquelle l'utilisateur a cliqué.

Permet de récuperer les données supplémentaires liées à un token

GET https://api.biwee.fr/EmbeddedDashboard/GetTokenAdditionalData/:apiKey/:tokenGuid

Path Parameters

Name	Type	Description
apiKey*	String	Votre clé d'Api
tokenGuid*	String	Le token que vous avez utilisé pour afficher l'Iframe

200: OK

Cette fonction vous retourne la structure suivante au format JSON :

{
	"Name": "Nom",
	"Index": 1,
	"Value": "Valeur",
	"Rows": [
		{
			"Name": "Nom",
			"Index": 2,
			"Value": "Valeur",
			"Rows": []
		}
	]
}

• Name : Nom de l'élément de données sur lequel l'utilisateur a cliqué

• Index : Position dans l'arborescence de cet élément de données (l'index commence à 0)

• Value : Valeur de l'élément sur lequel l'utilisateur a cliqué

• Rows : Liste des enfants de l'élément sur lequel l'utilisateur a cliqué (si présents)

Grâce à ce mécanisme, vous allez pouvoir, par exemple, lier plusieurs tableaux de bord entre eux, qui pourront être affichés de la manière que vous souhaitez (pop in, pop up, nouvel onglet...).

Pour cela vous devez :

• créer un tableau de bord de destination contenant des requêtes paramétrées

• faire un appel IRAME à ce tableau de bord dans votre application avec le type d'affichage souhaité

• lors de l'appel IFRAME du tableau de bord de destination, transmettre les informations récupérées précédemment en JSON pour initialiser les paramètres de requête