Generieren und Anpassen von Mapping-Dokumentation

www.altova.com Dieses Kapitel drucken Vorherige Seite Eine Ebene nach oben Nächste Seite

Startseite >  Anpassen von MapForce >

Generieren und Anpassen von Mapping-Dokumentation

Mit dem Befehl Dokumentation generieren wird detaillierte Dokumentation zu Ihrem Mapping in HTML, MS Word, RTF oder PDF generiert. Die mit diesem Befehl generierte Dokumentation kann jederzeit verändert und verwendet werden; eine eigene Genehmigung von Altova ist nicht erforderlich.

 

Die Dokumentation wird für die Komponenten generiert, die Sie im Dialogfeld "Dokumentation generieren" auswählen. Zur Auswahl stehen entweder das vordefinierte festgelegte Design oder die Verwendung eines StyleVision SPS. Bei Verwendung eines StyleVision SPS können Sie das Design der generierten Dokumentation nach Ihren Wünschen gestalten. Eine Anleitung dazu finden Sie im Abschnitt Benutzerdefiniertes Design.

 

 

Anmerkungen:
Um ein SPS für die Generierung der Mapping-Dokumentation verwenden zu können, müssen Sie StyleVision auf Ihrem Rechner installiert haben. Miteinander in Zusammenhang stehende Elemente werden normalerweise in der Bildschirmausgabe durch Hyperlinks miteinander verknüpft, so dass Sie von Komponente zu Komponente navigieren können.
Um Dokumentation im MS Word-Format zu generieren, muss MS Word (Version 2000 oder höher) installiert sein.

 

 

In der Abbildung unten sehen Sie einen Ausschnitt aus der Datei Lookup-standard.mfd aus dem Ordner ...\MapForceExamples.

document-mapping03

Nach Öffnen einer Mapping-Datei, z.B. Lookup-standard.mfd:

Wählen Sie die Menüoption Datei | Dokumentation generieren.

Daraufhin wird das Dialogfeld "Dokumentation generieren" geöffnet. In der Abbildung unten sehen Sie die Standardeinstellungen für das Dialogfeld.

 

document-mapping02

 

Dokumentationserstellung

Wählen Sie die Option "Festgelegtes Design für..", um die vordefinierte Dokumentationsvorlage zu verwenden.
Wählen Sie die Option "Für ein benutzerdefiniertes Design...", um ein mit StyleVision erstelltes StyleVision Power Stylesheet zu verwenden. Die SPS-Dateien stehen im Ordner ...\Dokumente\Altova\MapForce2019\Documentation\MapForce\ zur Verfügung.
Klicken Sie auf Durchsuchen, um zu einer vordefinierten SPS-Datei zu navigieren.
Klicken Sie auf Bearbeiten, um StyleVision zu starten und das ausgewählte SPS in einem StyleVision-Fenster zu öffnen.

Im Ordner ...MapForce2019\Documentation\MapForce stehen die folgenden vordefinierten SPS Stylesheets zur Verfügung:

FunctionCallGraph.sps - zeigt den Aufrufgraphen des Hauptmappings und aller benutzerdefinierten Funktionen.
FunctionsUsedBy.sps - zeigt, welche Funktionen direkt oder indirekt im Mapping verwendet werden.
ImpactAnalysis.sps - listet jeden einzelnen Quell- und Ziel-Node sowie die Route, die über die verschiedenen Funktionen zum Ziel-Node genommen wird, auf.
OverallDocumentation.sps - zeigt alle Nodes, Verbindungen, Funktionen und Ziel-Nodes. Diese Option bietet die größte Detailliertheit und ist mit der vordefinierten Ausgabe "Festgelegtes Design ..." identisch.

 

Ausgabeformat

Hier wird das Ausgabeformat definiert: entweder HTML, Microsoft Word, RTF oder PDF.

Bei Generierung der Dokumentation mit dem festgelegten Design werden Microsoft Word-Dokumente mit der Dateierweiterung .doc erzeugt. Bei Generierung unter Verwendung eines StyleVision SPS werden Dokumente mit der Dateierweiterung .docx erzeugt.

Das PDF-Ausgabeformat steht nur zur Verfügung, wenn Sie zum Generieren der Dokumentation ein StyleVision SPS verwenden.

Wählen Sie die Option Ausgabe auf mehrere Dateien aufteilen, wenn Sie die Input-, Output, Konstanten-Komponente und benutzerdefinierten Funktionen von der Dokumentation der Bibliothekskomponenten trennen möchten. In festgelegten Designs werden automatisch Links zwischen mehreren Dokumenten erstellt.
Die Option Ergebnisdatei nach Generierung anzeigen ist für alle Ausgabeoptionen aktiviert. Wenn sie aktiv ist, werden die Ergebnisdateien im Standard-Browser (HTML-Ausgabe), in MS Word (MS Word-Ausgabe) und der Standardapplikation für RTF-Dateien (RTF-Ausgabe) angezeigt.

 

Maximale Pfadlänge

Über diese Option können Sie die maximale Pfadlänge definieren, die für Datenelemente angezeigt werden soll.

Beispiel:. .../ShortPO/LineItems/LineItem. Dies wäre die maximale Länge bei der Standardeinstellung

 

Inkludieren

Hier können Sie definieren, welche Komponenten in der Dokumentation aufscheinen sollen.

 

Details

Dient zum Definieren der einzelnen Details, die in der Dokumentation aufscheinen sollen

Wenn Sie "Bibliotheksnamen" aktivieren, wird das Präfix "core" in die oben gezeigten Funktionen eingefügt.
Sie können nun sowohl verbundene als auch nicht verbundene Nodes dokumentieren

 

Anmerkung:
Mit den Schaltflächen Alle aktivieren/deaktivieren können Sie alle Kontrollkästchen dieser Gruppe aktivieren bzw. deaktivieren.

 

Wenn Sie die oben gezeigten Standardeinstellungen verwendet haben, werden Sie bei Klicken auf OK nach dem Namen für die Ausgabedatei und dem Speicherpfad gefragt. Unten sehen Sie einen Ausschnitt der mit dem festgelegten Design generierten Dokumentation. Beachten Sie, dass es sich hierbei um eine Datei mit einer einzigen Ausgabe handelt.

 

 

In dieser Tabelle sehen Sie die Verbindungen von der Quellkomponente zu der/den Zielkomponente(n).

 

document-mapping01

 

Die Reihenfolge, in der die Komponenten dokumentiert sind, ist die folgende: Input, Output, Konstante, benutzerdefinierte Funktionen und schließlich Bibliotheksfunktionen.

 

Beispiel: Input-Komponente ShortPO:

Die ersten beiden Datenelemente ShortPO und CustomerNr sind mit keinem Datenelement in der Zielkomponente verbunden, daher ist die Spalte "Connections" leer.
ShortPO/LineItems ist direkt mit  CompletePO/LineItems in der Zielkomponente verbunden.
/LineItems/LineItem/ArticleNr hat zwei Verbindungen:

 

direkt zu LineItem/Article/Number in der Zielkomponente
zur benutzerdefinierte Funktion LookupArticle mit ArticleNr als Input-Parameter und Name als dem Output-Parameter der benutzerdefinierten Funktion.

 

Unten sehen Sie den Inhalt der benutzerdefinierten Funktion.

document-userdef

Output-Komponente CompletePO: In dieser Tabelle sehen Sie die Verbindungen von der/den Quellkomponente(n) zur Zielkomponente.

 

document-outpcmp

 

Die ersten beiden Datenelemente CompletePO und CompletePO/Customer sind mit keinem Datenelement in der Quellkomponente verbunden, daher ist die Spalte "Connections" leer.
CompletePO/LineItems ist direkt mit ShortPO/LineItems in der Quellkomponente verbunden.

 

LineItem/Article/Name ist mit der benutzerdefinierten Funktion LookupArticle, verbunden, wobei LineItems/LineItem/ArticleNr das Quelldatenelement ist.

 

 

document-userfunc

 

 

 

 


© 2019 Altova GmbH