Auch zur Entwicklung von SSIS Paketen gehört das Erstellen von Dokumentationen. Wie aber auch in anderen Projekten, ist hierfür meistens viel zu wenig Zeit vorhanden.
Um diesen Problem entgegen zu wirken, werden in Software- oder Datenbankprojekten im nachhinein häufig Tools eingesetzt, die grundlegende Dokumentationen automatisiert aus den Sourcen heraus erstellen können.
Für die Integration-Services sieht dieser Bereich derzeit zwar noch ein bisschen Mager aus, doch auch hier existieren mit dem BI Documenter und dem SSIS Documenter bereits 2 gute Programme.
Der BI Documenter ist ein wahres Allround-Tool was die Dokumentation des SQL Servers angeht. Neben SSIS Projekten, können auch SSAS und SSRS Projekte dokumentiert werden. Der SSIS Documenter ist, wie der Name bereits erahnen lässt, ausschließlich zur Dokumentation von SSIS Paketen gedacht. Der unterschiedliche Funktionsumfang macht sich dann allerdings auch bei einem Preisvergleich bemerkbar. Die BI Documenter Version "beherrscht" das Dokumentieren von SSIS Paketen erst in der Enterprise Edition, die man ab 395,00 $ erwerben kann, den SSIS Documenter erhält man bereits ab 139,95 $.
Welche Funktionen haben aber nun die beiden Programme?
Die Dokumentation mit dem BI Documenter verläuft über einen Wizard und geht recht schnell und einfach von statten, als Ausgabeformate kann entweder CHM oder HTML gewählt werden.
Bei der Installation des SSIS Documenter schlug leider die Integration in das Visual Studio fehl, somit konnte das Programm nur über die Konsole aufgerufen werden, die Ausgabe der Dokumentation kann lediglich in HTML erfolgen.
Beide Programme dokumentieren im wesentlichen alle verwendeten Task (auch von Drittanbietern) und deren Properties.
Die Ausgabe des SSIS Documenters erfolgt hierarchisch und visualisiert sehr schön die Zuordnung von Datenspalten aus dem Datenfluss mit den Spalten der Destination. SQL Statements innerhalb eines Execute SQL Tasks werden Syntax Highlighting dargestellt und können direkt zu weiteren Debuggingzwecken in die Zwischenablage übernommen werden.
Einige Beispiel Dokumentation werden vom Hersteller auf seiner Seite zur Verfügung gestellt:
Wer den SSIS Documenter testen möchte ohne ihn zu installieren, kann Beispielpakete direkt Online dokumentieren lassen.
Der BI Documenter stellt Pakete nicht hierarchisch dar, wartet jedoch mit einer Vielzahl von zusätzlichen Funktionen auf:
-
Erstellen von Solutions die das gleichzeitige Dokumentieren mehrerer SSIS Pakete ermöglichen
-
Erstellen von mehreren Snapshots einer Solution, was die Dokumentation während des Entwicklungsprozess stark vereinfacht
-
Erstellen eigener Ablaufdiagramme mit einem eigenen Editor, der sehr stark an den Klassen-Designer im Visual Studio angelehnt ist
-
Hinzufügen beliebiger Bilder und weiterer Dokumente
Eine Beispiel Dokumentation des AWDataWarehouseRefresh Paketes aus den SQL Server Samples, sowie eine Beispiel Dokumentation der Adventure Works example Database kann auf der Hersteller-Seite heruntergeladen werden.
