ApexSQL Doc is a powerful tool that allows users to easily document SQL Server databases, SSIS packages, SSAS cubes, and SSRS items. With its user-friendly interface and command line interface (CLI), ApexSQL Doc offers flexibility and automation in the documentation process.

Components of ApexSQL Doc

ApexSQL Doc consists of three main components:

• GUI – a windows application used for manual documenting, selecting objects and options for documenting, and customizing documentation output
• CLI – a console application that allows users to run the documentation process automatically and unattended
• SSMS Add-In – a SQL Server Management Studio add-in that allows documenting directly from SSMS

It’s important to note that the SSMS Add-In is an optional component that can be selected or deselected during the installation of ApexSQL Doc.

Documenting SQL Server Databases and Server Objects

To start the documentation setup process, simply click on the “Add” button and select a SQL Server. Input the necessary details and establish a connection. Once connected, you will see a list of connected servers and databases. The “Server objects” tab will be unlocked in the Datasources and objects pane.

In the “Server objects” tab, you can select specific server object types and choose which database objects and options should be included in the documentation. The “Database objects” tab provides a list of all database object types, while the “Database options” tab allows you to choose database settings and options to be included in the documentation.

After selecting the desired objects and settings, you can generate the documentation by clicking the “Generate” button in the Home tab.

Documenting SSIS Packages

Documenting SSIS packages with ApexSQL Doc is a simple process. First, ensure that ApexSQL Doc is running with administrator privileges. Then, click on the “Add” button in the Integration services tab under the Datasources and objects pane. Select a data source where the desired packages are located and establish a connection.

ApexSQL Doc allows you to document SSIS packages from three different data sources: SQL Server, SSIS package store, or directly from package files in the file system. Once connected, you can select the package details needed for documentation, such as connection managers, data flow diagrams, control flow diagrams, event handlers, executables, log providers, precedence constraints, variables, and package source.

After specifying the required options and settings, click the “Generate” button to create the documentation. ApexSQL Doc automatically detects any changes made in the package folders, ensuring that new packages or changes in the folder used for documentation are automatically detected and documented.

Documenting SSAS Cube Databases

ApexSQL Doc also supports the documentation of SSAS databases, both Multidimensional and Tabular. To begin the documentation process, click the “Add SSAS database” button in the Home tab or select the Analysis services tab and click the “Add” button. Input the name of the SSAS server and establish a connection.

Once connected, select the desired database and go to the “Database details” tab. Here, you will find a list of both Multidimensional and Tabular database details. Select the desired SSAS details based on the type of database you want to document, and click the “Generate” button.

Documenting SSRS Items

ApexSQL Doc allows you to document SSRS reports, shared datasets, shared data sources, and projects from the file system and web services (native and SharePoint). It supports all versions of SSRS from 2005 onwards.

To document a SSRS report, select the Reporting services tab and click the “Add” button or the “Add SSRS item” button on the Home tab. Choose a data source and navigate to the location of the desired SSRS items. Once added, you will see a list of connected items with details such as the item type.

In the “Item details” tab, you can select the specific SSRS item details for documentation, including report items, data sources, datasets, embedded images, page body/header/footer, parameters, shared items, shared data sources, and shared datasets.

After selecting the desired options, click the “Generate” button to create the documentation.

Customizing the Documentation

ApexSQL Doc offers various customization options for the documentation. You can customize the documentation with different styles, custom text, and naming options. Additionally, ApexSQL Doc allows you to generate the documentation in five different output formats: CHM, HTML, DOC, DOCX, and PDF.

All of these customization options can be found under the Output options pane.

With ApexSQL Doc, documenting SQL Server databases, SSIS packages, SSAS cubes, and SSRS items becomes a streamlined and efficient process. Its user-friendly interface and automation capabilities make it a valuable tool for SQL Server professionals.