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