Metadaten und Dokumententypen migrieren

Metadaten, die Sie manuell über den Metadaten-Designer oder die docform-Dokumententypen angelegt haben, können Sie über ein Tool in exportfähige yml-Dateien konvertieren / migrieren.

Für alle Projekte, die Sie vor der agorum core-Version 10.0.2 erstellt haben, müssen Sie eine Migration durchführen.

Vorbereitungen treffen

• Zur Verwendung des Tools müssen Sie im agorum core explorer mit einem Rechtsklick über das Kontextmenü agorum core template manager > Neues Projekt installieren (aus Vorlage) ein Projekt anlegen.
• Das System verwendet dieses Projekt als Ziel für die neuen Definitionen.
• Sie können auch ein bereits vorhandenes Projekt verwenden.

Das Tool aufrufen

Um die Migration zu starten, müssen Sie das Tool aufrufen. Das Tool ist eine JavaScript-Datei.

1. Öffnen Sie links in der Seitenleiste Explorer.
2. Öffnen Sie den Pfad:

   /agorum/roi/customers/agorum.metadata.collection/js/utils/migrate-doctypes-metadata.js
   
   als Benutzer roi:
   
   Eigene Dateien/Administration/customers/agorum.metadata.collection/js/utils/

3. Öffnen Sie das JavaScript:

   migrate-doctypes-metadata.js

Einstellungen vornehmen

Bevor Sie das Skript migrate-doctypes-metadata.js ausführen können, müssen Sie das Skript an Ihre eigenen Bedürfnisse anpassen. Hierzu stellen Sie die Parameter im Skript ein.

Sie müssen nur den Parameter TARGET_PROJECT anpassen, alle anderen Parameter können Sie im Standard belassen.

[
 /prefix_.*/
]

[
 /prefix_.*/
]

Das Tool ausführen

Nachdem Sie die notwendigen Parameter eingestellt haben:

1. Führen Sie das Skript mit Klick auf Run aus.
   
   Ergebnis:
   
   • Das System benötigt einige Zeit, um die migrierten Daten zu erzeugen.
   • Die Schaltfläche Run ist grau hinterlegt.
   • Nach Fertigstellung ändert sich die Farbe wieder auf Schwarz und Sie können die Generierung für weitere Projekte erneut anstoßen.

Skript mit Run ausführen

Erstellte Dateien einsehen

Bei Ausführung des Skripts erstellt das System die jeweiligen Dateien an den jeweils korrekten Orten mit den in den Parametern definierten Namen unterhalb des angegebenen Projektordners. Die Namen der Dateien können abweichen, wenn Sie diese in den Parametern verändert haben.

Die neu erstellten Dateien sind fett markiert:

• Projektordner
  • deploy
    • pre
      • messages
        • messages_de-migrated.properties
    • yml
      • metadata-collection-migrated.yml
      • metadata-migrated.yml
      • export-migrated.yml

Der Inhalt der erzeugten yml-Dateien weist ggf. technische Schreibweisen auf, die sonst unüblich sind. etwa werden in der agorum core-Dokumentation leere Angaben in der Regel ohne null angegeben. Im Export wird jedoch null als leere Angabe verwendet. Die Schreibweisen sind unterschiedlich, meinen aber das Gleiche.

Leere Angaben mit „null“

'-Rechnung':
  items:
    - '-ReNummer': null
      docform:
        extractor: string
    - '-ReDatum': null
      docform:
        extractor: date

Leere Angaben ohne „null“

-Rechnung:
  items:
    - -ReNummer:
      docform:
        extractor: string
    - -ReDatum:
      docform:
        extractor: date

Auch können weitere Schreibweisen vorkommen, etwa | oder >.

messages_de-migrated.properties

Diese Datei enthält mögliche Übersetzungen, sofern diese beim Export vorhanden waren.

• Es wird lediglich die deutsche Sprachdatei exportiert.
• Weitere Sprachen / Übersetzungskeys müssen Sie im Nachgang manuell ergänzen.
• Um diese Datei korrekt verwenden zu können, muss diese in messages_de.properties umbenannt werden. 

metadata-migrated.yml

Diese Datei enthält Ihre Metadaten-Definitionen. Zum einen die, die im Quellsystem definiert waren und zum Filter FILTER_METADATA passten, und zum anderen die, die sich aus dem Export der docform-Dokumententypen ergaben.

Wenn die Metadaten sich aus der docform-Dokumententypen ergeben, werden Standardeinstellungen, die es auch bei Metadaten gibt (Name, optional, dataSource, ...) bei der Metadaten-Definition hinterlegt. In der metadata-collection stehen dann diese Angaben nicht, weil diese sich vom Metadatum ergeben.

metadata-collection-migrated.yml

Diese Datei enthält alle migrierten Kollektionen und docform-Dokumententypen, die Sie über den Filter FILTER_DOC_TYPES definiert haben.

Damit die migrierten Kollektionen und docform-Dokumententypen durch das System angelegt werden:

1. Führen Sie die Datei mit einem Klick auf Run aus.

Die Angaben in dieser Datei funktionieren nur zusammen mit den dazugehörigen exportierten Metadaten in der Datei metadata-migrated.yml.

export-migrated.yml

Diese Datei enthält die MetaDB-Schlüssel für die dataSource-Definitionen, sofern diese in den exportierten Metadaten vorhanden waren.

Das System exportier lediglich die Definitionen, aber nicht die dahinterliegenden Daten (etwa eine Datenbank oder eine CSV-Datei).

Migrierte Metadaten durch das System anlegen lassen

Nach Erstellung der Daten lassen Sie die migrierten Metadaten durch das System anlegen, damit Sie später die Metadaten verwenden können.

1. Prüfen Sie die migrierten Dateien auf Richtigkeit, speziell auf die Metadaten und die docform-Dokumententypen.
2. Öffnen Sie folgende Dateien in dieser Reihenfolge:
   
   • metadata-migrated.yml
   • metadata-collection-migrated.yml
3. Führen Sie die Datei metadata-migrated.yml mit einem Klick auf Run aus und warten Sie, bis sich Run wieder schwarz färbt.
   
   Ergebnis: Das System hat die migrierten Metadaten angelegt.
4. Führen Sie die Datei metadata-collection-migrated.yml mit einem Klick auf Run aus und warten Sie, bis sich Run wieder schwarz färbt.
   
   Ergebnis: Das System hat die migrierten Kollektionen und docform-Dokumententypen angelegt.

Dateien „metadata-migrated.yml“ und „metadata-collection-migrated.yml“ umbenennen

Benennen Sie die migrierte Dateien metadata-migrated.yml und metadata-collection-migrated.yml im Projektordner um, damit Sie später die Metadaten beim importierten Projekt verwenden können.

Die Datei „metadata-migrated.yml“ umbenennen

1. Prüfen Sie die migrierten Dateien auf Richtigkeit, speziell auf die Metadaten und die docform-Dokumententypen.
2. Öffnen Sie im Projektordner den Pfad:

   yml

3. Benennen Sie die Datei metadata.yml in metadata_old.yml um, um die Altdaten behalten und vergleichen zu können.

Datei „metadata-collection-migrated.yml“ umbenennen

1. Prüfen Sie die migrierten Dateien auf Richtigkeit, speziell auf die Metadaten und die docform-Dokumententypen.
2. Benennen Sie die Datei metadata-collection-migrated.yml in metadata-collection.yml um.

Metadaten erzeugen

Zum Erzeugen der Metadaten benötigen Sie eine spezielle Datei, die den Aufruf der metadata-collection.yml startet und die Metadaten im System anlegt. Ist dieser Schritt abgeschlossen, können Sie die Metadaten im System verwenden. 

1. Öffnen Sie im Projektordner den Pfad:

   deploy/pre/js
   

2. Öffnen Sie die Datei 010 metadata.js.
3. Klicken Sie auf Run, um die Datei auszuführen.
4. Öffnen Sie mit einem Rechtsklick das Kontextmenü und wählen Sie dann Neu > JS-Dokument.
5. Vergeben Sie den Dateinamen:

   011 metadata-collection.js

6. Befüllen Sie das JavaScript mit unten aufgeführtem Skript und passen Sie den Pfad zu Ihrer zuvor umbenannten Datei metadata-collection.yml in der 3. Zeile an:

   let yaml = require('common/objects').find('<Projekt>/yml/metadata-collection.yml');

 /* global sc */
let mcb = require('/agorum/roi/customers/Standard/js/metadata-collection-builder');
let yaml = require('common/objects').find('<Projekt>/yml/metadata-collection.yml');

mcb(yaml).install(sc);