Automic_Community_5543

Documentation Generator for Automic ONE Automation Platform

Discussion created by Automic_Community_5543 on Jan 12, 2018

Dokumentationen von Systemen werden benötigt, um Informationen gezielt für verschiedene Zielgruppen auffindbar zu machen und kann gerade in Automic Umgebungen zusätzliche Arbeitsanweisungen erhalten. So bspw. Workarounds, oder spezielle Anweisungen im Falle von Jobabbrüchen etc. Dokumentationen schaffen somit Transparenz und können ein wichtiges Werkzeug im Rahmen von Audits sein.

Die Erstellung von Dokumentation ist jedoch zeitaufwändig und bedarf der täglichen Pflege, um eine stets aktuelle Dokumentation aufweisen zu können. Damit die Informationen aus der Dokumentation auch für verschiedene Zielgruppen zur Verfügung gestellt werden können, erfolgt die Dokumentation häufig in externen Werkzeugen. Aufgrund des hohen manuellen Anteils, sind standardisierte und stets aktuelle Dokumentationen von Umgebungen selten anzutreffen.

Um die Dokumentation zu optimieren, setzt diese Solution darauf, eine automatisierte Dokumentation zu erzeugen. Es wird mit dieser Solution ein Standard zur Verfügung gestellt, um Dokumentationen zu vereinheitlichen und den manuellen Aufwand zu reduzieren.

Die Solution kann auf Basis von Packages Dokumentationen erzeugen. Dabei werden auch Abhängigkeiten von Packages dokumentiert. Objekte und Tasks können verlinkt werden und bieten auch die übergreifende Sicht über die Packages.

Die best4Automic Solution liest dabei automatisiert die Eigenschaften von Objekten in einem Package aus. Dies können Informationen, wie Einstellungen/Attribute wie „Zur Laufzeit generieren“, Inhalte von Scripten (inkl. Pre- und Postscript/Conditions), Packagekonfigurationen, Abhängigkeiten, Versionen, etc. sein. Diese Informationen werden dann auf Basis von Templates aufbereitet. Die aus diesen Templates generierten Dateien können dann in beliebige Zielsysteme, wie Confluence, MediaWIki oder beliebigen anderen auf Textdateien basierenden Systemen importiert werden. Beispielsweise ist auch genauso gut möglich SVG-Grafiken von Workflows zu erzeugen.


See Plugin

Outcomes