SIP-Modellberichte

Sie können ein SIP-Modell (Session Initiation Protocol) dokumentieren, um einen Designbericht für Aufrufabläufe zu erstellen.

Modellstruktur

Zum Generieren eines Berichts muss das SIP-Modell eine bestimmte Struktur und ein bestimmtes Format für BIRT (Business Intelligence and Reporting Tool) haben. Die Struktur wird in der Sicht 'Projektexplorer' der Perspektive 'Modellierung' definiert. Die Modellelemente werden mithilfe der Sicht 'Eigenschaften' dokumentiert.
Anmerkung: Sie können nur das Modell der höchsten Ebene als Quelle zum Generieren von BIRT-Berichten verwenden.

Der Ordner 'Modelle' befindet sich am Anfang der Modellstruktur. Der Name des Modells wird nicht verwendet.

Die Modellstruktur

Die Modellpakete der höchsten Ebene werden als Hauptabschnitte des Berichts verwendet. Der Name eines Pakets ist auch der Name, der im Bericht verwendet wird. Die Reihenfolge, in der die Abschnitte im Bericht angezeigt werden, richtet sich nach der Reihenfolge, in der die Abschnitte im Feld 'PackagedElement' der UML-Eigenschaften angegeben sind.

Abschnittsdokumentation

Um auf die UML-Eigenschaften zuzugreifen, klicken Sie mit der rechten Maustaste auf das Modell und anschließend auf UML-Eigenschaften. Verwenden Sie die Symbole auf der rechten Seite des Fensters 'Eigenschaften', um die Pakete nach oben bzw. nach unten zu verschieben.

Die Unterabschnitte des Berichts werden durch die Pakete der zweiten Ebene definiert. Der Name eines Pakets wird als Titel des Unterabschnitts verwendet, und die Reihenfolge wird durch das gepackte Element (PackagedElement) des Hauptordners definiert.

Wenn ein Unterabschnittspaket ein Übersichtspaket enthält, dann enthält das Übersichtspaket ein Diagramm, das im Bericht angezeigt wird. Der Titel des Diagramms im Bericht ist der Name des Diagramms.

Die Unterabschnittspakete enthalten die SIP-Aufrufabläufe, bei denen es sich um spezielle Sequenzdiagramme handelt, die das Stereotyp <<CallFlow>> (Aufrufablauf) aufweisen. Der Name des Aufrufablaufdiagramms (nicht des Aufrufablaufs) ist der Titel des Diagramms im Bericht.

Flussdokumentation

Die Aufrufablaufnachrichten befinden sich unter der Aufrufablaufinteraktion, die das Aufrufablaufdiagramm enthält.

Dokumentation

Um dem Bericht einen Text hinzuzufügen, verwenden Sie die Seite 'Dokumentation' der Sicht 'Eigenschaften'. Auf der Seite 'Dokumentation' wird die Versionszeichenfolge in der Fußzeile des Berichts angezeigt. Sie können eine Beschreibung der Abschnitte und Unterabschnitte auf der Seite 'Dokumentation' der Pakete der ersten und der zweiten Ebene einstellen.

Aufrufablaufdokumentation

Die Beschreibung des Aufrufablaufs wird in der Dokumentationseigenschaft der Sequenzdiagrammspezifikation mit dem Stereotyp <<Call Flow>> definiert.

Eigenschaft für Dokumentation

Sie können eine Beschreibung der Nachricht in der Dokumenteigenschaft der Nachricht hinzufügen. Der Inhalt der SIP-Eigenschaft wird der Beschreibung der Nachricht hinzugefügt.

Die SIP-Seite der Sicht 'Eigenschaften' für den Designbericht enthält die Abschnitte für den Anforderungs-URI, den Nachrichtenhauptteil und die SIP-Version. Der Abschnitt 'Header' enthält den Inhalt für den Ausgangsheader (From) und den Zielheader (To).

Dokumentation für SIP-Designbericht


Feedback