Insecticide-treated Nets Mass Campaings - Installation Guide¶
Pro každý samostatný balíček, který instalujete, budete muset postupovat podle pokynů v plném rozsahu.
Instalace¶
Instalace modulu se skládá z několika kroků:
- Příprava souboru metadat s metadaty DHIS2.
- Importování souboru metadat do DHIS2.
- Konfigurace importovaná metadata.
- Adaptace programu po importu
Před zahájením procesu instalace a konfigurace v DHIS2 se doporučuje nejprve si přečíst každou část. Byly identifikovány oddíly, které nelze použít, v závislosti na tom, zda importujete do nové instance DHIS2 nebo instance DHIS2 s již existujícími metadaty. Postup popsaný v tomto dokumentu by měl být testován v testovacím / fázovacím prostředí před opakováním nebo přenesením do produkční instance DHIS2.
Požadavky¶
K instalaci modulu je vyžadován uživatelský účet správce na DHIS2. Postup popsaný v tomto dokumentu by měl být testován v testovacím / fázovém prostředí před provedením na produkční instanci DHIS2.
Je třeba věnovat velkou pozornost tomu, aby byl server samotný a aplikace DHIS2 dobře zabezpečeny, aby se omezil přístup ke shromažďovaným datům. Podrobnosti o zabezpečení systému DHIS2 jsou mimo rozsah tohoto dokumentu a odkazujeme na dokumentaci DHIS2.
Příprava souboru metadat¶
POZNÁMKA: Pokud instalujete balíček na novou instanci DHIS2, můžete přeskočit sekci „Příprava souboru metadat“ a přejít okamžitě do sekce „Import souboru metadat do DHIS2."
I když to není vždy nutné, může být často výhodné provést určité úpravy souboru metadat před jeho importem do DHIS2.
Výchozí dimenze dat¶
V dřívějších verzích DHIS2 byl automaticky vygenerován UID výchozí datové dimenze. Zatímco tedy všechny instance DHIS2 mají výchozí možnost kategorie, kategorii datových prvků, kombinaci kategorií a kombinaci možností kategorie, UID těchto výchozích hodnot se mohou lišit. Novější verze DHIS2 mají pevně zakódované UID pro výchozí dimenzi a tyto UID se používají v konfiguračních balíčcích.
To avoid conflicts when importing the metadata, it is advisable to search and replace the entire .json file for all occurrences of these default objects, replacing UIDs of the .json file with the UIDs of the database in which the file will be imported. Table 1 shows the UIDs which should be replaced, as well as the API endpoints to identify the existing UIDs. existing UIDs.
| Objekt | UID | Koncový bod API |
|---|---|---|
| Kategorie | GLevLNI9wkl | ../api/categories.json?filter=name:eq:default |
| Možnost kategorie | xYerKDKCefk | ../api/categoryOptions.json?filter=name:eq:default |
| Kombinace kategorií | bjDvmb4bfuf | ../api/categoryCombos.json?filter=name:eq:default |
| Kombinace možností kategorie | HllvX50cXC0 | ../api/categoryOptionCombos.json?filter=name:eq:default |
For example, if importing a configuration package into https://play.dhis2.org/demo, the UID of the default category option combination could be identified through https://play.dhis2.org/demo/api/categoryOptionCombos.json?filter=name:eq:default as bRowv6yZOF2.
Poté můžete vyhledat a nahradit všechny výskyty HllvX50cXC0 bRowv6yZOF2 v souboru .json, protože to je výchozí ID v systému, do kterého importujete. Pamatujte, že tato operace hledání a nahrazování musí být provedena pomocí editoru prostého textu, nikoli textového procesoru, jako je Microsoft Word.
Typy indikátorů¶
Typ indikátoru je další typ objektu, který může způsobit konflikt importu, protože se v různých databázích DHIS2 používají určité názvy (např. „Procento“). Vzhledem k tomu, že typy indikátorů jsou definovány jednoduše podle jejich faktoru a bez ohledu na to, zda se jedná o jednoduchá čísla bez jmenovatele, jsou jednoznačné a lze je nahradit pomocí vyhledávání a nahrazení UID. Tím se vyhnete možným konfliktům při importu a vyhnete se vytváření duplicitních typů indikátorů. Tabulka 2 ukazuje identifikátory UID, které lze nahradit, a také koncové body API pro identifikaci stávajících identifikátorů UID
| Objekt | UID | Koncový bod API |
|---|---|---|
| Procento | hmSnCXmLYwt | ../api/indicatorTypes.json?filter=number:eq:false&filter=factor:eq:100 |
TrackedEntityType¶
Stejně jako typy indikátorů můžete mít ve své databázi DHIS2 již existující trasované typy entit. Odkazy na typ trasované entity by měly být změněny tak, aby odrážely to, co je ve vašem systému, abyste nevytvářeli duplikáty. Tabulka 3 ukazuje identifikátory UID, které lze nahradit, a také koncové body API pro identifikaci stávajících identifikátorů UID
| Objekt | UID | Koncový bod API |
|---|---|---|
| VC- Household | fT6xzEDXQAu | ../api/trackedEntityTypes.json?filter=name:eq:Household |
Visualizations using Root Organisation Unit UID¶
Vizualizace, sestavy událostí, tabulky sestav a mapy, které jsou přiřazeny konkrétní úrovni organizační jednotky nebo skupině organizačních jednotek, mají odkaz na kořenovou organizační jednotku (úroveň 1). Takové objekty, pokud jsou v souboru metadat přítomny, obsahují zástupný symbol <OU_ROOT_UID>. Použijte funkci vyhledávání v editoru souborů .json k případné identifikaci tohoto zástupného symbolu a jeho nahrazení UID organizační jednotky úrovně 1 v cílové instanci.
Import metadat¶
The .json metadata file is imported through the Import/Export app of DHIS2. It is advisable to use the "dry run" feature to identify issues before attempting to do an actual import of the metadata. If "dry run" reports any issues or conflicts, see the import conflicts section below. If the "dry run"/"validate" import works without error, attempt to import the metadata. If the import succeeds without any errors, you can proceed to configure the module. In some cases, import conflicts or issues are not shown during the "dry run", but appear when the actual import is attempted. In this case, the import summary will list any errors that need to be resolved.
Generic metadata¶
For generic metadata overview (identical metadata objects used by several packages), please refer to the installation annex of the individual package.
Řešení konfliktů importu¶
NOTE: If you are importing into a new DHIS2 instance, you will not have to worry about import conflicts, as there is nothing in the database you are importing to to conflict with. Follow the instructions to import the metadata then please proceed to the “Additional configuration” section.
Může nastat řada různých konfliktů, i když nejběžnější je, že v konfiguračním balíčku jsou objekty metadat se jménem, zkratkou a / nebo kódem, který již v cílové databázi existuje. Existuje několik alternativních řešení těchto problémů s různými výhodami a nevýhodami. Který z nich je vhodnější, bude záviset například na typu objektu, pro který dojde ke konfliktu.
Alternativa 1¶
Přejmenujte existující objekt v databázi DHIS2, u kterého došlo ke konfliktu. Výhodou tohoto přístupu je, že není nutné upravovat soubor .json, protože změny se místo toho provádějí prostřednictvím uživatelského rozhraní DHIS2. Pravděpodobně to bude méně náchylné k chybám. To také znamená, že konfigurační balíček je ponechán tak, jak je, což může být výhodou, například když se použije školicí materiál a dokumentace založená na konfiguračním balíčku.
Alternativa 2¶
Přejmenujte objekt, u kterého došlo ke konfliktu v souboru .json. Výhodou tohoto přístupu je, že stávající metadata DHIS2 jsou ponechána tak, jak jsou. To může být faktor, když existuje školicí materiál nebo dokumentace, jako jsou SOP datových slovníků propojených s daným objektem, a to nezahrnuje žádné riziko záměny uživatelů úpravou metadat, se kterými jsou obeznámeni.
Všimněte si, že pro alternativu 1 i 2 může být modifikace stejně jednoduchá jako přidání malého pre / post-fix k názvu, aby se minimalizovalo riziko záměny.
Alternativa 3¶
Třetím a komplikovanějším přístupem je úprava souboru .json pro opětovné použití existujících metadat. Například v případech, kdy pro určitý koncept již existuje sada možností (např. „Pohlaví“), by tato sada možností mohla být odstraněna ze souboru .json a všechny odkazy na jeho UID nahrazeny odpovídající sadou možností již v databázi. Velkou výhodou tohoto (která se neomezuje na případy přímého konfliktu importu) je vyhnout se vytváření duplicitních metadat v databázi. Při provádění tohoto typu modifikace je třeba provést několik klíčových úvah:
- vyžaduje odborné znalosti podrobné struktury metadat DHIS2
- přístup nefunguje u všech typů objektů. Zejména určité typy objektů mají závislosti, které se tímto způsobem komplikovaně řeší, například v souvislosti s rozčleněními.
- budoucí aktualizace konfiguračního balíčku budou komplikované.
Další konfigurace¶
Po úspěšném importu všech metadat existuje několik kroků, které je třeba provést, než bude modul funkční.
Sdílení¶
Nejprve budete muset pomocí funkce Sdílení DHIS2 konfigurovat, kteří uživatelé (skupiny uživatelů) by měli vidět metadata a data spojená s programem a kdo může registrovat / zadávat data do programu. Ve výchozím nastavení bylo sdílení nakonfigurováno pro následující:
- Typ trasované entity
- Program
- Fáze programu
- Ovládací panely
Balíček metadat obvykle obsahuje několik skupin uživatelů:
- VC-ITN Access
- VC-ITN Admin
- VC-ITN Data Capture
Ve výchozím nastavení je těmto skupinám uživatelů přiřazeno následující
| Objekt | Skupiny uživatelů | ||
|---|---|---|---|
| VC-ITN Access | VC-ITN Admin | VC-ITN Data Capture | |
| Typ trasované entity | Metadata : lze zobrazit Data: lze zobrazit | Metadata: lze upravovat a prohlížet Data: lze zobrazit | Metadata: lze zobrazit Data: lze zachytit a zobrazit |
| Program | Metadata : lze zobrazit Data: lze zobrazit | Metadata: lze upravovat a prohlížet Data: lze zobrazit | Metadata: lze zobrazit Data: lze zachytit a zobrazit |
| Fáze programu | Metadata : lze zobrazit Data: lze zobrazit | Metadata: lze upravovat a prohlížet Data: lze zobrazit | Metadata: lze zobrazit Data: lze zachytit a zobrazit |
| Ovládací panely | Metadata : lze zobrazit Data: lze zobrazit | Metadata: lze upravovat a prohlížet Data: lze zobrazit | Metadata : lze zobrazit Data: lze zobrazit |
Please refere to the individual package installation annex for information about user groups.
You will want to assign your users to the appropriate user group based on their role within the system. You may want to enable sharing for other objects in the package depending on your set up. Refer to the DHIS2 Documentation for more information on configuring sharing.
If your TET Household already matches the one in the package and you want to avoid overriding the current sharing properties for this object in the database, you can follow these steps:
- Remove this TET from the package file
- Import the package
- Update sharing properties for this TET using the table above.
Uživatelské role¶
Uživatelé budou potřebovat uživatelské role, aby mohli pracovat s různými aplikacemi v rámci DHIS2. Doporučují se následující minimální role:
- Analýza dat trasovače: Může zobrazit analytiku událostí a přistupovat k ovládacím panelům, zprávám o událostech, vizualizátorům událostí, vizualizátorům dat, kontingenčním tabulkám, zprávám a mapám.
- Zachycování dat Trasovače: Může přidávat datové hodnoty, aktualizovat trasované entity, prohledávat trasované entity napříč organizačními jednotkami a přistupovat k zachycení trasovačů
Další informace o konfiguraci uživatelských rolí naleznete v dokumentaci DHIS2.
Organizační jednotky¶
Program musíte přiřadit organizačním jednotkám v rámci vaší vlastní hierarchie, aby bylo možné program vidět v záznamu trasovače.
Duplikovaná metadata¶
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 tracker program."
I když byla metadata úspěšně importována bez jakýchkoli konfliktů při importu, v metadatech mohou existovat duplikáty - datové prvky, trasované atributy entit nebo sady voleb, které již existují. Jak bylo uvedeno v části výše o řešení konfliktů, je třeba mít na paměti důležitý problém, že rozhodnutí o provádění změn metadat v DHIS2 musí také zohledňovat další dokumenty a zdroje, které jsou různými způsoby spojeny s existujícími metadaty a metadata, která byla importována prostřednictvím konfiguračního balíčku. Vyřešení duplikátů tedy není jen otázkou „vyčištění databáze“, ale také zajištěním toho, aby se tak dělo například bez narušení potenciálu integrace s jinými systémy, možnosti použít školicí materiál, rozbití SOP atd. To bude velmi záviset na kontextu.
Jedna důležitá věc, kterou je třeba mít na paměti, je, že DHIS2 má nástroje, které mohou skrýt některé složitosti potenciálních duplikací v metadatech. Například tam, kde existují duplicitní sady možností, mohou být skryty pro skupiny uživatelů pomocí sharing.
Adapting the tracker and event programs¶
Po importu programu můžete provést určité úpravy programu. Mezi příklady místních úprav, které lze provést, patří:
- Přidání dalších proměnných do formuláře.
- Přizpůsobení názvů datových prvků / možností podle národních konvencí.
- Adapting the Category Combo used in the Event program to use category options for the years you are doing the campaigns
- Přidávání překladů do proměnných nebo do formuláře pro zadávání údajů.
- Úprava indikátorů programu na základě místních definic případů
Důrazně se však doporučuje věnovat velkou pozornost, pokud se rozhodnete změnit nebo odebrat některý ze zahrnutých formulářů / metadat. Existuje nebezpečí, že by úpravy mohly narušit funkčnost, například pravidla programu a indikátory programu.