Deutsch
Englisch
JapanischDokument-Muster
Dieses Kapitel beschreibt, wie man eine Prozess-Dokumentation mit Dokument-Muster erstellt. Jedes dieser Muster legt fest, wie die BPMN-Elemente durchlaufen und in der Prozess-Dokumentation entsprechend dargestellt werden. Um ein Muster innerhalb einer Word-Dokumentvorlage (*.dot, *.dotx) zu verwenden, wird eine vordefinierte Variable verwendet, die immer mit doppelten Prozentzeichen (%%) beginnt und endet.
Syntax: %%PATTERN;type=<type>[;<parameter>]*%%
<parameter> := <name>=<value>
Zum Beispiel: %%PATTERN;type=generic;recursive=true;elementfilter=4,5,6,7%%
Kommt diese Variable in einer Word Dokument-Vorlage vor, ersetzt die Prozess-Dokumentations-Engine dieses Muster mit den Attribut-Werten der einzelnen Elemente. Im oben angeführten Beispiel entsteht dadurch eine Word-Tabelle mit allen Aktivitäten:
| 12 | An Activity 1 | Task |
| 13 | An Activity 2 | Task |
| 14 | A Gateway | Gateway |
Jedes Dokument-Muster hat vordefinierte Parameter. Diese Parameter sind mit einem Semikolon (;) voneinander getrennt. Die folgende Tabelle zeigt alle allgemeinen
| Parameter-Name | Beschreibung, Parameter-Werte und Beispiele |
| type | Dieser zwingend erforderlicheParameter legt den Muster-Typ fest:
generic (Parametrisierbares Muster) Beispiel: type=graphics |
| description | Dieser optionale Parameter wird verwendet, um das Muster näher zu beschreiben.Beispiel: description=”Liste von allen Daten-Objekten” |
| sort | Dieser optionale Parameter wird verwendet, um BPMN-Elemente nach Attribut-Werten zu sortieren. Mehrere Attribute werden mit einem Komma (,) voneinander getrennt. Wie einzelne Attribute verwendet werden, wird hier beschrieben. Das angehängte[asc] (aufsteigend) oder[desc] (absteigend) definiert die Sortierreihenfolge.
Beispiele:sort=System.*.number |
| outlinelevel | Dieser optionale Parameter wird verwendet, um die höchste Kapitelüberschrift des generierten Word-Inhalts zu definieren.Ist outlinelevel zum Beispiel auf 3 gesetzt, dann ist Überschrift 3die höchste Überschrift, die im Word-Dokument für dieses Muster verwendet wird.Syntax: outlinelevel=n wobei n=1,2,3,4,5, … |
| elementfilter | Dieser optionale Parameter wird verwendet, um BPMN-Element-Typen zu filtern. Mehrere Typen werden durch ein Komma (,) voneinander getrennt.Die folgende Liste zeigt, welcher Element-Type welche Nummer hat. Anstelle der Nummer kann auch der Name des Element-Typs verwendet werden. StartEvent = 1 (Start) IntermediateEvent = 2 (zwischen) EndEvent = 3 (Ende) Task = 4 (Task) SubProcessCollapsed = 5 (Unterprozess (zugeklappt)) SubProcessExpanded = 6 (Unterprozess (aufgeklappt)) Gateway = 7 (Gateway) SequenceFlow = 8 (Sequenz-Fluss) MessageFlow = 9 (Nachrichten-Fluss) TextAnnotation = 10 (Kommentar) Association = 11 (Assoziation) DataObject = 12 (Daten-Objekt) Group = 13 (Gruppierung) Pool = 14 (Pool) Lane = 15 (Lane) DataObjectReference = 16 (Daten-Objekt-Referenz) DataStore = 17 (Datenspeicher) CallActivity = 18 (Aufrufaktivität) DataAssociation = 19 (Daten-Assoziation) DataInputAssociation = 20 (Dateninput-Assoziation) DataOutputAssociation = 21 (Datenoutput-Assoziation) DataInput = 22 (Dateninput) DataOutput = 23 (Datenoutput) Message = 24 (Nachricht) BoundaryEvent = 25 (Angeheftetes Zwischenereignis) Beispiele:elementfilter=4,5,6 |
| onlynumbered (Voreinstellung: false) | Dieser optionale Parameter kann entweder true oder false sein. Bei true werden alle BPMN-Elemente ignoriert, die keine Elementnummer (System.number) aufweisen.
Beispiel: onlynumbered=true |
| onylvisible (Voreinstellung: false) | Dieser optionale Parameter kann entweder true oder false sein. Bei true werden alle nicht sichtbaren BPMN-Elemente (Visio-Shape unsichtbar) ignoriert.
Beispiel: onlyvisible=true |
| recursive (Voreinstellung: false) | Dieser optionale Parameter kann entweder true oder false sein. Bei true werden alle BPMN-Elemente rekursiv durchlaufen. Das heißt, wenn ein Unterprozess dokumentiert wird, wird auch sein Inhalt verarbeitet.
Beispiel: recursive=true |
| tableautofit (Voreinstellung: false) | Dieser optionale Parameter kann entweder true oder false sein. Bei true werden alle Tabellen automatisch an das Fenster angepasst.
Beispiel: tableautofit=true |
| tableautofitcontent (Voreinstellung: false) | Dieser optionale Parameter kann entweder true oder false sein. Bei true werden alle Tabellen automatisch an den Inhalt angepasst.
Beispiel: tableautofitcontent=true |
Die folgenden Unterkapitel beschreiben jedes Dokument-Muster einzeln und wie diese konfiguriert wird:
Parametrisierbares Muster
Dieses Muster wird verwendet, um eine einfach (nicht hierarchische) Liste von BPMN-Elementen zu erzeugen. Jedes BPMN-Element wird als einzelne Reihe in eine Tabelle eingefügt.
Syntax: %%PATTERN;type=generic[;parameter]*%%
Parameter: Dieses Dokument-Muster hat keine zusätzlichen Parameter zu den allgemeinen Parametern.
Um beispielsweise eine generische Liste mit allen BPMN-Daten-Objekte sortiert nach dem Wert des Name-Attributs in aufsteigender Reihenfolge zu erstellen, wird folgendes Muster verwendet:
%%PATTERN;type=generic;sort=Bpmn.DataObject.Name[asc];elementfilter=12%%
Aktivitäten-Muster
Dieses Muster wird dazu verwendet, um eine Prozess-Dokumentation zu erstellen, die ausschließlich Aktivitäten beinhaltet. Der optionale Parameter hierarchical bewirkt, dass jede Aktivität innerhalb eines Unterprozesses eine neue Hierarchiestufe (d.h. ein neues Unterkapitel) im erstellten Word-Dokument erhält.
Syntax: %%PATTERN;type=activity[;parameter]*%%
Zusätzliche Parameter:
| Parameter-Name | Beschreibung, Parameter-Werte und Beispiele |
| hierarchical | Dieser optionale Parameter kann entweder true oder false sein. Bei true erhalten BPMN-Elemente innerhalb eines Unterprozesses eine neue Hierarchiestufe im erstellten Word-Dokument, das heißt, sie werden in neue Unterkapitel unterteilt. (Voreinstellung: false)
Anmerkung: Dieser Parameter macht nur dann Sinn, wenn recursive auf true gesetzt ist. |
Pool-Muster
Dieses Muster wird verwendet, um die Beziehungen zwischen den Pools und ihrem Inhalt zu zeigen. Der zusätzliche Parameter messages legt fest, ob der ein- und ausgehende Meldungsaustausch auch dokumentiert wird.
Syntax: %%PATTERN;type=pool[;parameter]*%%
Zusätzliche Parameter:
| Parameter-Name | Beschreibung, Parameter-Werte und Beispiele |
| hierarchical | Dieser optionale Parameter kann entweder true oder false sein. Bei true erhalten BPMN-Elemente innerhalb eines Unterprozesses eine neue Hierarchiestufe im erstellten Word-Dokument, das heißt, sie werden in neue Unterkapitel unterteilt. (Voreinstellung: false) Anmerkung: Dieser Parameter macht nur dann Sinn, wenn recursive auf true gesetzt ist. |
| messages | (Voreinstellung: false) Dieser optionale Parameter kann entweder true oder false sein. Bei true wird der eingehende und ausgehende Meldungsfluss in zwei separaten Unterkapiteln mitdokumentiert.Um die Ausgabe der Meldungen individuell anzupassen, wird das Doclet verwendet, das dem Austausch von Meldungen innerhalb der Pool-Musterzugewiesen ist. |
Lane-Muster
Dieses Muster wird verwendet, um die Beziehungen zwischen Lanes und ihrem Inhalt zu anzuzeigen. Der zusätzliche Parameter hierarchical dokumentiert die komplette Lane-Struktur in hierarchischer Reihenfolge.
Syntax: %%PATTERN;type=lane[;parameter]*%%
Zusätzliche Parameter :
| Parameter-Name | Beschreibung, Parameter-Werte und Beispiele |
| hierarchical | Dieser optionale Parameter kann entweder true oder false sein. Bei true erhalten BPMN-Elemente innerhalb eines Unterprozesses eine neue Hierarchiestufe im erstellten Word-Dokument, das heißt, sie werden in neue Unterkapitel unterteilt.
Anmerkung: Dieser Parameter macht nur dann Sinn, wenn recursive auf true gesetzt ist. |
Grafik-Muster
Dieses Muster wird verwendet, um Visio Diagramme als Bild (Bitmap) in die Prozess-Dokumentation einzufügen. Ohne Parameter angegeben, werden alle Visio Diagramme unabhängig von der aktuellen Auswahl eingefügt.
Syntax: %%PATTERN;type=graphics[;parameter]*%%
Zusätzliche Parameter :
| Parameter-Name | Beschreibung, Parameter-Werte und Beispiele |
| ignoretitleblock | (Voreinstellung: false)Dieser optionale Parameter kann entweder true oder false sein. Bei true wird der Titelblock ignoriert. |
| sheets | Dieser optionale Parameter definiert, welche Visio Diagramme in die Dokumentation aufgenommen werden. Mehrere Visio Diagramme werden durch Komma (,) voneinander getrennt.
Beispiel: sheets=2,3 Das zweite und dritte Diagramm werden eingefügt. Wenn dieser Parameter fehlt, werden immer alle Visio Diagramme eingefügt. Außer description haben im Grafik-Muster alle anderen Parameter alle keinen Einfluss auf die Ausgabe. |