Bonnes pratiques de création d'applications

Modifié le 28/05/2022 10:53

Datasources

Utilisez les alias

  • Sauf cas particuliers, basez les datasources de type Base de données (EVSM, MSSQL, MySQL) sur un alias et non sur un connecteur fixe, afin de garantir que toutes les données soient récupérées de la bonne base lors du changement du contexte d’exécution (Production ou Sandbox).
  • Les datasources basés sur un alias sont affichés en gras dans la liste des datasources.

Définissez des règles de nommage

  • Précisez l'usage du datasource dans son nom : utilisation pour le paramétrage d'un menu, filtre par défaut, vue.
             Example documentation icon FR.png  Mes demandes de service - en cours (Statut)
  • Lorsqu'un datasource est utilisé dans un filtre, connaître son usage permet de ne pas l'utiliser dans un widget KPI fixe puisque les données remontées sont tributaires de l’utilisation du filtre.
             Example documentation icon FR.png  Mes incidents - ouverts (Sujet)*
    • L’astérisque indique que le datasource est utilisé dans un widget Filter List.
    • Pour créer un KPI Nombre de mes incidents ouverts, n'utilisez pas le datasource précédent mais créez-en un nouveau. De cette façon, la valeur du compteur n'est pas modifiée même lorsque l'utilisateur change de filtre(Ouverts à Aucun).
  • Pour repérer facilement les relations Maître/Détail, ajoutez une indication dans le nom des datasources.
             Example documentation icon FR.png  (1) Employés (Liste)
                            (1.1) Demandes de service (Liste)
                            (1.1.1) Historique des actions (Liste)
                            (1.2) Matériels (Liste)

          Dans cet exemple, les numéros ajoutés en préfixe des noms des datasources nous permettent de déduire rapidement que :

                 - Le datasource Employés a 2 datasources détail : Demandes de service et Matériels
                 - Le datasource Demandes de service a un datasource détail Historique des actions.

Évitez les doublons

  • Avant de créer un datasource, assurez-vous qu’il n’existe pas déjà. Respecter des règles de nommage facilite cette bonne pratique.
  • Lorsqu’un datasource que vous vouliez utiliser pour un comptage est déjà utilisé dans un widget Filter List widget, créez-en un nouveau avec une vue agrégée différente. Vous aurez ainsi une possibilité d’utilisation supplémentaire tout en répondant au besoin du calcul.

Utilisez des vues agrégées pour les compteurs

Pour les datasources à données variables, les résultats sont affichés par lots de 30 enregistrements, suivant la navigation par l’utilisateur.

Pour afficher des compteurs avec des valeurs exactes, utilisez des datasources avec vue agrégée sur un critère ayant moins de 30 valeurs distinctes.
         Example documentation icon FR.png  Pour afficher le nombre total d’incidents, créez un datasource avec une vue Statut et non un datasource avec une vue Liste contenant trop de valeurs.

Nouvelle Demande

Les datasources pour les catalogues (Demandes de service, Changement, etc.) doivent être basés sur les menus du module Accueil afin que les périmètres d'application définis au niveau des catalogues dans Product name - ev itsm - big.png soient appliqués. En d'autres termes, n'utilisez pas les menus Operation/Transition>Catalogues>xxx pour le Store.

Relations Maître/Détail

  • Dans le builder, les datasources "Détail" affichent les données correspondant au premier enregistrement du datasource "Maître" correspondant, si ce dernier a l'option Select First Row As Current Record cochée. Afin de pouvoir accéder au Data Picker et configurer vos widgets "Détail", faites en sorte que le premier enregistrement du datasource "Maître" ait des enregistrements "Détail".
    Example documentation icon FR.png Si vous voulez afficher les matériels d'un utilisateur sélectionné dans un annuaire, veillez à ce que dans votre base de test le premier employé de la liste ait au moins un matériel associé et que l'option Select First Row As Current Record soit cochée sur le datasource des employés. L'option peut être décochée à la fin de la configuration de l'application, si besoin.

Supprimez les datasources non configurés ou non utilisés

Un datasource est créé dès la sélection de son type. Si vous abandonnez la saisie, supprimez-le pour éviter d'avoir une liste de datasources non configurés (ex. : Easyvista(1), csv(1)).

Attention : Depuis la version Phosphore, un compteur affiche le nombre d'utilisations d'un datasource.
Dans la version actuelle, il ne prend en compte que les widgets des pages déjà visitées lors de la session d'édition en cours. Avant de vous baser dessus pour supprimer les datasources non utilisés, veillez à passer sur toutes les pages de l'application afin de s'assurer qu'il est bien calculé.

Raccourcis

Droits d'accès

Lorsque vous créez un raccourci, n'oubliez pas de configurer ses droits d'accès, sinon les utilisateurs auxquels vous publierez le lien risquent de se retrouver avec un code erreur er22 qui correspond à un problème de droit.

Propriétés exposées - Liens pour accès direct à un enregistrement

Depuis la version H1.2016, il est possible de configurer des liens URL accédant à un enregistrement particulier. Pour cela il faut :

  • Configurer le datasource impliqué pour définir quelle donnée correspond au paramètre qui sera utilisé comme filtre
  • Ajouter une propriété exposée correspondant à la donnée du datasource
  • Configurer le lien
    Vous trouverez plus de détails sur la configuration des propriétés exposées sur la page présentation des nouveautés de la version H1.2016.

Dans la version actuelle, lorsqu'une URL contenant des propriétés exposées (ex : une fiche incident) est appelée, ces dernières restent dans le lien lorsqu'on navigue dans l'application, ce qui fait que le datasource sera toujours affiché filtré.
Pour permettre l'affichage d'autres données (ex : la liste de tous les incidents de l'utilisateur), il faut dupliquer les datasources et pages concernés.
Note : Une amélioration est cours d'étude pour éviter les duplications

  • Repérez les pages concernées par l'accès direct (ex : Mes incidents + Historique des actions incidents + Pièces jointes incidents) et dupliquez-les puis renommez les pages dupliquées en ajoutant une indication d'utilisation de propriété exposée (ex : Mes Incidents [RFC])
  • Repérez les datasources utilisés dans les pages dupliquées et dupliquez-les puis renommez-les en appliquant la même norme que celle choisie pour les pages (ex : (1) Mes Incidents (Liste) [RFC], (1.1) Actions Incidents (Liste) [RFC])
  • Configurez la section Search sur les datasources dupliqués de type Master
     Note : pour les cas d'accès direct à un ticket et lorsque le filtre par défaut du datasource dupliqué ne remonte pas tous les enregistrements (ex : incidents ouverts), pensez à remplacer par le filtre Aucun afin qu'un ticket résolu puisse être consulté en accès direct.
  • Changez le Master Datasource dans la section Master/Detail dans les datasources dupliqués de type Detail
  • Configurez les pages dupliquées en basant leurs widgets sur les nouveaux datasources.

Rappel : Avec la version Phosphore, il est devenu possible de créer des liens vers une page interne d'une app via la fonctionnalité des raccourcis.

      Download icon.png Téléchargez une application exemple

Images

Téléchargez les images dans l'application

  • Ajoutez toutes les images de l'application via l’éditeur de texte. Ainsi elles sont stockées dans le répertoire ressources dédié, ce qui garantit qu’elles sont correctement gérées lors d’exportation/importation d’applications.
  • Lorsque vous copiez un code HTML depuis une autre application comportant des images, téléchargez celles-ci dans votre application courante via l’éditeur de texte. Cela garantit l'affichage des images même si l'application Source est supprimée de la plate-forme.
  • Lorsque vous utilisez un custom widget comportant des images ayant été créées dans une autre application, téléchargez les images dans votre application courante via l'éditeur de texte, récupérez les chemins respectifs et copiez-les à la place des chemins des images du custom widget.

Design

Disposition des widgets pour des applications sur smartphones

Pour une application exécutable sur smartphones, définissez les emplacements (widgets Layout) suivant l'ordre souhaité d'affichage des informations.
         Example documentation icon FR.png  Tableaux de bord Incidents / Demandes de service, avec diagrammes à secteurs (widget Pie/Donut Chart) et diagrammes linéaires (widget Line Chart)

Affichage souhaité Positionnement des widgets Exemple

Les 2 graphes relatifs aux incidents puis les 2 graphes relatifs aux demandes

Positionnez les widgets sur une seule ligne avec 2 colonnes

* 1ère colonne : widgets Incidents 1 - 2

* 2ème colonne : widgets Demandes 3 - 4

Studio-responsive.png

Les 2 diagrammes à secteurs puis les 2 diagrammes linéaires

Positionnez les widgets sur 2 lignes avec 2 colonnes chacune

* 1ère ligne : colonne 1 pour le graphe à secteurs Incidents ; colonne 2 pour le graphe à secteurs Demandes

* 2ème ligne : colonne 1 pour le graphe linéaire Incidents ; colonne 2 pour le graphe linéaire Demandes

Studio-2 lines.png

Tags :
Powered by XWiki © EasyVista 2022