Das "Datenhandbuch" ist eine Sonderfunktion des SOG Hilfesystems.
Im Datenhandbuch werden aus dem SOG DataDictionary Tabellenbeschreibungen generiert, die auf diese Weise immer auf dem aktuellesten Stand sind. Zusätzlich zu den generierten Informationen können jedoch für die Tabellen und für einzelne Datenfelder manuell Hilfetexte hinzugefügt werden.
Die Menge der Tabellen im Datenhandbuch ergibt sich aus folgenden Konfigurationsdateien:
${PROJ}\\file\\file.ccf
${PROJ}\\file\\file_local.ccf
${PROJ}\\file\\file2.ccf
${PROJ}\\file\\file2_local.ccf
Sowie über die folgenden Konfigurationen, gesucht über die Variable "FRMCFGPATH".
dhb_base.txt
dhb_Proj.txt
dhb_vorort.txt
Aus den genannten Konfigurationen werden alle Elemente verwendet, die in einer "db" oder "dbview" Zeile definiert wurden.
Individuelle Tabellen können durch einen entsprechenden Eintrag in einer dieser Konfigurationen dem Datenhandbuch hinzugefügt werden.
Die automatisch generierte Übersicht
Die Tabellenübersicht wird automatisch aus der Hilfe zu den Tabellen erzeugt. Dazu müssen am Anfang der Tabellen-Hilfe die folgenden Schlüsselworte verwendet werden. Es werden nur Tabellen aufgenommen, die einen gültigen Tabellentyp aufweisen
Bemerkungen:
Programme:
Tabellentyp: Stammdaten / Bewegungsdaten / View / Parameter / Arbeitsdaten / Schnittstelle
Die Schlüsselworte müssen am Anfang der Hilfe stehen. Die erste Zeile ohne Schlüsselwort beendet die Definition von Schlüsselworten. Es sind nur die aufgelisteten Schlüsselworte erlaubt.
Als Tabellentypen sind nur die aufgelisteten Typen erlaubt. Wir ein anderer Typ definiert, erfolgt eine Fehlermeldung beim Aufbau der Tabelle.