Sur le web

Création de portlet

 

    Comment créer un portlet dans la page d'accueil

La création d'un portlet passe par plusieurs étapes que nous allons décrire ci-dessous. La connaissance du langage SQL est nécessaire pour élaborer le portlet.

Niveau de difficulté : expert.

 

La création d'une vue (view) peut se révèler nécessaire et conseillée en fonction de la complexité du portlet. Mais vous avez également la possibilité de créer un portlet en ciblant directement les tables. Dans tous les cas, il sera nécessaire de connaître le nom des champs de ou des tables visées. La création de vues est l'objet d'un autre tutorial en savoir plus. Le tutorial se concentre sur la création du portlet qui, vous allez le voir, comporte déjà de nombreuses possiblités/subtilités.

Nous allons imaginer qu'une vue existe dans notre exemple afin de faciliter sa compréhension.


 

    La création d'un état

Pour créer un état personnalisé, allez dans le menu Etats  Création états .

 createetat 1

 

La création d'un état passe par certains champs obligatoires :

Le type : graphique, tableau, indicateur.

Le type graphique offre le choix du type de graphique par la suite.

Le type indicateur est une vignette mettant en avant une donnée chiffrée. Vous pouvez mettre plusieurs vignettes dans un même état.

 

La liste de choix "vue" regroupe l'ensemble des vues créées qui sont succeptibles d'être utilisées pour votre requête. le choix d'une vue affiche les champs qui la compose.

"Partage" : affectez l'état à un ou plusieurs rôles. C'est une liste prédictive multiple.

Le "titre" de l'état sera affiché dans votre portlet, veuillez à ce qu'il soit parlant et d'une longueur raisonnable pour un bon affichage dans la page d'accueil.

"Publipostage" : est une liste d'ancre publipostée sur des valeurs dynamiques tel que l'agent connecté [%AGENTID%], les règles de filtrages [%FILTRAGE%] ou un filtrage précis [%FILTREn%].

 

La partie filtrage permet de limiter les résultats permettant le résultat voulu pour votre état (le bouton filtrage + ajoute une ligne de filtrage). Il faut connaître le nom du champ que vous souhaitez filtrer dans la seconde boite de saisie. La croix en bout de ligne supprime la ligne de filtrage.

 

 

La conception de la requête

 

Exemple pour un tableau :

createetat 3

La requête est ce qui va alimenter votre graphique. Comme vous le constatez cette partie partitionne une requête en langage SQL en 3 parties.

La partie SELECT comporte les champs devant être affichés.

La partie FROM est la liste des tables nécessaires à la requête.

La partie WHERE regroupe les clauses de relations entre les tables, les filtrages. Dans notre exemple vous remarquez que c'est à cet endroit que l'on peut ajouter les critères de GROUP BY et ORDER BY.

La zone "colonne" est l'ordre des colonnes du tableau. Reprenez le nom des champs de votre zone SELECT.

 

Exemple pour un graphique :

createetat 2

 

Le type de graphique parmi une dizaine de choix. Attention : en fonction du choix, les résultats peuvent varier voir ne pas être cohérents (ne pas sélectionner un entonnoire par exemple pour représenter une répartion du CA par produits).

Le titre sera affiché sur le graphique.

La partie requête, qui est le corps de votre état, est détaillée dans l'exemple tableau.

 Le champ catégorie : affiche les valeurs s'affichant dans l'axe des x ou y (en fonction du type de graphique)

Le champ série : affiche les valeurs s'affichant dans l'axe des x ou y (en fonction du type de graphique)

Le champ valeur : affiche les valeurs.

Notez que pour catégorie et série, il y a une seconde boite de saisie "champ nom". Dans notre exemple pour le champ série, le champ agentid est un nombre identifiant chaque agent mais inadapté à l'affichage. Donc on prend le second champ "agentnom" qui est le nom et prénom de l'agent plus parlant à l'affichage.

Les paramètres Légende, catégorie, série .... sont des paramètres d'affichage du graphique en langage CSS et optionnels. Il est nécessaire d'avoir des connaissances en CSS pour remplir correctement ces zones. Attention le CSS est supporté dans une verison simplifié, il sera nécessaire d'appliquer des tests afin de voir les rendus.

 

Exemple pour des indicateurs :
 createetat 4

 

La partie requête, qui est le corps de votre état, est détaillée dans l'exemple tableau.

 Le "titre" est le nom de l'indicateur qui sera affiché sur le portlet.

L'icône est le nom de la librairie font-awesome dont la liste est disponible ici (pensez à ajouter fa- devant le nom de l'icône voulue) : http://fontawesome.io/icons/

La couleur est le code couleur de font de l'indicateur en hexa dont vous aurez une palette en cliquant sur la zone colorée à droite de la boite de saisie.

Vous pouvez ajouter plusieurs indicateurs dans un même portlet afin de créer un mur de chiffres clés.

Pensez à valider votre état via le bouton vert en bas de page.

 

Gestion portlet

Allez dans le menu  Paramètres   > Conception avancée  Gestion portlet

Cette page permet l'affichage de l'état dans un portlet. Elle crée un nouvel onglet dans la page d'accueil.

 

gestionportlet 1

La partie Gestion Groupe va créer un groupe de portlets dans un nouvel onglet de la page d'accueil (pour le moment seule cette page est proposée dans la liste de choix "page").

Nommez votre groupe qui sera reporté sur le nom de l'onglet.

L'ordre d'affichage est l'ordre des onglet.
Attention : l'onglet par défaut de la page d'accueil sera toujours en premier. Par contre la case à cocher "Défaut" affichera votre groupe par défaut lors du chargement de la page d'accueil.

"Partage" sert à déterminer à quel rôle agent, le groupe de portlets est à afficher. Une fois le groupe créé via le bouton vert "insérer" vous aurez la possibilité d'insérer les différents portlet le composant

 

gestionportlet 2

La zone "Choix tableau de bord" est la liste des portlets. Le bouton "+ ajouter" sert à ajouter une nouvelle saisie de portlet.

La croix en haut à gauche de chaque portlet retire le portlet du groupe.

A noter qu'à chaque validation d'un groupe, cela ré-initialise les paramètres par défaut pour les agents.

Comment est composé la configuration d'un portlet :

- Choisir les tableaux de bords parmi ceux qui sont prédéfinis et vos propres créations. Ainsi, il est possible d'organiser les tableaux de bords par thématiques et libre de choix dans l'organisation qui vous conviendra.
- Ordre d'affichage : Ordre d'affichage du tableau de bord dans le groupe.
- Masquer : masquer par défaut le tableau de bord
- Exporter : permettre l'export du tableau de bord
- Verrouiller : empêche l'agent d'interagir avec le tableau de bord.
- Filtrage : liste les filtrages disponible pour le tableau de bord où vous pouvez placer des valeurs par défaut. (voir la roue crantée dans chaque portlet de la page d'accueil).

Dans l'exemple ci-dessus, le tableau de bord (portlet) po36 a 7 options de filtrage utilisateur. C'est un tableau sur les tickets, le filtrage nbenr est le nombre de lignes à afficher, le filtrage chx_ste est le choix de la société, chx_periode est la période de la création des tickets ... une explication sur les filtrages est disponible dans le logiciel et n'hésitez pas à les tester afin de voir ce qui conviendra le mieux à votre portlet.