Dynamische Erstellung einer Prozess-Dokumentation

Dynamische Erstellung einer Prozess-Dokumentation

Als IT- und Prozess-Verantwortlicher müssen Sie sicherstellen, dass die Schnittstellen zwischen den Applikationen stets ausführlich dokumentiert sind. Diese Dokumentation zu jeder Zeit aktuell zu hlaten stellt erfahrungsgemäß dies eine besondere Herausforderung dar, weil die Applikationen und damit die Schnittstellen häufig erweitert oder angepasst werden.

Ziele und Nutzen

Mit Hilfe des ADIB gelingt es Ihnen, diese Herausforderung mit überschaubarem Aufwand zu meistern. Dazu tragen Sie in der CentralStation einige Informationen zu Applikationen und Schnittstellen ein. Dies ist dank eines integrierten Texteditor recht einfach möglich.

Dank ADIB sparen Sie sich aber im Anschluss die Erstellung einer detaillierten Prozess-Dokumentation – dies erledigt der ADIB per Knopfdruck für Sie. Somit sparen Sie sich viel Zeit und Mühe, diese Daten in einem weiteren Tool nochmal einzugeben – welches erfahrungsgemäß auch selten auf dem aktuellen Stand ist. Dies wird Ihnen mit dem ADIB nicht passieren!

Somit etablieren Sie den ADIB als zentrale Lösung für Prozess-Konfiguration und Dokumentation

• Erstellung der aktuellen Prozess-Dokumentation auf Knopfdruck
• Export der Dokumentation als PDF oder Word-Datei
• Prozess-Dokumentation entspricht immer exakt dem aktuellen Stand

Erstellen und Generien der Dokumentation

Über den integrierten Texteditor können Sie einige grundlegende Informationen und Schaubildern direkt während der Erstellung der Schnittstelle hinterlegen

• Auf Job-Ebene - also für die gesamte Integrations-Aufgabe
• Auf Step-Ebene - und somit für den einzelnen Datentransfer zwischen einer Quelle und einem Ziel.

In dem Beispiel wurde auch Job-Ebene eine Erläuterung inkl. Schaubild hinterlegt. Zum Starten des Editors klicken Sie doppelt auf das Feld "Description" in dem entsprechenden Job.

\Image 74: Doppelklick auf das Feld "Description" zum Starten des Editors

\Image 75: Integrierter Editor zur Pflege von grundsätzlichen Informationen

Auf der Ebene der Steps gehen Sie analog vor. Hierbei ist jedoch ausreichend, nur grundsätzliche Informationen zu hinterlegen. Detailinformationen wie zB. die übertragenen Felder, die hinterlegten Parameter, Uhrzeit und Tag, an dem der Job durchläuft, .. werden durch den ADIB auf Basis der gemachten Konfiguration automatisch hinzugefügt.

• Zur Erstellung des Prozess-Dokuments klicken Sie auf der Job-Maske auf den Button "Prozess Documentation" im oberen Bereich.
• Daraufhin öffnet sich die folgende Maske, in der Sie diverse Einstellungen vornehmen können.
  • (1) : Auswahl der Instanz für die die Dokumentation erstellt werden soll
  • (2) : Detaillierungsgrad der Dokumentation
    • Hier definieren Sie, ob die Step-Parameter und Step-Positions (alle oder nur die aktiven) ausgegeben werden sollen
  • (3) : Ausgabe der weiteren Elemente der Konfiguration
    • Mapping-Listen
    • Flexmapping-Listen
    • Weitere Einstellungen
  • Sie sollten die Prozess-Dokumentation sinnvollerweise für jede Instanz getrennt ausgeben. Wenn Sie sehr umfangreiche Mapping-Listen geführt haben, könnte es Sinn machen, diese nicht auszugeben.

\Image 76: Einstellmöglichkeiten für die Generierung der Prozess-Dokumentation

• Nach Klick auf OK im rechten unteren Bereich wird ein Voransicht erstellt.

\Image 77: Voransicht der Prozess-Dokumentation auf Basis der gemachten Einstellungen

• Im Anschluss können Sie das Dokument als PDF (oder im docx-Format zur weiteren Bearbeitung) exportieren.
  • Das erstellte PDF verfügt über ein automatisches generiertes Inhaltsverzeichnis - womit die Navigation innerhalb des Dokuments sehr einfach ist

\Image 78: Prozess-Startseite und automatisch generierter Navigationsbereich

• Gemäß der Einstellungen werden die Step-Parameter, Step-Positions etc. mit der aktuellen Konfiguration zu jedem Step hinzugefügt, so dass die erstellte Prozess-Dokumentation immer auf dem neusten Stand ist!

\Image 79: Aktuelle Parameter / Positions werden automatisch in die Dokumentation aufgenommen