Registre de l'hypertension - Guide d'installation¶
Installation¶
L'installation du module se fait en plusieurs étapes :
- Préparation du fichier de métadonnées avec les métadonnées de DHIS2.
- Importation du fichier de métadonnées dans DHIS2.
- Configuration des métadonnées importées.
- Adaptation du programme après son importation
Il est recommandé de lire d'abord chaque section avant de commencer le processus d'installation et de configuration dans le DHIS2. Les sections non applicables ont été identifiées, selon que vous importiez dans une nouvelle instance de DHIS2 ou dans une instance de DHIS2 ayant déjà des métadonnées. La procédure décrite dans le présent document doit être testée dans un environnement de test et de simulation avant d'être répétée ou transférée dans une instance de production du DHIS2.
Conditions requises¶
Pour installer le module, il faut nécessairement un compte d'utilisateur administrateur sur DHIS2. La procédure décrite dans le présent document doit être testée dans un environnement de test et de simulation avant d'être exécutée sur une instance de production du DHIS2.
Il faut veiller à ce que le serveur lui-même et l'application DHIS2 soient bien sécurisés, afin de limiter l'accès aux données collectées. Les détails sur la sécurisation d'un système DHIS2 dépassent le cadre de ce document et nous renvoyons à l'adresse Documentation sur le DHIS2.
Préparation du fichier de métadonnées¶
N.B. : Si vous installez le package sur une nouvelle instance de DHIS2, vous pouvez alors ignorer la section "Préparation du fichier de métadonnées" et passer immédiatement à la section "Importer un fichier de métadonnées dans DHIS2".
Bien que ce ne soit pas toujours nécessaire, il peut souvent être avantageux d'apporter certaines modifications au fichier de métadonnées avant son importation dans DHIS2.
Dimension de données par défaut¶
Dans les premières versions de DHIS2, l'UID de la dimension des données par défaut était généré automatiquement. Ainsi, alors que toutes les instances du DHIS2 ont une option de catégorie par défaut, une catégorie d'élément de données, une combinaison de catégories et une combinaison d'options de catégories, les UID de ces valeurs par défaut peuvent être différents. Les versions plus récentes de DHIS2 ont des UID codés en dur pour la dimension par défaut, et ce sont ces UID qui sont utilisés dans les packages de configuration.
Pour éviter les conflits lors de l'importation des métadonnées, il est conseillé de rechercher et de remplacer l'ensemble du fichier .json pour toutes les occurrences de ces objets par défaut, en remplaçant les UID du fichier .json par les UID de la base de données dans laquelle le fichier sera importé. Le tableau 1 indique les UID qui doivent être remplacés, ainsi que les point d'extrémité de l'API pour l'identification des UID existants
| Objet | UID | Chemin vers l'API |
|---|---|---|
| Catégorie | GLevLNI9wkl | ../api/categories.json?filter=name:eq:default |
| Option de catégorie | xYerKDKCefk | ../api/categoryOptions.json?filter=name:eq:default |
| La combinaison de catégories | bjDvmb4bfuf | ../api/categoryCombos.json?filter=name:eq:default |
| Combinaison d’options catégorie | HllvX50cXC0 | ../api/categoryOptionCombos.json?filter=name:eq:default |
Par exemple, si l'on importe un package de configuration dans https://play.dhis2.org/demo, l'UID de la combinaison d'options de catégorie par défaut peut être identifié à partir de https://play.dhis2.org/demo/api/categoryOptionCombos.json?filter=name:eq:default as bRowv6yZOF2.
Vous pourriez alors rechercher et remplacer toutes les occurrences de HllvX50cXC0 par bRowv6yZOF2 dans le fichier .json, puisque c'est l'ID par défaut du système dans lequel vous importez. Notez que cette opération de recherche et de remplacement doit être effectuée avec un éditeur de texte brut, et non avec un logiciel de traitement de textes comme Microsoft Word.
Types d'indicateurs¶
Le type d'indicateur est un autre type d'objet pouvant créer un conflit d'importation puisque certains noms sont utilisés dans différentes bases de données de DHIS2 ("Pourcentage", par exemple). Étant donné que les types d'indicateurs sont définis simplement par leur facteur et par le fait qu'il s'agisse ou non de simples nombres sans dénominateur, ils sont sans aucune ambiguïté et peuvent être remplacés par une recherche et un remplacement des UID. Cela permet d'éviter d'éventuels conflits d'importation et de ne pas créer de types d'indicateurs dupliqués. Le tableau 2 montre les UID qui pourraient être remplacés, ainsi que les points d'extrémité de l'API pour identifier les UID existants.
| Objet | UID | Chemin vers l'API |
|---|---|---|
| Numérateur seulement (nombre) | kHy61PbChXr | ../api/indicatorTypes.json?filter=number:eq:true&filter=factor:eq:1 |
| Pourcentage | hmSnCXmLYwt | ../api/indicatorTypes.json?filter=number:eq:false&filter=factor:eq:100 |
TrackedEntityType (Type d'entité suivie)¶
Comme pour les types d'indicateurs, il se peut que vous ayez déjà des types d'entités suivies dans votre base de données DHIS2. Les références au type d'entité suivie doivent être modifiées pour refléter ce qui se trouve dans votre système afin d'éviter la création de doublons. Le tableau 3 indique les UID qui pourraient être remplacés, ainsi que les points point d'extrémité de l'API permettant d'identifier les UID existants.
| Objet | UID | Chemin vers l'API |
|---|---|---|
| Personne | MCPQUTHX1Ze | ../api/trackedEntityTypes.json?filter=name:eq:Person |
Les visualisations qui utilisent l'unité d'organisation racine¶
Les visualisations, si elles sont incluses dans un package, peuvent contenir un caractère générique pour une unité d'organisation racine. L'exemple d'étiquette d'espace réservé est le suivant
Importation de métadonnées¶
Le fichier de métadonnées .json est importé via l'application [Import/Export] (https://docs.dhis2.org/en/use/user-guides/dhis-core-version-master/maintaining-the-system/importexport-app.html)de DHIS2. Il est conseillé d'utiliser "l'exécution sans effet" pour identifier les problèmes avant d'essayer d'importer réellement les métadonnées. Si "l'exécution sans effet" signale des problèmes ou des erreurs, voir la section [erreurs d'importation] (https://who.dhis2.org/documentation/installation_guide_complete.html#handling-import-conflicts) ci-dessous. Si "l'exécution sans effet"/"valider" de l'importation fonctionne sans erreur, essayez d'importer les métadonnées. Si l'importation se déroule sans erreur, vous pouvez procéder à la configuration du module. Dans certains cas, les erreurs ou les problèmes d'importation ne sont pas affichés lors de "l'exécution sans effet", mais apparaissent lors de la tentative d'importation proprement dite. Dans ce cas, la synthèse de l'importation énumère les erreurs qui doivent être résolues.
Gestion des conflits d'importation¶
N.B. : Si vous importez dans une nouvelle instance DHIS2, vous n'aurez pas à vous soucier des conflits d'importation, car il n'y a rien dans la base de données que vous importez qui puisse entrer en conflit avec celle-ci. Suivez les instructions pour importer les métadonnées, puis passez à la section "Configuration supplémentaire".
Plusieurs de conflits peuvent survenir, mais le plus courant est le fait qu'il y ait des objets de métadonnées dans le package de configuration avec un nom, un nom abrégé et/ou un code existant déjà dans la base de données cible. Il existe plusieurs solutions alternatives à ces problèmes, avec de différents avantages et inconvénients. La solution la plus appropriée dépendra, par exemple, du type d'objet pour lequel un conflit survient.
Option 1¶
Renommez l'objet de votre base de données de DHIS2 pour lequel il y a un conflit. L'avantage de cette approche est que vous n'avez pas besoin de modifier le fichier .json, puisque les modifications sont effectuées par l'interface utilisateur de DHIS2. Cette méthode est probablement moins sujette aux erreurs. Cela signifie également que le package de configuration est laissé tel quel, ce qui peut être un avantage, par exemple, lorsque du matériel de formation et de la documentation basés sur le package de configuration seront utilisés.
Option 2¶
Renommez l'objet pour lequel il y a un conflit dans le fichier .json. L'avantage de cette approche est que les métadonnées DHIS2 existantes sont laissées telles quelles. Cela peut être un facteur lorsqu'il y a du matériel de formation ou de la documentation, comme les procédure normale d'exploitation des dictionnaires de données liés à l'objet en question, et cela n'implique aucun risque de confusion pour les utilisateurs lors de la modification des métadonnées qui leur sont familières.
Notez que pour les deux options 1 et 2, la modification peut être aussi simple que l'ajout d'un petit pré/post-fixe au nom, pour minimiser le risque de confusion.
Option 3¶
Une troisième approche, plus complexe, consiste à modifier le fichier .json pour réutiliser les métadonnées existantes. Par exemple, dans les cas où un ensemble d'options existe déjà pour un certain concept (par exemple "sexe"), cet ensemble d'options pourrait être supprimé du fichier .json et toutes les références à son UID remplacées par l'ensemble d'options correspondant existant déjà dans la base de données. Le grand avantage de cette méthode (qui n'est pas limitée aux seuls cas où il y a un conflit d'importation directe) est d'éviter de créer des métadonnées dupliquées dans la base de données. Il y a des aspects essentiels à prendre en compte lors de ce type de modification :
- il nécessite une connaissance approfondie de la structure détaillée des métadonnées du DHIS2
- Cette approche ne fonctionne pas pour tous les types d'objets. En particulier, certains types d'objets ont des dépendances compliquées à résoudre de cette manière, par exemple en ce qui concerne les désagrégations.
- il sera compliqué de procéder aux futures mises à jour du package de configuration.
Les problèmes connus en matière d'importation¶
- L'ordre de tri des options ne correspond pas Symptômes : l'importation échoue sans erreur. Veuillez vérifier le fichier dhis.log de votre instance/serveur. Si vous voyez l'erreur suivante :
* ERROR 2021-07-15 10:05:58,018 java.lang.NullPointerException at org.hisp.dhis.dxf2.metadata.objectbundle.hooks.OptionSetObjectBundleHook.lambda$updateOption$0(OptionSetObjectBundleHook.java:71) at java.lang.Iterable.forEach(Iterable.java:75)
Le problème est lié au fait que l'ordre de tri des options d'un ensemble d'options inclus dans le package ne correspond pas à l'ordre de tri des mêmes options dans l'instance/serveur. 2. La valeur de la clé dupliquée viole la contrainte d'unicité Symptômes : l'importation échoue sans erreur. Veuillez vérifier le fichier dhis.log de votre instance/serveur. Si vous voyez l'erreur suivante :
* ERROR 2021-07-15 10:12:20,272 ERROR: la valeur de la clé dupliquée viole la contrainte d'unicité "uk_myox13mr8r27oxl7ts33ntpd5" Détails: La clé (uid)=(YYtAbckt77l) existe déja. (SqlExceptionHelper.java [taskScheduler-23]) * ERROR 2021-07-15 10:12:20,303 javax.persistence.PersistenceException: org.hibernate.exception.ConstraintViolationException: n'a pas pu exécuter l'instruction
Configuration supplémentaire¶
Une fois que toutes les métadonnées sont importées avec succès, des étapes doivent être mises en oeuvre avant que le module ne soit fonctionnel.
Partage¶
Tout d'abord, vous devrez utiliser la fonctionnalité Partage de DHIS2 pour configurer quels utilisateurs (groupes d'utilisateurs) doivent voir les métadonnées et les données associées au programme ainsi que qui peut enregistrer/saisir des données dans le programme. Par défaut, le partage a été configuré pour ce qui suit :
- Type d'entité suivie
- Programme
- Étapes du programme
- Tableaux de bord
Trois groupes d'utilisateurs sont inclus dans le package :
- Accès à la HTN
- Admin de la HTN
- Saisie de données sur la HTN
Les éléments suivants sont attribués par défaut à ces groupes d'utilisateurs
| Objet | Groupe d'utilisateurs | ||
|---|---|---|---|
| Accès | Admin | Saisie de données | |
| Type d’entité suivie. | Métadonnées : peuvent être visualisées Données : peuvent être visualisées | Métadonnées : peuvent être modifiées et visualisées Données : peuvent être visualisées | Métadonnées : peuvent être visualisées Données : peuvent être capturées et visualisées |
| Programme | Métadonnées : peuvent être visualisées Données : peuvent être visualisées | Métadonnées : peuvent être modifiées et visualisées Données : peuvent être visualisées | Métadonnées : peuvent être visualisées Données : peuvent être capturées et visualisées |
| Étapes du programme | Métadonnées : peuvent être visualisées Données : peuvent être visualisées | Métadonnées : peuvent être modifiées et visualisées Données : peuvent être visualisées | Métadonnées : peuvent être visualisées Données : peuvent être capturées et visualisées |
| Tableaux de bord. | Métadonnées : peuvent être visualisées Données : peuvent être visualisées | Métadonnées : peuvent être modifiées et visualisées Données : peuvent être visualisées | Métadonnées : peuvent être visualisées Données : peuvent être visualisées |
Vous voudrez bien affecter vos utilisateurs au groupe d'utilisateurs approprié en fonction de leur rôle dans le système. Vous pouvez également activer le partage pour d'autres objets du paquet en fonction de votre configuration. Référez-vous à la Documentation DHIS2 pour plus d'informations sur la configuration du partage
Rôles des utilisateurs¶
Les utilisateurs auront besoin de rôles utilisateur pour pouvoir utiliser les différentes applications du DHIS2. Les rôles minimums suivants sont recommandés :
- Analyse des données Tracker : Il peut visualiser des analyses d'événements et accéder à des tableaux de bord, des rapports d'événements, un visualiseur d'événements, un visualiseur de données, des tableaux croisés dynamiques, des rapports et des cartes.
- Saisie de données Tracker : possibilité d'ajouter des valeurs de données, de mettre à jour les entités suivies, de rechercher des entités suivies dans les unités d'organisation et d'accéder à l'application Saisie Tracker
Consultez la [Documentation de DHIS2] (https://docs.dhis2.org) pour plus d'informations sur la configuration des rôles d'utilisateur.
Unités d’Organisation¶
Vous devez assigner le programme à des unités d'organisation au sein de votre propre hiérarchie afin de pouvoir le visualiser dans Saisie Tracker.
Métadonnées dupliquées¶
N.B. : Cette section ne s'applique que si vous importez dans une base de données DHIS2 ayant déjà des méta-données. Si vous travaillez avec une nouvelle instance de DHIS2, veuillez ignorer cette section et aller à [Adapter le programme tracker] (#adapter-le-programme-de-suivi)".
Même lorsque les métadonnées sont importées avec succès sans aucun conflit d'importation, il peut y avoir des doublons dans les métadonnées - éléments de données, attributs d'entités suivies ou ensembles d'options qui existent déjà. Comme indiqué dans la section ci-dessus sur la résolution des conflits, il est important de garder à l'esprit que les décisions relatives à la modification des métadonnées dans le DHIS2 doivent également tenir compte d'autres documents et ressources associés de différentes manières aux métadonnées existantes et aux métadonnées importées par le biais du package de configuration. La résolution des doublons ne consiste donc pas seulement à "nettoyer la base de données", mais aussi à s'assurer que cela est fait sans, par exemple, briser le potentiel d'intégration avec d'autres systèmes, la possibilité d'utiliser du matériel de formation, la rupture des SOP, etc. Cela dépend beaucoup du contexte.
Il est important de garder à l'esprit que DHIS2 dispose d'outils permettant de masquer certaines complexités liées à d'éventuelles duplications de métadonnées. Par exemple, lorsqu'il existe des ensembles d'options en doublon, ils peuvent être masqués à un groupe d'utilisateurs à travers le [partage].(https://docs.dhis2.org/en/use/user-guides/dhis-core-version-master/configuring-the-system/about-sharing-of-objects.html).
Adapter le programme tracker¶
Une fois le programme importé, il est possible que vous souhaitiez y apporter certaines modifications. Voici quelques exemples d'adaptations locales que vous pourrez effectuer :
- Ajout de variables supplémentaires au formulaire.
- Adaptation des noms des éléments de données/options en fonction des usages au niveau national.
- Ajout des traductions aux variables et/ou au formulaire de saisie des données.
- Modification des indicateurs du programme en fonction des définitions de cas locales
Toutefois, il est fortement recommandé de faire preuve d'une grande prudence si vous décidez de modifier ou de supprimer l'un des formulaires/métadonnées inclus. Il y a donc un risque que des modifications brisent des fonctionnalités, par exemple les règles du programme et les indicateurs du programme.