Dokumenttypen

Aus BormOnlineHilfe
Zur Navigation springen Zur Suche springen

Die Dokumentenverwaltung ist in der Lage jegliche Art von Dokumenttypen zu verwalten. Jeder Dokumenttyp hat jedoch seine Eigenheiten die es in einer Dokumentenverwaltung zu beachten gilt.

Für Dokumenttypen stehen in der Verarbeitung Dokumenttypen nachfolgende aufgeführte Möglichkeiten zur Verfügung.

Feld Beschreibung
Erweiterung Definiert die Dateiendung
Beschreibung Name der Anwendung
Verzeichnisablage Sollen Dokumenttypen in einer Verzeichnisstruktur (Ordner) abgelegt werden Ja/Nein. Ist für Mehrdateiendokumente empfehlenswert.
Vorlage Hier muss die Endung eines Vorlagentypes eingetragen werden den es für diese Datei gibt. Z.B. ist für Word Dokumente mit der Endung doc die Vorlage dot.
Start Script Das Start Script wurde ausgeführt bevor ein Dokument geöffnet wird. Dies kann dazu verwendet werden um z.B. vor dem öffnen Informationen aus der Datenbank in eine Textdatei zu schreiben damit diese dem öffnenden Programm zur Verfügung stehen.
In diesem Script muss die Funktion BOOL function OpenDocument() enthalten sein. Diese muss als Rückgabewert TRUE haben wenn das Dokument geöffnet werden soll ansonsten FALSE wenn nicht.

Das Programm verarbeitet die Variable Parameter weiter. Der Inhalt wird an den Startbefehl des Programms angehängt.
Drucken Script Das Drucken Script entspricht dem Start Script.
Die Funktion muss nur BOOL function PrintDocument() heissen.
Vorlagen Script Das Vorlagen Script wird nach dem Dateiinfo Dialog ausgeführt nach dem der Benutzer diesen mit speichern bestätigt hat.
Es dient dazu, bei komplexeren Vorlagen das entsprechend notwendige Dateihandling durchzuführen. Z.B. wenn ein Dokumenttyp eine Verzeichnisablage benutzt, kann das Script dazu verwendet werden, alle zur Vorlage zugehörigen Datei mit in das neue Dokumentverzeichnis zu kopieren.

Die Funktion hat als Rückgabewert BOOL. Wird TRUE zurückgegeben, wird das Dokument als Neu aufgenommen, andernfalls wird die Aktion abgebrochen.
Löschen Script Das Löschen Script wird vor dem Löschen eines Dokumentes und des entsprechenden Datensatzes aus der Datenbank ausgeführt.
Wird TRUE zurückgegeben, gilt das Dokument als gelöscht andernfalls wird die Aktion abgebrochen.
MDI Dokument Ein MDI Dokument ist ein Dokument das mit einem Programm verknüpft ist, das mehrere Dokumente gleichzeitig geöffnet haben kann. Dies ist notwendig um eine Sperrung der Dokumente zu ermöglichen.


Startscript

Das Start Script wird ausgeführt bevor ein Dokument geöffnet wird. Dies kann dazu verwendet werden um z.B. vor dem öffnen Informationen aus der Datenbank in eine Textdatei zu schreiben damit diese dem öffnenden Programm zur Verfügung stehen.

In diesem Script muss die Funktion BOOL function OpenDocument() enthalten sein. Diese muss als Rückgabewert TRUE haben wenn das Dokument geöffnet werden soll ansonsten FALSE wenn nicht.

Das Programm verarbeitet die Variable Parameter weiter. Der Inhalt wird an den Startbefehl des Programms angehängt.

Dem Script werden folgende Variablen übergeben:

Variable Typ Beschreibung
DOKV_ID String Enthält den Primärschlüssel des aktuellen Dokumentes.
CURRENT_MASTER_TABLE Long Enthält den Namen der Datenbanktabelle die dem Dokumentenfenster übergeordnet ist.
CURRENT_MASTER_FIELD_NAME String Enthält den Feldnamen des Primärschlüssels der Datenbanktabelle die dem Dokumentenfenster übergeordnet ist.
CURRENT_MASTER_FIELD_VALUE Long Enthält den Wert des Primärschlüssels der Datenbanktabelle die dem Dokumentenfenster übergeordnet ist.
PARAMETER String Diese Variable ist zu Beginn leer. Sie wird verwendet, um bei einem Programmstart dem Dokument Argumente mitzugeben. Das Dokument wird dann aufgerufen mit dem Wert der Variablen.
DOKV_FILENAME String Diese Variable enthält den Dateinamen des Dokumentes.
DOKV_PATHNAME String Diese Variable enthält den Pfad des Dokumentes.
DOKV_FULLNAME String Diese Variable enthält den Dateinamen des Dokumentes.
DOKV_MAIN_ID Long Diese Variable enthält den Wert des Primärschlüssels der Tabelle DOKV_MAIN.

Drucken Script

Das Drucken Script entspricht dem Start Script. Die Funktion muss nur BOOL function PrintDocument() heissen.


Vorlagen Script

Das Vorlagen Script wird nach dem Dateiinfo Dialog ausgeführt nach dem der Benutzer diesen mit speichern bestätigt hat. Es dient dazu, bei komplexeren Vorlagen das entsprechend notwendige Dateihandling durchzuführen. Z.B. wenn ein Dokumenttyp eine Verzeichnisablage benutzt, kann das Script dazu verwendet werden, alle zur Vorlage zugehörigen Datei mit in das neue Dokumentverzeichnis zu kopieren.

Die Funktion hat als Rückgabewert BOOL. Wird TRUE zurückgegeben, wird das Dokument als Neu aufgenommen, andernfalls wird die Aktion abgebrochen.

Variable Typ Beschreibung
DOKV_ID String Enthält den Primärschlüssel des aktuellen Dokumentes.
CURRENT_MASTER_TABLE Long Enthält den Namen der Datenbanktabelle die dem Dokumentenfenster übergeordnet ist.
CURRENT_MASTER_FIELD_NAME String Enthält den Feldnamen des Primärschlüssels der Datenbanktabelle die dem Dokumentenfenster übergeordnet ist.
CURRENT_MASTER_FIELD_VALUE Long Enthält den Wert des Primärschlüssels der Datenbanktabelle die dem Dokumentenfenster übergeordnet ist.
DOKV_FILENAME String Diese Variable enthält den Dateinamen des Dokumentes.
DOKV_PATHNAME String Diese Variable enthält den Pfad des Dokumentes.
DOKV_FULLNAME String Diese Variable enthält den Dateinamen des Dokumentes.
DOKV_MAIN_ID Long Diese Variable enthält den Wert des Primärschlüssels der Tabelle DOKV_MAIN.
DOKV_TEMPLATE String Vollständiger Pfad und Dateiname der Vorlage.
DOKV_TEMPLATEDIR String Verzeichnis der Vorlage


Löschen Script

Das Löschen Script wird vor dem Löschen eines Dokumentes und des entsprechenden Datensatzes aus der Datenbank ausgeführt. Die Funktion muss BOOL function FileDelete() heissen.

Wird TRUE zurückgegeben, gilt das Dokument als gelöscht andernfalls wird die Aktion abgebrochen.

Dem Script werden folgende Variablen übergeben:

Variable Typ Beschreibung
CURRENT_MASTER_TABLE Long Enthält den Namen der Datenbanktabelle die dem Dokumentenfenster übergeordnet ist.
CURRENT_MASTER_FIELD_NAME String Enthält den Feldnamen des Primärschlüssels der Datenbanktabelle die dem Dokumentenfenster übergeordnet ist.
CURRENT_MASTER_FIELD_VALUE Long Enthält den Wert des Primärschlüssels der Datenbanktabelle die dem Dokumentenfenster übergeordnet ist.
DOKV_FILENAME String Diese Variable enthält den Dateinamen des Dokumentes.
DOKV_PATHNAME String Diese Variable enthält den Pfad des Dokumentes.
DOKV_FULLNAME String Diese Variable enthält den Dateinamen des Dokumentes.