Neben dem Anzeigen von Ressourcen müssen Sie die von Ihnen erstellten Anwendungen möglicherweise dokumentieren. WebSphere Integration Developer enthält ein Tool zum Generieren von Dokumentation für die Ressourcen in Ihren Modulen, Mediationsmodulen und Bibliotheken.
Die Generierung von Dokumentation wird über das Aufrufen eines Assistenten eingeleitet. Sie können den Inhalt der Dokumentation anpassen, indem Sie mehrere Ressourcen aus einem oder mehreren Modulen bzw. einer oder mehreren Bibliotheken auswählen, damit die gesamten Informationen in einen einzigen Bericht, eine PDF-Datei, geschrieben werden. Darüber hinaus können Sie das Layout und die Schriftart für die Ausgabe angeben. Die zugehörigen Tasks enthalten ausführliche Anweisungen zum Generieren der Dokumentation.
Der Dokumentationsgenerator produziert die folgenden Informationen für diese Ressourcen:
Andere Ressourcen werden vom Dokumentationsgenerator nicht dokumentiert.
Der Dokumentationsgenerator kann auch Dokumentation für die ausgewählten Ressourcen generieren und für die Ressourcen, auf die die ausgewählten verweisen. Sie können beispielsweise im Assistenten für die Dokumentationsgenerierung den Geschäftsprozess und die Option Dateien, auf die verwiesen wird, einschließen auswählen. Auf diese Weise enthält der generierte PDF-Bericht auch Informationen zu den Ressourcen (z. B. durch deren Aktivitäten aufgerufene Schnittstellen), auf die der Prozess verweist.
Der generierte PDF-Bericht weist die folgende Struktur auf:
Enthält den Titel des Berichts, den Namen des Autors sowie das Datum des Berichts.
Liste der Abschnitte und Seitenzahlen des Berichts.
Liste der Eigenschaften der Ressourcen. Für alle Ressourcen werden auch Bilder der in der Ansicht 'Editor' geöffneten Ressourcen angezeigt. Dies gilt nicht für Module und Bibliotheken.
Liste, die für jede dokumentierte Ressource angibt, welche Ressource diese verwendet (Liste der Provider) und wo sie verwendet wird (Empfängerliste).
Liste der Einstellungen für die Dokumentationsgenerierung, die im Assistenten für die Dokumentationsgenerierung angegeben und für den PDF-Bericht verwendet wurden.
Layout und Stil des generierten PDF-Berichts können mit Hilfe des Assistenten für die Dokumentationsgenerierung angepasst werden. Wenn Sie die Einstellungen für Layout und Stil ändern, werden sie für alle nachfolgenden Dokumentationsgenerierungen gespeichert, bis sie erneut geändert werden.
Die folgenden Layouteinstellungen können geändert werden:
Definiert das Papierformat der generierten Dokumentation.
Standardwert: Brief
Definiert die höchste Abschnittsebene, die im Inhaltsverzeichnis des Berichts aufgelistet werden soll.
Standardwert: 7
Klartext
Kapitelüberschrift
Quellcodetext
Beschriftungstext
Definitionstext
Headertext
Inhaltsverzeichnis
Bei einer Hauptdatei handelt es sich um ein Ressourcenprofil, das den Inhalt (nicht die Schriftstile) definiert, der in die generierte Dokumentation aufgenommen werden soll. Erstellen Sie bei Verwendung des Assistenten für die Dokumentationsgenerierung eine Hauptdatei, um die Ressourcenauswahl zu speichern. Wenn Sie den gleichen Bericht mit Hilfe des Assistenten erneut generieren möchten, können Sie einfach die Hauptdatei auswählen.
Der Dokumentationsgenerator stellt drei Standardschriftarten zur Verfügung, die für die Dokumentation verwendet werden können. Bei diesen Schriftarten handelt es sich um Helvetica, Courier und Times mit den folgenden Schriftstilen: normal, kursiv, fett und fett kursiv.
Sie können eine neue Schriftart hinzufügen, indem Sie sie registrieren. Dabei muss es sich entweder um eine True Type-Schriftartendatei (.ttf) oder eine True Type Collection-Datei (.ttc) handeln. Die Registrierung von Schriftarten erfolgt über den Assistenten für die Dokumentationsgenerierung. Nach dem Registrieren einer Schriftart kann diese für alle Berichte verwendet werden, bis sie gelöscht wird. Standardschriftarten können nicht gelöscht werden. Anweisungen zum Arbeiten mit dem Assistenten für die Dokumentationsgenerierung finden Sie bei den zugehörigen Tasks im Abschnitt "Dokumentation generieren".
Der Dokumentationsgenerator kann Tracenachrichten der Dokumentationsgenerierung in eine Tracedatei schreiben. Hinweis: Schalten Sie die Tracefunktion nur ein, wenn ein Problem mit dem Dokumentationsgenerator vorliegt, da die Traceverarbeitung die Systemleistung beeinträchtigt und viel Plattenspeicherplatz in Anspruch nehmen kann. Die Einstellungen für den Trace können im Fenster 'Benutzervorgaben' vorgenommen werden. Die Ausgabe wird in eine Textdatei im Metadatenverzeichnis geschrieben (arbeitsbereichsname\.metadata\.plugins\com.ibm.wbit.reporting.infrastructure\trace\). Protokolleinträge werden angehängt und niemals gelöscht.
Zugehörige Informationen