KOBV > Entwicklung > Software > MABLE+ > Dokumentation

Dokumentation

  • Systemvoraussetzungen

    1. Java
      Voraussetzung für die Benutzung von Mable+ ist eine aktuelle Java Runtime Umgebung (JRE), die auf vielen System bereits existiert oder unter folgenden URLs gefunden werden kann.
      http://www.java.com/download/
      http://openjdk.java.net/

      Wenn Java installiert ist, muß außerdem die Umgebungsvariable JAVA_HOME gesetzt sein und auf den Ordner, der die Java Installation enthält zeigen, z.B. C:ProgrammeJavajre6.

    2. Windows (ab XP)
      Für die Installation ist die ZIP-Datei mable-1.1-bin.zip in einen beliebigen Ordner auszupacken, z.B. C:Java. Dabei wird dort der Ordner mable-1.1 erstellt, der die zu Mable+ gehörenden Resourcen und Skripte enthält.

      Anschließend muß die Umgebungsvariable MABLE_HOME auf den Pfad zur Mable+ Installation gesetzt werden, z.B. C:Javamable-1.1.

      Der Pfad %MABLE_HOME%bin für die Mable+ Skripte muß zur PATH Umgebungsvariable hinzugefügt werden.

      Auf der Konsole (Windows-Taste+R und dann cmd eingeben) mable -v ausführen, um die Installation zu prüfen.

      Umgebungsvariablen erstellt oder bearbeitet man in Windows, indem man einen Rechtsklick auf den "Arbeitsplatz" ausführt und auf "Eigenschaften" geht. Die Registerkarte "Erweitert" bietet dann Zugriff auf die "Umgebungsvariablen". Die für Mable+ notwendigen Umgebungsvariablen sollten in der Regel nur für den Nutzer und nicht das gesamte System angelegt werden.
      Umgebungsvariable JAVA_HOME
      Beispielwert: C:ProgrammeJavaJre1.6.0_23
      Kommentar: Pfad zur JRE Installation

      Umgebungsvariable MABLE_HOME
      Beispielwert: C:Javamable-1.1
      Kommentar: Pfad zur Mable+ Installation

      Umgebungsvariable PATH
      Beispielwert: %PATH%;%MABLE_HOME%bin
      Kommentar: Standard Umgebungsvariable

      Umgebungsvariable JAVA_OPTS
      Beispielwert: -Xms128m -Xmx512m
      Kommentar: Optional (Empfohlen)



    3. Unix-basierte Systeme (Linux, Solaris, Mac OS X)
      Für die Installation das Distributions Archive, z.B. mable-1.1-bin.tar.gz in einen beliebigen Ordner auspacken, z.B. /usr/local/mable oder auch %HOME/.mable für nur einen Nutzer in dessen Home Verzeichnis.

      Anschließend muß die Umgebunsvariable MABLE_HOME auf den Pfad zur Mable+ Installation gesetzt werden, z.B. export MABLE_HOME=/usr/local/mable.

      Der bin Ordner von Mable+ muss zur %PATH Variable hinzugefügt werden, z.B. export PATH=$PATH:$MABLE_HOME/bin.

      Außerdem sollte JAVA_HOME gesetzt sein, und $JAVA_HOME/bin sollte in der PATH Umgebungsvariable gesetzt sein.

      Auf der Konsole mable -v ausführen, um die Installation zu überprüfen.

    4. Speicherplatz für Mable+ erhöhen
      Sollte die Menge an Speicher, die Java standardmäßig verwendet nicht ausreichen, kann die Umgebungsvariable JAVA_OPTS gesetzt werden. Der Wert -Xms128m -Xmx512m erhöht den anfänglich reservierten Speicher auf 128 MByte und den maximal verwendeten Speicher auf 512 MByte.

      JAVA_OPTS = -Xms128m -Xmx512m
  • In der aktuellen Version kann die Konfiguration nicht vom Nutzer modifiziert werden. In Zukunft wird es eine flexible Konfigurationsdatei geben, die an die lokalen Bedürfnisse angepasst werden kann.

    Parser Checks

    Beim Einlesen der Daten führt der MAB Parser bereits Prüfungen durch. Fehler im Format oder nicht erlaubte Zeichen werden erkannt und in die Fehlerreports aufgenommen. 

    Modulare Checks

    Im folgenden sind die Mable+ Checks aufgelistet, die als Module implementiert sind, und für welche Felder sie momentan konfiguriert sind.

    Die Fehler Spalte in den Tabellen bezieht sich auf die internen Mable+ Konstanten für die entsprechenden Fehlercodes.

    Wiederholfaktoren

    Das Wiederholfaktoren Modul prüft sämtliche Felder anhand der MAB2 Spezifikatioen. Es meldet fehlende Felder, Felder, die zu häufig auftreten, und Felder, die für den Satztyp nicht zugelassen sind.

    Fehlendes Feld für Satztyp

    Die folgenden Felder werden zusätzlich geprüft.

    Datensatztyp = u
    Feldnummer = 90
    Indikator = 
    Fehler = U_SATZ_OHNE_090

    Datensatztyp = u
    Feldnummer = 89
    Indikator = '_'
    Fehler = U_SATZ_OHNE_BANDANGABE_VORLAGEFORM

    Unerlaubtes Feld für Satztyp

    Datensatztyp = h
    Feldnummer = 89
    Fehler = H_SATZ_MIT_BANDANGABE_VORLAGEFORM

    Datensatztyp = h
    Feldnummer = 90
    Fehler = H_SATZ_MIT_BANDANGABE_SORTIERFORM

    Datensatztyp = h
    Feldnummer = 10
    Fehler = H_SATZ_MIT_UEBERGEORDNETEM_SATZ 

    Datensatztyp = u
    Feldnummer = 300, 310, 333, 340, 522
    Fehler = U_SATZ_MIT_[FELDNUMMER]

     

    Mindestens eines von zwei Feldern

    Datensatztyp = h
    Feldnummer = 51
    Feldnummer B = 52
    Fehler = H_SATZ_OHNE_051_052 

    Feldlänge

    Feldnummer = 89
    min = 7, max = 8
    Länge = k.A.
    Fehler = SATZ_MIT_FALSCHER_051_LAENGE

    Feldnummer = 52
    min = k.A., max = k.A.
    Länge = 15
    Fehler = ATZ_MIT_FALSCHER_052_LAENGE

    Feld Konflikte

    Feldnummer = 52
    Indikator = '_'
    Feldnummer B = 100
    Indikator B = '_'
    Fehler = FORTLAUFENDES_SAMMELWERK_MIT_VERFASSER

    Feldnummer = 100
    Indikator = '_'
    Feldnummer B = 200
    Indikator B = '_'
    Fehler = SATZ_MIT_100_UND_200_BLANK

    Feldabhängigkeiten

    Feldnummer = 300
    Indikator = '_'
    Feldnummer B = 100
    Indikator = '_'
    Fehler = SATZ_MIT_300_OHNE_100_BLANK

    Feldnummer = 102
    Indikator = k.A.
    Feldnummer B = 100
    Indikator = k.A.
    Fehler = PND_NUMMER_OHNE_NAME

    Feldnummer = 202
    Indikator = k.A.
    Feldnummer B = 200
    Indikator = k.A.
    Fehler = GKD_NUMMER_OHNE_KOERPERSCHAFT

    Der Check für PND Nummern ohne Namen, bzw. GKD Nummern ohne Körperschaft wird für alle 25 gleichartigen Felder durchgeführt.

    Referenzen

    In der aktuellen Version werden die Referenzen in folgenden Feldern überprüft.

    • 010
    • 453, 463, 473, 483, 493
  • Mable+ kann auf der Konsole (Windows: "Start", "Ausführen...", Eingaben von "cmd") mit verschiedenen Kommandos und Optionen ausgeführt werden.

    Hilfe anzeigen

    Das folgende Kommando zeigt die momentan von Mable+ unterstützten Unterkommandos und Optionen.

    mable -h
    Die Option utf8 ist noch in der Entwicklung. Sie schaltet die Verwendung des MAB Zeichensatzes ab und ist für Dateien gedacht, die nicht MAB, sondern UTF-8 kodiert wurden.

    Kommandos

    check (prüft MAB2 Dateien auf Fehler)
    extract (kopiert Sätze aus einer MAB2 Datei)
    count (zählt die Sätze in einer MAB2 Datei)
    index (generiert einen Index mit den Positionen der Sätze in einer MAB2 Datei)
    filter-errors (filtert ERRORS Reportdatei nach Sätzen oder Fehlern)
    analyse-errors (erzeugt zusätzliche Statistiken aus dem ERRORS Report) 

    1. Check Kommando
      Mit diesem Kommando können MAB Daten auf Fehler geprüft werden. Das Kommando unterstütz jetzt auch MABXML Dateien.
      mable check [MAB2DATEI]
    2. Extract Kommando
      mable -ds  extract 

      Die Bytes des Datensatzes werden entweder direkt in der Konsole angezeigt oder können in eine Datei ausgegeben werden.

      mable -ds  -o satz.mab extract 
    3. Count Kommando
      mable count 
    4. Index Kommando
      Das Index Kommando funktioniert nur für MAB2 Dateien. Es generiert eine Liste mit den Satz Identifiern (MAB001) und der Position des Satzes innerhalb der Datei.
      0001, 0
      0002, 876
      0003, 1456

      Damit können einzelne Sätze innerhalb der Datei schnell gefunden werden, zum Beispiel in einem Hex-Editor.

      mable index  -o index.txt
    5. MAB Datei prüfen
      Eine MAB Datei kann mit folgendem Kommando überprüft werden.
      mable check DATEINAME

      Das check Kommando liest die MAB Daten und erzeugt mehrere Report Dateien. Die generierten Reports werden im aktuellen Ordner abgelegt.

     
    Report Dateien
    Das Check Kommando erzeugt mehrere Dateien mit Information über die analysierten Daten. Die Dateinamen entsprechen dem folgenden Muster.
    [MABDATEINAME]-[YYYYMMDD]-[HHMMSS]-MABle-[REPORT].txt
    

    Zum Beispiel:

    example.mab-20110226-143510-MABle-report.txt
    example.mab-20110226-143510-MABle-errors.txt
    example.mab-20110226-143510-MABle-no001.txt
    example.mab-20110226-143510-MABle-codes.txt

    Es gibt vier verschiedene Report Dateien.

    #-report.txt (Statistik über gefundene Fehler und Felder)
    #-errors.txt (Mapping zwischen Sätzen (001) und Fehlercodes i)
    #-no001.txt (Inhalt von Sätzen ohne 001 Feld auf)
    #-codes.txt (enthält alle Fehlercodes, die aufgetreten sind)
    1. Report Datei
      Die Report Datei enthält folgende Statistiken über die MAB Daten und die gefundenen Fehler.
      • Anzahl der Sätze
      • Satztypen Statistik
      • Satzstatus Statistik
      • Lieferungsfehler
      • Satzfehler
      • Feldfehler
      • Unterfeldfehler
      • Belegte Felder
      • "Rejected" Felder (Experimentell)
    2. Errors Datei
      Die errors Datei enthält für jeden gefunden Fehler eine Zeile mit der Satzkennung und dem Fehlercode, wie im folgenden Beispiel.
      61, #2225
      3433, #2202
      12324, #5096
      

      Auf UNIX-basierten System kann mit Hilfe von Standardbefehlen wie grep leicht herausgefunden werden welche Sätze einen bestimmten Fehler hatten

      cat ERRORSDATEI | grep '#2202'

      oder welche Fehler ein bestimmter Satz hatte.

      cat ERRORSDATEI | grep 

      Unter Windows kann man um Beispiel einen Texteditor verwenden um die Datei zu durchsuchen.

      Filter Kommando
      Das folgende Kommando kann verwendet werden, um in der Fehlerdatei alle Sätze mit einem bestimmten Fehler zu finden.

      mable filter-errors -e 2202

      Um die gefundenen Fehler für einen bestimmten Satz angezeigt zu bekommen kann das folgende Kommando verwendet werden.

      mable filter-errors -id

      Analyse Kommando
      Das folgende Kommando kann verwendet werden, um aus der ERRORS Datei noch mehr Statistiken zu ermitteln. Dabei wird auch die CODES Datei verwendet, um die korrekten Fehlermeldungen zu integrieren.

      mable analyse-errors

      Die erzeugten Statistiken geben an, wieviele Sätze einen, zwei, usw. Fehler hatten und welche Fehler in den Gruppen mit jeweils n Fehlern aufgetreten sind.

    3. No001 Datei
      Die no001 Datei enthält die Sätze, die kein MAB 001 Feld hatten und daher auch nicht in der errors Datei erfasst werden konnten.
    4. Codes Datei
      Die Codes Datei enthält alle aufgetretenen Fehlercodes und Meldungen. Sie wird von "analyse-errors" Kommando verwendet, um in der Statistik die korrekten Fehlermeldungen verwenden zu können.