Integrated Vector Management - Discriminating Concentration Bioassay Installation Guide¶
This document includes an installation guide for the Integrated Vector Management (IVM) Discriminating Concentration Bioassay package.
Langue par défaut du système : Anglais
Présentation¶
Les fichiers de métadonnées de référence et de métadonnées json fournissent des détails techniques sur la version et le contenu du package.
Le package de métadonnées est constitué du module suivant :
- ENTO - Discriminating concentration bioassay (event program)
The package does not include dashboards, visualizations, indicators or program indicators.
Installation¶
L'installation du module se fait en plusieurs étapes :
- Préparation du fichier de métadonnées avec les métadonnées DHIS2
- Importation des métadonnées dans DHIS2
- Configuration des métadonnées importées
- Adaptation du programme après importation
Il est recommandé de lire tout d'abord chaque section du guide d'installation avant de commencer le processus d'installation et de configuration dans le système DHIS2. Identifiez les sections applicables en fonction du type d'importation:
- importation dans une instance DHIS2 vide
- importation dans une instance DHIS2 avec des métadonnées existantes.
Les étapes décrites dans ce document doivent être testées dans une instance DHIS2 de test/staging, avant d'être appliquées à un environnement de production.
Conditions requises¶
Pour installer le module, vous devez disposer d'un compte administrateur dans DHIS2.
Il est important de s'assurer que le serveur et l'application DHIS2 sont bien sécurisés et de configurer les droits d'accès aux données collectées. Les détails sur la sécurisation d'un système DHIS2 sortent du cadre de ce document. Veuillez consulter la [Documentation sur DHIS2] ici (https://docs.dhis2.org/).
Fichiers de métadonnées¶
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.
Préparation du fichier de métadonnées¶
Il est nécessaire d'apporter certaines modifications au fichier de métadonnées avant de pouvoir l'importer. Le travail à effectuer peut varier d'un package à un autre.
Dimension de données par défaut¶
Dans les premières versions de DHIS2, les 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 l'instance dans laquelle le fichier sera importé. Le tableau 1 indique les UID qui doivent être remplacés, ainsi que les endpoints de l'API pour l'identification des UID existants.
| Objet | UID | Point de terminaison de l'API |
|---|---|---|
| Catégorie | GLevLNI9wkl | ../api/categories.json?filter=name:eq:default |
| Option de catégorie | xYerKDKCefk | ../api/categoryOptions.json?filter=name:eq:default |
| Combinaison de catégories | bjDvmb4bfuf | ../api/categoryCombos.json?filter=name:eq:default |
| Combinaison d’options de catégorie | HllvX50cXC0 | ../api/categoryOptionCombos.json?filter=name:eq:default |
Identifiez les UID des tailles par défaut de votre instance à l’aide des requêtes API affichées et remplacez les UID dans le fichier .json par ceux de l’instance.
REMARQUE
Notez que cette opération de recherche et de remplacement doit être effectuée via un éditeur de texte brut, et non un traitement de texte comme Microsoft Word.
Indicator types and visualizations¶
The package does not contain indicators, indicator types, visualizations or maps. No replacement of indicator type UIDs or of the root organisation unit placeholder <OU_ROOT_UID> is therefore required.
Importation de métadonnées¶
Utilisez l'application DHIS2 Import/Export pour importer des packages de métadonnées. Nous vous recommandons d'utiliser la fonction «test» pour identifier les problèmes avant de tenter d'effectuer une importation réelle des métadonnées. Si le «test» signale des problèmes ou des conflits, consultez la section conflits lors de l'importation ci-dessous. Si aucune erreur n'est signalée lors de l'importation «test»/«validée», essayez d'importer les métadonnées. Si l'importation s'est déroulée sans erreur, vous pouvez passer à la configuration du module. Dans certains cas, les conflits ou les problèmes d'importation n'apparaissent pas pendant le «test», mais durant l'importation réelle. Dans ce cas, le résumé de l'importation indiquera les erreurs à résoudre.
Gestion des erreurs d'importation¶
REMARQUE
Si vous importez le package dans une nouvelle instance du système DHIS2, il n'y aura aucun conflit lors de l'importation, car ia base de données cible ne contient aucune métadonnée. Après avoir importé les métadonnées, passez à la section «Configuration».
Différents types de conflit 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.
In instances where other modules of the DHIS2 entomology and vector control toolkit are already installed, conflicts are most likely on objects with the "ENTO - " prefix that exist in several modules, such as the vector species option set and the reporting institution category. Check these objects first and decide whether to keep them separate or to re-use the existing ones, as described in the alternatives below.
Option 1¶
Renommez l'objet existant dans votre base de données DHIS2 pour lequel il existe un conflit. L'avantage de cette approche est qu'il n'est pas nécessaire de modifier le fichier .json, les changements étant effectués par l'interface utilisateur de DHIS2. Il est probable que cela soit moins sujet à des erreurs. Cela signifie également que le package de configuration est laissé tel quel, ce qui peut être un avantage, par exemple lorsque des mises à jour du package sont publiées. Les objets du package d'origine sont également souvent référencés dans le matériel de formation et la documentation.
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¶
A third and more complicated approach is to modify the .json file to re-use existing metadata. For example, in cases where an option set already exists for a certain concept (e.g. the vector species), that option set could be removed from the .json file and all references to its UID replaced with the corresponding option set already in the database. The big advantage of this (which is not limited to the cases where there is a direct import conflict) is to avoid creating duplicate metadata in the database. There are some key considerations to make when performing this type of modification:
- Il nécessite une connaissance approfondie de la structure détaillée des métadonnées de 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.
- the option codes used in the program rules and option groups of this package must exist in the re-used option set, otherwise the related calculations and filters will not work
- Il sera compliqué de procéder aux futures mises à jour du package de configuration.
Configuration¶
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 :
- Programme
- Étape du programme
- Category options of the ENTO - Reporting institution category (ENTO - MoH, ENTO - Partner, ENTO - Publication)
Veuillez consulter le site Documentation de DHIS2 pour plus d'informations sur le partage.
Trois groupes d'utilisateurs de base sont inclus dans le package :
- ENTO IVM - Access (view metadata/view data)
- ENTO IVM - Admin (view and edit metadata/no access to data)
- ENTO IVM - Data Capture (view metadata/capture and view data)
By default, the following is assigned to these user groups:
| Objet | ENTO IVM - Access | ENTO IVM - Admin | ENTO IVM - Data Capture |
|---|---|---|---|
| Programme | Metadata: can view Data: can view | Metadata: can edit and view Data: no access | Metadata: can view Data: can capture and view |
| Étape du programme | Metadata: can view Data: can view | Metadata: can edit and view Data: no access | Metadata: can view Data: can capture and view |
| Options de catégorie | Metadata: can view Data: can view | Metadata: can edit and view Data: no access | Metadata: can view Data: can capture and view |
The other metadata objects of the package (data elements, option sets, categories, program rules) can be viewed by all users and edited by the ENTO IVM - Admin group.
Les utilisateurs sont affectés au groupe d'utilisateurs approprié en fonction de leur rôle dans le système. Le partage des autres objets du package peut être ajusté en fonction de la configuration. Consultez la [Documentation DHIS2 sur le partage] (#sharing) pour plus d'informations.
Rôles d'utilisateur¶
Les utilisateurs auront besoin de rôles utilisateur pour pouvoir utiliser les différentes applications de 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 pour plus d'informations sur la configuration des rôles des utilisateurs.
Affectation aux unités d'organisation{ #organisation-unit-assignment }¶
The program must be assigned to organisation units within the existing hierarchy in order to be accessible via the Capture app. As described in the system design guide, the organisation unit of an event should preferably be the location where the tested mosquitoes were collected rather than the laboratory that performed the test, so the program should be assigned to the organisation units that correspond to the collection sites of the national resistance monitoring plan.
Métadonnées dupliquées¶
NOTE
This section only applies if you are importing into a DHIS2 database in which there is already meta-data present. If you are working with a new DHIS2 instance, please skip this section and go to Adapting the program. If you are using any third party applications that rely on the current metadata, please take into account that this update could break them
Even when metadata has been successfully imported without any import conflicts, there can be duplicates in the metadata - data elements, option sets or category options that already exist. As was noted in the section above on resolving conflict, an important issue to keep in mind is that decisions on making changes to the metadata in DHIS2 also needs to take into account other documents and resources that are in different ways associated with both the existing metadata, and the metadata that has been imported through the configuration package. Resolving duplicates is thus not only a matter of "cleaning up the database", but also making sure that this is done without, for example, breaking potential integrating with other systems, the possibility to use training material, breaking SOPs etc. This will very much be context-dependent.
Il est important de garder à l'esprit que DHIS2 dispose d'outils pouvant dissimuler certaines des complexités des duplications potentielles dans les métadonnées. Par exemple, lorsqu'il existe des ensembles d'options en double, ils peuvent être masqués pour des groupes d'utilisateurs par le biais de Partage.
Adaptation du programme¶
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 :
- Reducing the vector species list to the species present and tested in the country, trimming the Aedes and Anopheles option groups in step with the option set.
- Reducing the insecticide and discriminating concentration list to the products tested nationally, trimming the five related option groups and reviewing the program rules that assign the insecticide class, the exposure duration and the endpoint observation time.
- 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.
These adaptations are described in the Implementation Considerations & Local Adaptation section of the system design guide.
However, it is strongly recommended to take great caution if you decide to change or remove any of the included form/metadata. Most of the calculations, the section visibility and the validation of the form rely on program rules that reference specific data elements and option codes, and modifications could break this functionality. Options that are still referenced by stored event data should be retained rather than deleted.
Suppression des métadonnées¶
In order to keep your instance clean and avoid errors, it is recommended that you remove the unnecessary metadata from your instance. Removing unnecessary metadata requires advanced knowledge of DHIS2 and various dependencies.