Prozesse dokumentieren

Prozesse können auf einfache Weise als Prozesshandbuch dokumentiert werden.

Voraussetzungen

Für den oder die zu dokumentierenden BPMN-Prozesse wird das Zugriffsrecht benötigt.

In der Modellkonfiguration ist ein geeignet konfiguriertes Dokumentationskommando hinterlegt und das Ausführungsrecht ist für die aktive Rolle des Benutzers vergeben.

Die Option MS-Word-Vorlagendatei des Dokumentationskommandos verweist auf eine geeignete Vorlagendatei.

Das Dokumentationskommando hat als Merkmal Ergebnisdatei öffnen nicht den Wert Immer.

Zweck

Für BPMN-Prozesse können Prozesshandbücher als Anhang erstellt und einfach aktualisiert werden. Diese Funktionalität ist auch erreichbar über Konzepte mit einer Konzeptrealisierung zu einem BPMN-Prozess.

Zur Dokumentation eines Prozesses als Prozesshandbuch können Dokumentationskommandos konfiguriert und mittels modellweiter Anwendungskonfiguration in der Menübandgruppe Extras>Prozesshandbuch aktualisieren für Rollen mit entsprechendem Ausführungsrecht zur Verfügung gestellt werden.

Durch den Aufruf eines Dokumentationskommandos mit Extras>Prozesshandbuch aktualisieren><Dokumentationskommando> wird eine Dokumentation für die Prozesse und Konzepte in der Selektion erzeugt. Das Prozesshandbuch wird am Prozess als Anhang gespeichert.

Wie Sie grundsätzlich vorgehen

Mit den Dokumentationskommandos in der Menübandgruppe Extras>Prozesshandbuch aktualisieren können Sie ein Prozesshandbuch als Anhang des Prozesses erstellen oder ein vorhandenes aktualisieren.

Selektieren Sie mindestens einen BPMN-Prozess oder ein Konzept, das eine Konzeptrealisierung zu einem BPMN-Prozess hat.

Wenn eine konfigurierte Prüfung fehlschlägt, können Sie die Erzeugung des Prozesshandbuchs abbrechen. Das erstellte Prozesshandbuch hat als Dateinamen den Namen des Dokumentationskommandos und wird als Anhang an den Prozess gehängt und ersetzt dabei das eventuell vorhandene Prozesshandbuch.

Konfiguration

Anwendungskonfiguration verwenden

Mit dem Verfahrensrecht Modellweite Konfigurationen bearbeiten kann die stets modellweite Anwendungskonfiguration mit dem Befehl Extras>Prozesshandbuch aktualisieren>Anwendungskonfiguration laden aus der Datei $INOHOME\ProcessCharacteristics.json geladen und dadurch bereitgestellt werden.

Hinweis

Die Änderungen wirken erst nach einem Neustart des Modelleditors.

In der Anwendungskonfiguration sind explizit Rollen und Dokumentationskommandos festzulegen, andernfalls können alle Rollen mit entsprechendem Ausführungsrecht alle für sie in der Modellkonfiguration konfigurierten Dokumentationskommandos ausführen.

Bearbeiten der Anwendungskonfiguration

Voraussetzungen

Sie verfügen durch Ihre aktuell verwendete Rolle über das Verfahrensrecht Modellweite Konfigurationen bearbeiten.

Zusammenhang

Die aktuelle Anwendungskonfiguration kann lokal in einem Texteditor bearbeitet werden.

Wenn in der Anwendungskonfiguration Rollen konfiguriert sind, dann können nur diese konfigurierten Rollen die Dokumentationskommandos ausführen, andernfalls können alle Rollen mit entsprechendem Ausführungsrecht die Dokumentationskommandos ausführen.

In der Anwendungskonfiguration sind Dokumentationskommandos zu konfigurieren, um geeignete Dokumentationskommandos zur Auswahl anzubieten, andernfalls werden alle in der Modellkonfiguration konfigurierten Dokumentationskommandos mit Ausführungsrecht für die aktive Rolle angeboten.

So gehen Sie vor

  1. Um festzulegen, welche Rollen ein Prozesshandbuch erstellen können und welche Dokumentationskommandos angeboten werden, speichern Sie die aktuelle Anwendungskonfiguration mit Extras>Prozesshandbuch aktualisieren>Anwendungskonfiguration speichern als Datei $INOHOME\ProcessCharacteristics.json in $INOHOME (Standardverzeichnis: %APPDATA%\Innovator\16.1).

  2. Öffnen Sie die Datei $INOHOME\ProcessCharacteristics.json in einem Texteditor.

  3. Um das Erstellen eines Prozesshandbuchs mit einem oder mehreren bestimmten Dokumentationskommandos zu ermöglichen, fügen Sie den lokalisierten Namen des Dokumentationskommandos im JSON-Element DocuCommands als Wert hinzu. Mehrere Dokumentationskommandos trennen Sie mit Komma.

  4. Um das Erstellen eines Prozesshandbuchs für eine oder mehrere Rollen zu ermöglichen, fügen Sie den Namen der Rolle im JSON-Element Roles als Wert hinzu. Mehrere Rollen trennen Sie mit Komma.

  5. Speichern Sie die Datei im selben Verzeichnis $INOHOME.

  6. Laden Sie die Datei mit Extras>Prozesshandbuch aktualisieren>Anwendungskonfiguration laden.

    Hinweis

    Die Änderungen wirken erst nach einem Neustart des Modelleditors.

Beispiel für die Anwendungskonfiguration

{
  "DocuCommands": [
    "DiagramOriented",
    "HierarchyOriented"
  ],
  "Roles": [
    "Business Analyst"
  ]
}

Konfiguration von Dokumentationskommandos, Ausführungsrechten und Menübefehlen

Jedes durch die Anwendungskonfiguration angebotene Dokumentationskommando muss in der Modellkonfiguration für die ausführenden Rollen und im Menü als Befehl konfiguriert sein.