跳转至
For the complete DHIS2 documentation index, see llms.txt.
健康
免疫接种
欧派物流

聚合软件包安装指南{ #aggregate-package-installation }

总览

本文件旨在指导管理员安装用于汇总报告的 DHIS2 配置包。要求对 DHIS2 有良好的理解。

DHIS2的配置包由[JSON]（https://en.wikipedia.org/wiki/JSON）格式的元数据文件组成，可以将其导入DHIS2实例以及随附的文档。该软件包根据WHO的建议提供了预定义的标准内容。本文档涉及完整的软件包，其中包括数据收集的配置（数据集，数据元素，验证规则）以及分析和仪表板（图表，地图和数据透视表收藏夹）。此功能适用于在DHIS2中未配置任何数据收集的情况，或者用于替换/修订现有内容以符合WHO建议的情况。

配置包由以下部分组成：

  • 具有数据元素的数据集；
  • 特定软件包的元数据对象（预测因子、常量、组织单位组等）；
  • 一套指标；
  • 分析输出（数据透视表、数据可视化和 GIS 收藏夹）；
  • 一组仪表板。

这些组件都链接在一起，即指标基于所包含的数据元素，分析输出基于所包含的指标，而仪表板则由所包含的分析输出组成。

安装

模块的安装包括两个步骤：

  1. [准备]（＃preparing-the-metadata-file）具有DHIS2元数据的元数据文件。
  2. 将元数据文件[导入]（＃importing-a-metadata-file-to-dhis2）到DHIS2中。
  3. [配置]（＃additional-configuration）导入的元数据。
  4. [执行]（＃examples-of-other-modifications）特定于程序包的修改。

本节将讨论准备元数据文件并将其导入 DHIS2 的前两个步骤，下一节将讨论配置过程。建议在开始 DHIS2 的安装和配置过程之前，先通读这两部分内容。除了这里描述的一般步骤外，一些配置包的安装指南还有附件，描述了一些特殊问题。这些附件列在相应部分此处。

在重复或转移到DHIS2的生产实例之前，应在测试/分阶段环境中测试本文档中概述的过程。

多个配置包

某些配置包有重叠的元数据，例如指示器。这意味着在某些情况下，导入不同的配置包时，之前导入的配置包元数据的更改可能会被覆盖。导入 "仅新 "元数据而非 "新和更新 "元数据可以避免这种情况，但需要注意的是，无论采用哪种方法，都需要手动修改。至少必须确保多个程序使用的元数据在两个程序的适当用户组中共享。

要求

为了安装配置包，需要使用DHIS2中的管理员用户帐户，并具有添加/编辑（公共）元数据对象的权限，包括（但不限于）：

  • 数据元素（包括类别）
  • 数据集
  • 指标
  • 指标类型
  • 仪表板
  • 数据可视化器，数据透视表和GIS收藏夹

可以在特定配置包的元数据参考文档中找到模块中包含的对象的完整列表（管理员需要管理员对其进行管理）。

如果需要修改配置包的.json元数据文件[（请参见下文）]（https://who.dhis2.org/documentation/installation_guide_complete.html#preparing-the_metadata-file），请使用[文本编辑器]（https://en.wikipedia.org/wiki/Text_editor）-这些修改不应使用文字处理程序（例如Microsoft Word）来完成。

配置包可通过 DHIS2 健康应用程序安装在 DHIS2 中，或通过 DHIS2 的 Import/Export 应用程序手动安装带有 DHIS2 元数据的 .json 文件。本节其余部分描述的程序适用于手动导入元数据的过程。

[Configuration]（https://who.dhis2.org/documentation/installation_guide_complete.html#configuration）部分适用于两种方法。

准备元数据文件

注意：如果要将软件包安装在DHIS2的新实例上，则可以跳过“准备元数据文件”部分，然后立即移至“ [将元数据文件导入DHIS2]（＃importing-将元数据文件放入DHIS2）。”

尽管并非总是必要，但在将元数据文件导入DHIS2之前对其进行某些修改通常可能是有利的。

默认数据维度

在早期版本的DHIS2中，默认数据维的UID是自动生成的。因此，尽管所有DHIS2实例都具有默认类别选项，数据元素类别，类别组合和类别选项组合，但这些默认的UID可以不同。 DHIS2的更高版本具有用于默认维度的硬编码UID，并且这些UID在配置包中使用。

为避免在导入元数据时发生冲突，建议搜索并替换整个.json文件以查找所有这些默认对象，并将.json文件的UID替换为将导入文件的数据库的UID。表1显示了应替换的UID以及用于标识现有UID的API端点。

目的 用户标识 应用程序接口端点
类别 GLevLNI9wkl ../api/categories.json?filter=name:eq:default
类别选项 xYerKDKCefk ../api/categoryOptions.json?filter=name:eq:default
不 bjDvmb4bfuf ../api/categoryCombos.json?filter=name:eq:default
类别选项组合 HllvX50cXC0 ../api/categoryOptionCombos.json?filter=name:eq:default

例如，如果将配置包导入 https://play.dhis2.org/demo，则默认类别选项组合的 UID 可以通过 https://play.dhis2.org/demo/api/categoryOptionCombos.json?filter=name:eq:default 识别为 bRowv6yZOF2。然后，您就可以在 .json 文件中用 bRowv6yZOF2 搜索并替换所有出现的 HllvX50cXC0。请注意，搜索和替换操作必须使用纯文本编辑器，而不是 Microsoft Word 等文字处理器。

指标类型

指标类型是另一种可能导致导入冲突的对象，因为在不同的DHIS2数据库中使用了某些名称（例如“百分比”）。由于指标类型仅由其因子以及是否为无分母的简单数字定义，因此它们是明确的，可以通过搜索和替换UID进行替换。这样可以避免潜在的导入冲突，并避免创建重复的指标类型。表2显示了可以替换的UID以及用于标识现有UID的API端点。

目的 用户标识 应用程序接口端点
仅分母（数字） kHy61PbChXr ../api/indicatorTypes.json?filter=number:eq:true&filter=factor:eq:1
百分比 hmSnCXmLYwt ../api/indicatorTypes.json?filter=number:eq:false&filter=factor:eq:100

**注1 **：通过按照所述替换UID并导入.json文件，相关指标类型的名称（包括所有翻译）将更新为配置包中包含的指标类型。

**注2 **：重用现有指标类型的另一种方法是导入配置包中包含的那些，并删除重叠的现有指标。这将要求在删除指标类型之前，将所有使用这些现有指标类型的指标更新为新导入的指标类型。

将元数据文件导入DHIS2

.json 元数据文件是通过 DHIS2 的 导入/导出应用程序导入的。建议在尝试实际导入元数据前使用 "模拟运行 "功能来发现问题。如果 "模拟运行 "报告了任何问题或冲突，请参阅下面的处理导入冲突部分。

如果 "模拟"/"验证 "导入无误，请尝试导入元数据。如果导入成功且无任何错误，则可以继续[配置]（#附加配置）模块。在某些情况下，"模拟运行 "期间不会显示导入冲突或问题，但在尝试实际导入时会显示。在这种情况下，导入摘要将列出需要解决的任何错误。

处理导入冲突

**注意**如果要导入到新的DHIS2实例中，则不必担心导入冲突，因为要导入的数据库中没有与之冲突的内容。按照说明导入元数据，然后继续进行“ [附加配置]（＃additional-configuration）”部分。

可能会发生许多不同的冲突，尽管最常见的是配置包中有目标数据库中已经存在名称，简称和/或代码的元数据对象。对于这些问题，有两种替代解决方案，具有不同的优缺点。哪一个更合适将取决于例如发生冲突的对象的类型。

备选方案1

重命名存在冲突的现有对象。这种方法的优点是无需修改.json文件，因为更改是通过DHIS2的用户界面完成的。这很可能不太容易出错。这也意味着配置包将保留原样，例如在使用基于配置包的培训材料和文档时，这可能是一个优势。

备选方案2

重命名.json文件中存在冲突的对象。这种方法的优点是现有的DHIS2元数据保持不变。当存在培训材料或文档（例如链接到所讨论对象的数据字典的SOP）时，这可能是一个因素，并且不存在通过修改用户熟悉的元数据而使用户感到困惑的风险。同时，修改.json文件的对象意味着使用相关的文档和培训资料可能会变得更加复杂。

请注意，对于备选项1和2，修改可以简单到在名称中添加一个小的前缀/后缀，以最大程度地减少混乱的风险。

备选3

第三种也是更复杂的方法是修改.json文件以重新使用现有的元数据。例如，在已经存在用于某个概念的指标（例如“ ANC 1覆盖范围”）的情况下，可以将该指标从.json文件中删除，并将其UID的所有引用替换为数据库中已经存在的相应指标。这样做的最大优点（不限于直接导入冲突的情况）是避免在数据库中创建重复的元数据。但是，出于以下几个原因，通常不建议这样做：

  • 它需要有关DHIS2的详细元数据结构的专业知识
  • 该方法不适用于所有类型的对象。特别地，某些类型的对象具有依赖关系，这种依赖关系以这种方式难以解决，例如与分解有关。
  • 与备选方案2一样，这意味着安装结果并不完全符合标准配置，因此，未经修改可能无法使用针对该配置开发的培训材料和文档。
  • 将来对配置包的更新将很复杂。

附加配置

一旦成功导入所有元数据，该模块就应该可以使用，只需进行少量的其他调整即可。另外，完全取决于已将模块导入到的DHIS2实例，可能需要或有利于进行一些其他配置和修改。本节将首先介绍必要的配置步骤，然后提及其他可能相关的其他类型的修改或配置。

必需的配置

在将配置包用于数据收集之前，需要执行两个步骤。

  • 将数据集分配给适当的组织单位
  • 与适当的用户组共享数据集
  • 将您的用户添加到适当的用户组

数据集应分配给期望报告该特定数据集的组织单位（机构）。

数据集和类别选项也应该与负责为这些数据集进行数据输入的人员的相关用户组共享。

分享中

首先，您将必须使用DHIS2的*共享*功能来配置哪些用户（用户组）应查看与程序关联的元数据和数据，以及谁可以在程序中注册/输入数据。应该为以下配置共享：

  • 数据元素/数据元素组
  • 指标/指标组
  • 数据集
  • 仪表板

通常附带的用户组包括

  • {软件包名称}访问
  • {软件包名称} 管理员
  • {软件包名称}数据采集

我们建议为这些小组提供以下访问权限

目的 用户组
{软件包名称}访问 {软件包名称} admin {软件包名称}数据捕获
数据元素/数据元素组_ 元数据：可查看
数据：可查看		 元数据：可编辑和查看
数据：可查看		 元数据：可查看
数据：可查看
指标/指标组_ 元数据：可查看
数据：可查看		 元数据：可编辑和查看
数据：可查看		 元数据：可查看
数据：可查看
数据集 元数据：可查看
数据：可查看		 元数据：可编辑和查看
数据：可查看		 元数据：可查看
数据：可捕获并可查看
Dashboards 元数据：可查看
数据：可查看		 元数据：可编辑和查看
数据：可查看		 元数据：可查看
数据：可查看

重复的元数据

即使成功导入了元数据而没有任何导入冲突，元数据中也可能存在重复项-无论是图表，指标，数据元素还是已经存在的数据元素类别。正如上面有关解决冲突的部分所述，要记住的重要问题是，在DHIS2中更改元数据的决定还需要考虑与现有元数据有不同关联的其他文档和资源。 ，以及通过配置包导入的元数据。因此，解决重复项不仅是“清理数据库”的问题，而且还应确保做到这一点，例如，不破坏与其他系统的集成，使用培训材料的可能性，破坏SOP等。取决于上下文。

要记住的重要一件事是DHIS2具有可以隐藏元数据中潜在重复项的某些复杂性的工具。例如，在存在重复的数据元素类别的情况下，可以通过类别选项组集合将这些重复项对最终用户隐藏，或者可以通过共享为用户组隐藏某些元数据对象。

即使已经存在相同的指标，也建议不要删除或替换配置包中包含的指标，以便可以保留分析输出（仅基于指标）。这将允许重复使用基于配置包的培训材料。

其他修改示例

除了所需的配置外，还取决于具体情况，还有许多其他可能涉及的修改和配置。不可能提供涵盖所有不同情况的指导和建议，但此处对一些常见问题进行了简要讨论。

翻译

如果需要其他语言，则可能需要添加其他翻译。

添加其他变量

配置包包括推荐的关键数据元素和指标。但是，在某些情况下，可能有必要添加其他变量来满足特定国家/地区的信息需求。这些可以添加到包含的数据集中。

更新报告表格的布局

为了方便在DHIS2中进行数据输入的人员的工作，有时需要添加自定义数据输入表格，该表格与在初级级别使用的纸质表格的格式相匹配。

保养

由于配置程序包由标准DHIS2元数据对象组成，因此无需特别维护。但是，在升级到DHIS2的新版本之前，重要的是，通常在升级系统的任何生产实例之前，在登台/测试服务器上测试系统的所有功能。