Show TOC

Dokumentation zur VorgehensweiseDokumentation einblenden und anlegen Dieses Dokument in der Navigationsstruktur finden

 

Ein Datenfluss sowie seine Objekte können Dokumentation tragen. Sie können die Dokumentation in der Datenflusspflege anzeigen und bearbeiten.

Vorgehensweise

Dokumentation einblenden

Um die Dokumentation anzuzeigen, wählen Sie Dokumentation einblenden (Dokumentation einblenden).

Das System blendet unterhalb des Datenflusses einen Bildbereich für die Dokumentation ein:

  • Wenn Sie ein Objekt im Datenfluss markiert haben, zeigt das System die Dokumentation für dieses Objekt an.

  • Wenn Sie kein Objekt des Datenflusses markiert haben, zeigt das System hier die Dokumentation für den Datenfluss an.

Der Titel der Dokumentation setzt sich zusammen aus dem Objekttyp, der Beschreibung und dem technischen Namen des Objektes. Für den Datenfluss selbst werden nur der Objekttyp und der technische Name als Titel angezeigt.

Um zwischen den Dokumentationen für die Objekte zu wechseln, markieren Sie das gewünschte Objekt im Datenfluss. Um in die Dokumentation für den Datenfluss selbst zu wechseln, markieren Sie den Hintergrund der Datenflusspflege.

Dokumentation anlegen und bearbeiten

  1. Um Dokumentation für den Datenfluss oder ein ausgewähltes Objekt anzulegen, wählen Sie im Änderungsmodus der Datenflusspflege im Bildbereich für die Dokumentation die Drucktaste Anzeigen <-> Ändern (Anzeigen <-> Ändern).

  2. Wählen Sie über die Drucktaste Dokumententyp [Text/HTML] (Dokumententyp) aus, in welchem Format Sie die Dokumentation anlegen möchten. Sie können eine reine Textdatei anlegen oder, falls Sie z.B. spezielle Formatierungen wünschen, HTML verwenden. Dies können Sie pro Dokumentation (also pro Objekt in einem Datenfluss) umstellen.

  3. Erstellen Sie im Editor die Dokumentation.

    Wenn die Dokumentation bereits in einer lokalen Datei verfügbar ist, können Sie diese über Lokale Datei laden (Lokale Datei laden) einfügen.

    Hinweis Hinweis

    Wenn Sie die Dokumentation als HTML anlegen möchten, empfehlen wir die Dokumentation in einem externen HTML-Editor zu erstellen und anschließend in die Dokumentationspflege der grafischen Modellierung zu übernehmen - entweder, indem Sie die HTML-Datei per Drag&Drop in den Editor ziehen oder, indem Sie die Datei über die Funktion Lokale Datei laden (Lokale Datei laden) einfügen.

    Ende des Hinweises

  4. Sie speichern die Dokumentation zusammen mit dem Datenfluss.

Weitere Funktionen
Suche

Um nach bestimmten Zeichenketten in der Dokumentation zu suchen, wählen Sie Suchen (Suchen).

Export

Um die Dokumentation auf einem lokalen Rechner abzulegen, wählen Sie Als lokale Datei speichern (Als lokale Datei speichern).