Cómo crear documentación de paquetes SSIS

ApexSQL Doc es una herramienta de desarrollo de bases de datos para documentar múltiples paquetes SQL Server Integration Service (SSIS). La herramienta permite especificar los objetos exactos del servidor, los objetos de la base de datos, los atributos, e incluso instancias de objetos específicas que serán incluidas en la documentación.

La configuración de documentación de paquetes SSIS

Primero, inicie ApexSQL Doc e inicie un nuevo proyecto haciendo clic en el botón New en la cinta de opciones principal. Para añadir paquetes SSIS al proceso de documentación, elija la opción Integration services, en el panel Datasources and objects como se muestra en la siguiente imagen:

Después de que se ha hecho clic en el botón Add, el diálogo Add integration services packages se abrirá. ApexSQL Doc soporta documentar paquetes SSIS localizados en un Package store, File system, y desde un SQL Server local o remoto.

Elegir la fuente del paquete apropiada y hacer clic en el botón Connect añade el paquete SSIS al proyecto ApexSQL Doc:

Después de conectarse al servidor o añadir el paquete desde el sistema de archivos, todos los paquetes almacenados en fuentes específicas serán cargados y listado en el panel Package selection:Package selection

ApexSQL Doc permite al usuario incluir objetos específicos desde el paquete SSIS:

Connection managers incluye la lista de propiedades y elementos del administrador, una cadena de conexión, el nombre de creación, la validación del retraso, la descripción el tipo de huésped, el ID, el Diálogo Inicial, el nombre, el nivel de protección el nombre del servidor, el nombre de usuario y retiene el mismo estado de conexión. Todas las propiedades serán agrupadas y mostradas bajo el nodo Connection manager en el archivo de documentación.

Executables incluye la lista de propiedades ejecutables, el nombre de creación, el modo de depuración, la validación del retraso, la descripción, la opción deshabilitar, los manejadores de eventos deshabilitados, la duración de la ejecución, el resultado de la ejecución, el estado de la ejecución, los paquetes fallados, los padres fallados, el valor de ejecución forzada, el resultado de la ejecución forzadas, el valor de la ejecución forzadas, el ID, el ID local por defecto, el nivel de aislamiento, el ID local, el modo de registro, la máxima cuenta de errores, el nombre, la suspensión requerida y la opción de transacción.

Otros objetos específicos que podrían ser añadidos a la documentación son: Event handlers, Log providers, Precedence constraints, Variables, and Package source (*.dtsx).

Elegir la opción Package details del menú Integration Services ofrece la lista de objetos que pueden ser documentados:

El último paso antes de la generación de la documentación puede comenzar, es elegir uno de los formatos de salida. En el panel Output options, la pestaña File format necesita ser elegida. ApexSQl Doc ofrece varios tipos de formatos de salida como HTML Compilado (CHM), archivos HTML enlazados (HTML), formatos Microsoft (DOC y DOCX) y Portable Document Format (PDF):

Generando la documentación del paquete SSIS

ApexSQL Doc comenzará a documentar el paquete SSIS y abrirá la ventana de progreso después de que se haga clic en el botón Generate del grupo Actions en la pestaña Home: