Création d’un nouveau module

Nom du module

Le module doit être désigné en interne par un nom court de 20 caractères maximum, sans lettre accentuée ou caractère spécifique ( ce qui peut être résumé ainsi [a-z0-9]{1,20} ).

Ce nom ne doit pas être redondant avec un autre et être le plus informatif possible sur le contenu du module.

Enregistrement du module

Le module doit être enregistré dans la table system de la base de données. Cela peut être fait par la commande SQL suivante :

INSERT INTO `system` ( `name`, `groupe`, `value`) VALUES ( 'nomDuModule', 'module', 'v0.0.0');

Cette étape effectuée, le module existe dans le logiciel et est accessible en particulier dans tous les outils de conception et de configuration.

Arborescence des fichiers du module

Il convient de s’inspirer des repositories existant pour déterminer l’arborescence à mettre en place pour le module.

Fichiers de base

/upgrade/nomDuModule/sqlInstall.sql
/.MedShakeEHR
/COPYING.txt
/versionMedShakeEHR-nomDuModule.txt
/upgrade/nomDuModule/sqlInstall.sql

C’est un dump SQL qui comprend l’intégralité des données en base nécessaire à l’exécution du module. Son contenu peut être récupéré automatiquement en zone de configuration dans le listing des modules installés et en demandant les détails spécifiques au module désiré.

Si des données spécifiques sont à intégrer au dump, il convient de créer une class msModNomDuModuleSqlGenerate qui étendra la class msSqlGenerate (voir exemple pour les modules gynécologie obstétrique et médecine générale).

/.MedShakeEHR

Fichier caché vide qui permet d’identifier un zip valide au moment de l’installation du module par glisser-déposer.

/COPYING.txt

Copie de la licence de distribution, a priori GPL v3.

/versionMedShakeEHR-nomDuModule.txt

Version du module exprimé de la façon suivante v1.0.0.

Autres fichiers

Les autres fichiers sont à déployer suivant les besoins et selon les recommandations de l’article Base et Modules : principes et fonctionnement, en considérant comme exemple les repositories des modules déjà existants.

 

Article précédent

 

Article suivant

Réponses à quelques problèmes

F.A.Q. installation

Editeur : E.I.R.L. Bertrand Boutillier immatriculée sous le numéro 480 239 631 au tribunal de commerce de Saint-Brieuc
Hébergement : ONLINE (Scaleway), 8 rue de la ville l’Evêque - 75008 Paris, FRANCE (RCS PARIS B 433 115 904)