BiPRO Datenmodell Index

Dokumentation des Datenmodells...

Der BiPRO Datenmodell Index listet alle Elemente des Daten­modells von BiPRO Release 2 auf (hier in der Version 2.10), gegliedert nach Namensräumen und Typdefinitionen (Klassen und ihre Glieder). Die alphabetischen Register bilden zu­sammen einen systematischen Index, der einen vielfältigen Ein­stieg in das Datenmodell ermöglicht (über Auflistungen der Namens­räume, Typen, Attribute oder über Diagramme). DieDoku­men­ta­tion der Elemente beschreibt die Struktur und führt die einzelnen Eigen­schaften und die Verknüpfung der Elemente untereinander auf. Die Dia­gramme aus dem Sparx-Enterprise-Architect-Projekt ver­an­schau­lichen das Datenmodell grafisch. Hyperlinks unter den grafi­schen Elementen ermöglichen den Sprung zur ent­spre­chen­den Typ­definition in der Dokumentation.

...sowie Viewer für das Release-Paket

Die Darstellung des Datenmodells wird durch weitere Seiten des DMIx ergänzt, welche andere wesentliche Bestandteile des Release-Paketes indizieren. Das Release-Paket umfasst alle zu den BiPRO-Normen im Release 2.10 gehörenden Dateien. Neben den XML-Schemadateien des Daten­modells sind dies ins­besondere die Normdokumente (einschließlich der Liste der Ge­schäfts­vorfälle als allgemeiner Anhang) und die Service-De­fi­ni­tio­nen (mit der WSDL als Hauptdokument). Die Services ver­wenden bestimmte Teile des Daten­modells und sind im DMIx ent­spre­chend mit diesem verknüpft. Somit kann der DMIx als Übersicht des Release-Paketes benutzt werden, wobei alle Artefakte über den bevorzugten HTML-Browser gefunden und größtenteils auch unmit­tel­bar geöffnet und betrachtet werden können.

Die Register und Listen des DMIx können verwendet werden, um an einer bestimmten Stelle (Namensraum, Klasse, Attribut...) in das Daten­modell einzusteigen bzw. zu einer anderen Stelle zu wechseln. Die einzelnen Elemente des Daten­modells sind in der Doku­mentation außerdem entsprechend ihrer Beziehungen unter­einander in beiden Richtungen der Referenzierung verknüpft.

Die Einstiegspunkte können über das DMIx-Menü aufgerufen werden, das als rotes Band ganz oben auf jeder Seite steht.

• Namensräume
  Eine alphabetische Liste aller Namensräume.
• Typen
  Eine alpha­betische Liste aller Datentypen, Klassen und Top-Level-Elemente. Die technischen Präfixe CT_, ST_, STE_ wer­den für die alphabetische Anordnung ignoriert und des­halb etwas heller dargestellt. Die verschiedenen Kategorien von ein­fachen und kom­plexen Typen können über die Ankreuz­felder in der Zeichenlegende am Anfang der Seite ein- ☑ und ☐ aus­ge­blendet werden.
• Attribute
  Eine alphabetische Liste aller Attribute und Assoziationen mit Angabe der enthaltenden Klasse. Die beiden Arten von Attributen können über die Ankreuzfelder in der Zeichenlegende am Anfang der Seite ein- ☑ und ☐ ausgeblendet werden.
• Diagramme
  Eine Aufstellung aller UML- und BPMN-Diagramme (Daten­modell­diagramme, Objektbeispiele, Prozessmodelle). Hyper­links verbinden die verweis-sensitiven Daten­modell­diagramme mit der Dokumentation der Namensräume und ihrer Elemente.

Weitere Bestandteile des DMIx sind eine Aufstellung der BiPRO-Normen (alphabetisch und systematisch) ‒ die hier verlinkten PDF-Dateien können unmittelbar im Browser geöffnet werden ‒ sowie eine Aufstellung der Web-Services mit den Namensräumen, die im jeweiligen Kontext relevant sind.

• Normen
  Eine Auflistung der BiPRO-Normen und Anhänge, einschließlich der Gesamtliste der Geschäftsvorfallarten.
• Services
  Eine Auflistung der Web-Services mit den einzelnen Operationen und den referenzierten Namensräumen.

Neu im DMIx 1.5: Der Service-Index listet jetzt auch die Service-Operationen auf, wie sie in der WSDL definiert werden, wobei jeweils das Element, welches die Nachrichtenparameter aufnimmt, mit dem entsprechenden Top-Level-Element im BiPRO-Datenmodell verlinkt ist.

Die Auflistung der Namensräume, die von einem Web-Service referenziert werden, basiert (seit DMIx 1.4) auf den Schema-Im­porten der WSDL. Um die Auf­stellungen übersichtlicher zu halten, werden die referenzierten Namens­räume nach direkten Importen und indirekten (tran­si­tiven) Referenzen unterschieden.

Die Detailinformationen zu den Elementen eines Namensraums gliedern sich (auf der ersten Ebene einer Typdefinition, also einer Klasse oder eines Datentyps) in folgende Kategorien:

• Dokumentation
  Der Dokumentationstext, der die Semantik, Regeln zur Ver­wen­dung des Elementes und Hinweise enthält und somit Bestandteil des Schnittstellenkontraktes ist.
• Attribute und Assoziationen
  Die Glieder (mit einfachem oder komplexem Typ), aus denen eine Klasse besteht, mit den jeweiligen Dokumentationen.
  Neu im DMIx 1.5: Wenn der Typ abstrakt ist oder es Ableitungen gibt, durch die er ersetzt werden kann, ist dies durch ein hoch­ge­stell­tes Mul­ti­pli­ka­tions­zeichen^× ge­kenn­zeichnet.
  Neu im DMIx 1.6: Die Auflistung umfasst nunmehr das effektive Datenmodell einer Klasse. Die Doku­men­ta­tionen werden nur bei den deklarierten Klassengliedern aufgeführt. Um die Doku­men­ta­tionen der geerbten Klassenglieder zu lesen, folgen Sie dem Link zur jeweiligen deklarierenden Klasse (auf dem Etikett des entsprechenden Klappfeldes nach der Präposition „aus“). Die geerbten und die deklarierten Klassenglieder können einzeln und als Gruppe ein- bzw. ausgeklappt werden, je nachdem, wel­ches Feld angeklickt wird, und ob der Klick auf das Dreieck ein­fach oder mit gleich­zeitig nieder­gedrückter Alt-Taste aus­ge­führt wird. Es wäre zuviel, alle sich hieraus ergebenden Mög­lichkeiten aufzuführen, da es viel einfacher ist, den indivi­duellen Umgang mit diesen durch Aus­probieren zu finden.
• Referenzierung
  Ein- und ausgehende Referenzen eines Datentypen oder einer Klasse. Im oberen Bereich der Namens­raum­seiten werden die importierten und importierende Namens­räume bzw. bei­gefügte Aus­prägungs­kataloge und bei­fügende Namens­räume aufgeführt.
• Zusätzliche Dokumentation
  Alle Diagramme, in denen das jeweilige Element vorkommt.

Die Seiten, auf denen die Details zu den Elementen eines Namens­raums aufgeführt werden, sind so aufgebaut, dass alle Infor­ma­tionen auf einer Seite vorhanden sind. Die Details sind in so­ge­nann­ten Klapp­feldern (toggle boxes) unter­gebracht, die zunächst aus­ge­blendet sind.

Ein Klappfeld wird durch Anklicken des Dreiecks ▶ links neben der Überschrift aus- bzw. ein­geklappt. Der Inhalt eines Klappfeldes ist ausgeblendet, wenn das Dreieck auf die Überschrift zeigt. Wenn der Inhalt angezeigt wird, zeigt das Dreieck ▼ nach unten auf den Rahmen, der das Klappfeld begrenzt.

Durch Klicken auf das Dreieck bei gleichzeitigem Drücken einer Zu­satz­taste werden mehrere Klappfelder zugleich aus- bzw. eingeklappt.

Klick mit Alt-Taste (auch Optionstaste genannt): Alle Felder zu einer Klasse werden auf einmal aus- bzw. eingeklappt.

Klick mit Umschalttaste: Alle Felder der gleichen Kategorie (z. B. Dokumentation) werden auf der jeweiligen Seite insgesamt aus- bzw. ein­geklappt.

Auf der Seite des Namensraums bipro-datentypen ermöglichen zwei Links bei „Einblenden“ (im Kopfteil der Seite) als Shortcut entweder alle Aus­prä­gungen von Auf­zählungs­typen oder alle Angaben zu anderen Ein­schrän­kungen (wie z. B. reguläre Aus­drücke, Werte­bereiche usw.) ein­zu­blenden. Dadurch wird es ver­einfacht die Seite bspw. als Register der Aus­prägungen zu verwenden und nach bestimmten Werten über alle Auf­zählungs­typen hinweg zu suchen (s. a. Suche innerhalb einer Seite). Diese letztere Variante kann auch über das Register aller Typen angesteuert werden.

Die Browser-Funktionalität zur Suche innerhalb einer Seite kann verwendet werden, um Register und Detailseiten nach Element­namen oder Begriffen zu durchsuchen. Die Suche nach einem charakteristischen Wortteil resultiert i. A. in einer größeren Anzahl von Treffern als die nach ganzen Wörtern oder Wortgruppen, ins­besondere wenn ein Wort grammatisch unterschiedliche Formen annehmen kann (Singular, Plural, Beugung...). Ausblendbare Felder müssen eingeblendet sein, damit diese in die Suche einbezogen werden (s. o. Ein- und Ausblenden von Informationen).

Die Seiten des DMIx sind so aufgebaut, dass möglichst viel Information auf einer Seite vorhanden ist. Navigationselemente wie das Hauptmenü für den Wechsel zwischen den einzelnen Seiten, sowie Menüs für den Sprung zu bestimmten Abschnitten auf der gleichen Seite (z. B. nach Anfangsbuchstaben auf Register-Seiten zu Typen bzw. Attributen) befinden sich am Anfang der Seite.

Auf den Seiten des DMIx gibt es an verschiedenen Stellen Links für den Rücksprung zum Seitenanfang. In den rechten unteren Ecken der Umrahmung von Einzel­einträgen zu Normen oder zu Services befinden sich nach links oben zeigende Pfeile ⇱, die angeklickt werden können. Auf den alpha­betisch sortierten Register­seiten der Typen und der Attribute sind die grau unterlegten Überschriften mit dem jeweiligen Anfangs­buch­staben A Z mit einem Link für den Rück­sprung zum Seiten­anfang versehen.

Abgesehen davon können allgemeine Tastaturbefehle oder Maus­klicks bzw. Tippgesten verwendet werden, um schnell zum Seiten­anfang zurückzukehren, soweit sie vom Browser auf dem jeweiligen Endgerät unterstützt werden, z. B.

• die Taste „Home“ (auch „Anfang“ oder „Pos 1“) oder eine al­ter­na­ti­ve Tastatur­kombi­nation;
• Klick überhalb des Schiebereglers („Daumen“) auf die Bild­lauf­leiste („Roll­balken“) (auf manchen Systemen ist es für einen Maximal­sprung notwendig, gleichzeitig die Umschalttaste nieder­zu­drücken);
• Tippen nahe dem Bildschirmrand auf einem Touchscreen.