maintenance app

维护应用

应用配置

维护应用程序主要由API的应用程序配置和模式驱动。模式直接从API读取（由D2）。以下文档应用程序配置：

• 在src/config/ ...中
  • maintenance-models.js定义了应用程序中显示的模型类型
  • field-config/包含每种模型类型的配置
    • field-order.js定义了每个模型类型的表单中字段顺序
    • field-groups.js为每个模型的表单定义了字段分组。目前，这仅用于编程，但是将其扩展到其他模型类型可能是一个好主意。
  • field-overrides/包含需要非标准行为的字段的额外配置。最常见的是，这意味着需要特殊组件的字段。
    • index.js列出了所有具有一个或多个字段覆盖的模型
    • 实际字段覆盖在以每种模型类型命名的文件中指定，然后将其导入index.js 。一些需要大量逻辑的模型类型或字段分为子文件夹。
  • inlinehelp-mapping.json将每个部分/模型类型的映射指定为文档中的页面。
  • field-rules.js包含条件逻辑，可根据其他字段的值来显示或隐藏字段或设置字段值。
  • periodTypes.json包含由当前版本的API支持的周期类型列表。
  • disabled-on-edit/包含列出字段的文件，这些文件将在编辑对象时始终显示为仅读取的文件。
    • index.js导入的字段名称列表来自以每个相关模型命名的文件名

为了记录，“架构”和“模型类型”本质上是同一件事，这些术语在维护应用程序和其他地方都可以互换使用。模式是由API暴露的，但并非每个模型类型都列出了模式。为了增加混乱的“模型”，也有时也称为“对象”。

部分，模型类型和字段

为了使模型类型出现在维护应用中，需要满足以下条件：

• 该模型类型在src/config/maintenance-models.js中的部分下列出
• 模型类型存在于API中的模式端点中

一旦满足这些条件，模型类型将显示在maintenance-models.js中指定的部分的维护应用中。在创建或编辑新类型的模型时，默认情况下仅包含少数预定义字段。为了以形式显示其他字段，需要满足以下条件：

• 该字段在src/config/field-config/field-order.js中的模型类型下列出
• 该字段存在于API中特定模型类型的模式端点中。

添加新型号类型

在维护中添加新模型通常涉及以下步骤：

1. 将型号类型添加到src/config/maintenance-models.js
2. 添加模型类型和应以表格显示的字段列表到src/config/field-config/field-order.js
   1. （可选）如果应将字段分为形式的单独组，则可以在src/config/field-config/field-groups.js中指定组。
3. 现在，应在维护应用程序中列出新的型号类型。导航到新的模型类型，并在创建模型类型的新实例以及编辑现有实例时检查表单。如果幸运的话，此时一切都会正常工作。更有可能有一个或多个需要进一步自定义的字段。
4. 创建一个以src/config/field-overrides/命名的新文件。打开src/config/field-overrides/index.js ，导入新创建的文件，然后将其添加到overridesByType对象中。
5. 在新的字段Override文件（ src/config/field-overrides/newType.js ）中，开始为需要它的字段添加自定义。这通常涉及创建新组件和/或覆盖某些字段属性。查看现有字段覆盖以获取示例。
6. 在UI中显示为** string **字符串缺乏翻译。这些将需要添加到位于src/i18n/翻译文件中。某些字符串是动态生成的，并且只能在某些情况下出现，例如在尝试删除模型时。注意：翻译工作流程应在某个时候更改为使用i18next以d2.i18n 。

额外的特殊情况

某些模型需要自定义，超出了使用配置和字段覆盖的可能性。在src/router.js情况下

这种方法的示例包括：

• 事件程序编辑器： src/EditModel/event-program/EditEventProgram.component.js
• 自定义表单编辑器： src/EditModel/EditDataEntryForm.component.js