...
Ces dashboard entités peuvent recevoir des widgets one qui ont été conçus pour l’entité uniquement. A cette fin il existe la notion de catalogue afin de donner à l’utilisateur une liste de widgets pour son entité
...
Les fichiers JSON catalogue et widget
Voici quelques informations techniques concernant l’organisation des données qui permettent d’utiliser les widgets.
Les widgets entité sont nécessairement liés à un module diva et à une fonction diva qui retourne les valeurs attendues.
Fichier JSON widget entité
Chaque widget entité est décrit via 2 fichier deux fichiers JSON
DATASOURCE
Nommage : codeModule + '_' + famille + typeWidget + nomWidget + “.datasource.json”
par exemple gt_art_graph_TopFournisseurs.datasource.json
indique le module diva et la fonction diva à appeler, et les colonnes nécessaires au rendu
Les balises ‘Module’ et ‘Function’ indique le code diva
Balises ‘Type’ et ‘Mapping’: ouvrir un widget qui a le même rendu visuel et en copier la structure
Exemple de contenu
Bloc de code |
---|
{ "Type": "infinityGraphSource", "Mapping": { "AbscissLabelField": "abscissLabel", "AbscissValueField": "abscissValue" }, "Module": "gttmdashboard001.dhop", "Function": "art_graph_TopFournisseurs" } |
...
WIDGET
Nommage : codeModule + '_' + famille + typeWidget + codeWidget + “.widget.json”
par exemple gt_art_graph_TopFournisseurs.widget.json
indique le type de rendu/layout de layout, et les informations d’affichage comme le titre, les libellés, la taille. Sert au binding entre le retour de la fonction diva et le rendu visuel
La balise ‘Label’ contient le nom qui sera affiché à l’utilisateur
Autres balises : ouvrir un widget qui a le même rendu visuel et en copier la structure
Exemple de contenu
Bloc de code |
---|
{ "Children": { "graphTest": { "Type": "graph", "Title": "Nombre affaires / opportunités en cours utilisant mon article réparti par type d'arborescence d'affaire", "DataSource": "gt_art_graph_AffairesBesoin_Arbo", "Series": [ { "Label": "EvtCrm", "ValueField": "PieValue", "GraphType": "donut" } ] } }, "Label": "Nombre affaires / opportunités en cours utilisant mon article réparti par type d'arborescence d'affaire", "Icon": "chart-line", "Description": "Nombre affaires / opportunités en cours utilisant mon article réparti par type d'arborescence d'affaire", "ColSpan": 6, "RowSpan": 2 } |
...
Nommage : codeModule + '_' + famille + codeCatalogue + “.catalog.json”
par exemple gt_art_vente.catalog.json
liste les widgets entités, pour chaque entité
La balise ‘Label’ contient le nom qui sera affiché à l’utilisateur
La balise ‘WidgetNames' liste les ficheir fichiers JSON widget (sans extension)
Exemple de contenu
...
Un dashboard de widgets est un fichier JSON qui indique quels sont les catalogues de widgets disponibles pour une entité, et quels sont ceux du dashboard par défaut (visible dans le zoom one d’une entité)
...
Info |
---|
Les fichier fichiers nommé HOME_xxx.catalog.json sont les dashboard pour l’IA ajoutés pour l’interface d’accueil one |
...
Pour cela il est indispensable d’installer Microsoft Visual code (gratuit) et un composant Divalto qui permet de naviguer dans les fichiers JSON du serveur après connexion au projet. Plus d’informations en suivant ce lien Utilisation de Divalto Studio
Il faut ensuite, selon la modification que l’on souhaite apporter, modifier le ou les fichiers JSON selon les règles suivantes.
Création d’un widget entité de surcharge
Pour la création d’un widget complémentaire, suivez le chapitre ci-dessus “Fichier JSON widget entité” qui décrit les fichiers JSON d’un widget entité, et prenez un exemple de widget dont le comportement est proche au niveau du rendu, donc par exemple prendre pour modèle un widget ‘tableau’ si l’on souhaite créer un nouveau tableau, et de préférence dans le même module.
Les fichiers JSON seront nécessairement dépendants d’un module diva de surcharge xxTMDASHBOARDyyy.dhsp qui construit la chaîne JSON envoyée au widget
...
Astuce |
---|
Pour illustration dans ce qui suit, on prend pour exemple un nouveau widget nommé “ugt_art_graph_top” qui est décrite décrit par deux fichiers JSON ugt_art_graph_top.widget.json et ugt_art_graph_top.datasource.json |
...
L’ajout de widget entité se fait en deux trois phases
Surcharge du masque écran de zoom de l’entité concernée
Création d’un fichier JSON “catalogue surcharge” avec le nouveau widget
Création d’un fichier JSON “dashboard” “dashboard avec surcharge” avec le nouveau catalogue
...
La première phase consiste à s’assurer d’avoir un masque écran de surcharge dans le projet client (par exemple gtez000_sql.dhsf qui est la surcharge de gtez000_sql.dhsf), afin d’obtenir un objet de surcharge. La surcharge n’implique pas forcément de modification par rapport au standard (si par exemple on souhaite uniquement ajouter un widget sans modifier le masque écran), mais la présence d’un objet ‘xxxxu.dhof’ est indispensable pour déclencher la recherche du fichier JSON de la seconde troisième étape.
Astuce |
---|
Pour illustration, j’ai donc ici un objet gtez000_sql.dhof dans mes objets spécifiques |
...
La seconde étape consiste à créer un fichier JSON “catalog surcharge” que l’on peut par exemple préfixé préfixer de la lettre ‘u' (par exemple ugt_art_prod), et de prendre la structure du chapitre ci-dessus “Fichier JSON catalogue” afin de donner un nom qui sera visible à l’utilisateur et le nom du widget de surcharge
...
La troisième étape consiste à copier le fichier JSON “dashboard” déjà existant et associé au zoom, en ajoutant un ‘u' avant le début de l’extension pour obtenir un fichier JSON “dashboard avec surcharge”. Par exemple gtez000_sql.dashboard.json devient par copie gtez000_sqlusqlu.dashboard.json, et y ajouter, dans la balise ‘CatalogNames’, le nom du catalogue de surcharge (sans extension). Attention, dès que ce fichier ‘u' est présent il remplace le 'non u’, ce qui implique que le contenu doit être identique et augmenté de la surcharge (et pas uniquement la surcharge)
Astuce |
---|
Pour illustration, j’ai donc ici créer gtez000_sqlu.dashboard.json qui indique le nom du catalogue surcharge ugt_art_prod en plus des catalogues standard dans ‘CatalogNames’ |
...