Dans cet article


Offres d'emploi

Tags

Bonnes pratiques relatives à la gestion des scripts

L’objectif de cette article est de partager des bonnes pratiques relatives la gestion des scripts dans Planisware.

Cet article se concentre sur l’agencement général des scripts et ne traite pas des règles de nommage ou des bonnes pratiques concernant le code en lui même.

Ces bonnes pratiques sont issues de mon expérience et de celle de mes collègues. Elles ont pour but de :

  • Retrouver rapidement les modifications effectuées dans une version.
  • Eviter de perdre du temps lors du développement.
  • Lire et comprendre plus rapidement les scripts.

1. Le versionning

Le versionning d’un script est obligatoire afin de tracer les modifications effectuées. Il permet de réduire drastiquement le temps d’analyse lorsque ce que l’on cherche a été modifié à une date ou dans une version connue. Il est beaucoup plus simple de se pencher sur les dernière modifications effectuées que de revoir entièrement une fonction, voir l’intégralité du scripts.

2. Le détail des révisions

Le détail des révisions (en haut de chaque script) comprenant la modification effectuée avec la référence de la spécification, de ticket, d’incident (un ID ou un numéro) est une bonne pratique essentielle pour gagner du temps. Il est également intéressant de mettre aussi la date et l’heure de modification ainsi que le nom du développeur. Cela peut permettre d’identifier rapidement la personne à l’origine de la modification.C’est pratique quand on est plusieurs à développer ou que l’on souhaite obtenir des explications sur une modification apportée.

3. Le commentary des fonctions

Chacune des fonctions présentes dans le scripts doit être commentée. Ce commentaire doit définir fonctionnellement à quoi sert la fonction.

3.2. Le commentary des modifications faites sur les fonctions

Il est conseillé, lors de la modification des fonctions suite à des évolutions demandées par le client ou tout simplement des corrections de fonctionnalité, de laisser un commentaire avant la modification de code avec le n° de ticket, la date de modification et le nom de l’auteur.

5. L’affichage du chargement du script dans la console

Il est recommandé d’afficher le nom du script dans la console planisware. Cela permet de vérifier que le script en question est bien chargé au démarrage. Pour cela il faut tout simplement utiliser l’instruction writeln

Exemple : writeln(\ »Script loaded $Revision: 3.01 $\ »); »

Ici cela permettra de tracer dans le log du démarrage que le script

a bien été évalué au démarrage et qu’il s’agit de la version 3.01.

6. Conclusion et synthèse.

gestSc

L'équipe AXOPEN

Voir aussi les articles suivants

Planisware : focus sur les bonnes pratiques de nommage

Planisware : focus sur les bonnes pratiques de nommage

Le 08/09/2015 par Aurélien Estour

Problématique Lorsque l’on s’attache à mettre en œuvre des bonnes pratiques de nommage sous Planisware, 2 grandes familles d’objets sont à prendre en compte : les objets d’environnement Planisware (formules nommées, tables, champs supplémentaires…) les variables, fonctions et méthodes définies en script OJS Le respect de normes dans le développement est fondamental car il permet la maintenabilité du code au cours de la vide d’une application. Le non respect de conventions pour le nommage des objets et l’écriture du code rendra les corrections et évolutions plus couteuses (en temps et en énergie) et augmentera les risques de régression (dus en général à une mauvaise compréhension du paramétrage).
Lire l'article

Planisware : comment optimiser le parcours d’une classe avec la relation inverse ?
Problématique Il est fréquent en script Planisware (OJS) d’avoir à rechercher des éléments dans une classe donnée (affectations, tâches, dépenses etc…). La performance de cette recherche dépend principalement de deux facteurs : La volumétrie totale des objets de la classe parcourue La manière dont les objets de la classe sont parcourus Pour optimiser ce deuxième point, Planisware met à disposition un outil permettant de parcourir des ensembles d’objets restreints : les relations inverses.
Lire l'article

Qu’est ce qu’un virtual dataset sous Planisware ?

Qu’est ce qu’un virtual dataset sous Planisware ?

Le 18/08/2015 par Aurélien Estour

Problématique Le progiciel Planisware comme la plupart des solutions de gestion de projets est destiné à traiter un grand nombre de données (tâches, affectations, dépenses, ressources etc…) ainsi qu’à réaliser des calculs en temps réel sur ces données. Planisware a donc mis en place des moyens techniques pour permettre des traiter et calculer ces données de manière performante et rapide : les Datasets et leur extension les Virtual Datasets. Mais qu’est-ce donc qu’un virtual dataset ?
Lire l'article