maintenance app

Wartung

App -Konfiguration

Die Wartungs -App wird größtenteils von der App -Konfiguration und den Schemas aus der API angetrieben. Die Schemata werden direkt aus der API (nach D2) gelesen. Die folgenden Dokumente dokumentieren die App -Konfiguration:

• Innerhalb von src/config/ ...
  • maintenance-models.js definiert die Modelltypen, die in der App angezeigt werden
  • field-config/ Enthält Konfiguration für jeden Modelltyp
    • field-order.js definiert die Reihenfolge der Felder innerhalb des Formulars für jeden Modelltyp
    • field-groups.js definiert die Feldgruppierung für das Formular für jedes Modell. Dies wird derzeit nur für Programme verwendet, aber es könnte eine gute Idee sein, es auch auf andere Modelltypen zu erweitern.
  • field-overrides/ enthält zusätzliche Konfiguration für Felder, die ein nicht standardmäßiges Verhalten erfordern. Am häufigsten bedeutet dies Felder, die spezielle Komponenten erfordern.
    • index.js listet alle Modelle auf, die ein oder mehrere Feldüberschreibungen haben
    • Die tatsächlichen Feldüberschreibungen werden in Dateien angegeben, die nach jedem Modelltyp benannt sind, was wiederum in index.js importiert wird. Einige Modelltypen oder Felder, die viel Logik erfordern, werden in Subordner unterteilt.
  • inlinehelp-mapping.json gibt die Zuordnung von jedem Abschnitt/Modell-Typ zu Seiten in der Dokumentation fest.
  • field-rules.js enthält eine bedingte Logik, mit der Felder angezeigt oder ausblenden oder Feldwerte basierend auf dem Wert anderer Felder festgelegt werden können.
  • periodTypes.json enthält die Liste der Periodypen, die von der aktuellen Version der API unterstützt werden.
  • disabled-on-edit/ Enthält Dateien, in denen Felder auflisten, die immer als schreibgeschützt angezeigt werden, wenn ein Objekt bearbeitet wird.
    • index.js importiert Listen von Feldnamen aus Dateien, die nach jedem relevanten Modell benannt sind

Für den Datensatz sind "Schemas" und "Modelltypen" im Wesentlichen dasselbe und diese Begriffe werden sowohl in der Wartungs -App als auch in anderen Teilen synonym verwendet. Schemata werden von der API ausgesetzt, aber nicht jeder Modelltyp ist in den Schemata aufgeführt. Zu den Verwirrungsmodellen "werden auch einige Male als" Objekte "bezeichnet.

Abschnitte, Modelltypen und Felder

Damit ein Modelltyp in der Wartungs -App angezeigt werden kann, müssen die folgenden Bedingungen erfüllt sein:

• Der Modelltyp ist unter einem Abschnitt in src/config/maintenance-models.js aufgeführt
• Der Modelltyp existiert im Schemasendpunkt in der API

Sobald diese Bedingungen erfüllt sind, wird der Modelltyp in der Wartungs-App unter dem in maintenance-models.js angegebenen Abschnitt angezeigt. Beim Erstellen oder Bearbeiten von Modellen des neuen Typs enthält das Formular standardmäßig nur eine Handvoll vordefinierter Felder. Damit zusätzliche Felder im Formular angezeigt werden können, müssen die folgenden Bedingungen erfüllt sein:

• Das Feld ist unter dem Modelltyp in src/config/field-config/field-order.js aufgeführt.
• Das Feld existiert im Schemasendpunkt für den spezifischen Modelltyp in der API.

Hinzufügen eines neuen Modelltyps

Das Hinzufügen eines neuen Modells zur Wartung umfasst in der Regel die folgenden Schritte:

1. Fügen Sie den Modelltyp zu src/config/maintenance-models.js hinzu
2. Fügen Sie den Modelltyp und die Liste der Felder hinzu, die im Formular in src/config/field-config/field-order.js angezeigt werden sollten.
   1. (Optional) Wenn die Felder in der Form in separate Gruppen unterteilt werden sollten, können die Gruppen in src/config/field-config/field-groups.js angegeben werden.
3. Der neue Modelltyp sollte nun in der Wartungs -App aufgeführt werden. Navigieren Sie zum neuen Modelltyp und überprüfen Sie das Formular sowohl beim Erstellen einer neuen Instanz des Modelltyps als auch beim Bearbeiten einer vorhandenen Instanz. Wenn Sie Glück haben, funktioniert an diesem Punkt alles einfach. Wahrscheinlicher ist, dass es ein oder mehrere Felder geben wird, die eine weitere Anpassung erfordern.
4. Erstellen Sie eine neue Datei, die nach dem neuen Modelltyp in src/config/field-overrides/ benannt ist. Öffnen Sie src/config/field-overrides/index.js , importieren Sie die neu erstellte Datei und fügen Sie sie dem overridesByType -Objekt hinzu.
5. In der neuen Feldüberschreibungsdatei ( src/config/field-overrides/newType.js ) können Anpassungen für die erforderlichen Felder hinzugefügt werden. Dies beinhaltet in der Regel das Erstellen neuer Komponenten und/oder das Überschreiben bestimmter Feldeigenschaften. Schauen Sie sich die vorhandenen Feldüberschreibungen für Beispiele an.
6. Saiten, die als ** string ** in den UI -Übersetzungen auftreten. Diese müssen zu den Übersetzungsdateien in src/i18n/ hinzugefügt werden. Einige Zeichenfolgen werden dynamisch erzeugt und können nur in bestimmten Situationen angezeigt werden, beispielsweise beim Versuch, ein Modell zu löschen. Hinweis: Der Übersetzungs -Workflow sollte sich irgendwann ändern, wenn I18Next zugunsten von d2.i18n verwendet wird.

Besondere Fälle

Bestimmte Modelle erfordern eine Anpassung über das, was mit den Konfigurations- und Feldüberschreibungen möglich ist. In diesen Fällen kann es erforderlich sein, eine neue Komponente der obersten Ebene zu erstellen und diese Komponente mit einer speziellen Route in src/router.js zu assoziieren

Beispiele für diesen Ansatz umfassen:

• Event Program Editor: src/EditModel/event-program/EditEventProgram.component.js
• Benutzerdefinierter Formular Editor: src/EditModel/EditDataEntryForm.component.js