In the new version of ApexSQL Doc 2016 R3, many new features and enhancements have been added.
SQL Server Management Studio 2016 integration
ApexSQL Doc 2016 R3 can be fully integrated into SQL Server Management Studio 2016 and can be used to generate documentation from Database engine.
Documenting from SSISDB catalog and SSIS project file
Documenting from SSISDB catalog is a new feature that allows you to document SSIS packages from SSISDB catalog and it can be done by clicking the Add SSIS package button in the main ribbon bar and selecting the SSISDB catalog option from the drop-down menu in the Add integration service packages dialog.
Another newly implemented feature in ApexSQL Doc 2016 R3 is documenting from a SSIS project file. To do that, select the SSIS project file option in the already mentioned Add integration service packages dialog, enter the path of the SSIS project file, or use the browse button to navigate to the location of the file.
With the implementation of these two new features, four new SSIS package details are added:
Log entry information
Those options can be found in the Package details tab among the other SSIS package details.
Documenting SSRS items from File system, Native and SharePoint web services
Documentation of SSRS items one of the main newly added features in ApexSQL Doc 2016 R3 and concludes the final chapter of BI technologies in ApexSQL Doc. SSRS items can be documented from three data sources. File system, Native and SharePoint Web Server.
To document SSRS items from the file system, click the Add SSRS items button in the main ribbon bar and select the File system option from the drop-down menu in the Add reporting services items dialog. Then add SSRS files separately using the Add button or add a whole folder using the Add folder button.
To document files from Native or SharePoint web service, follow the same steps shown above, but this time select the Native web service or SharePoint web service options in the Add reporting services items dialog. Than you will be prompted to enter the urls of both web service and the folder location and click connect.
After that, click the Item details tab and select the desired Reporting service item details for documentation.
In the picture below you can see a sample of SSRS documentation.
Reporting services switches
With the implementation of documenting SSRS items, new specific documentation CLI switches have been added.
[ /rsff ] – include Reporting services items from file system into documentation.
[ /ersff ] – specify which SSRS items from file system are excluded from the documentation.
[ /rsfn ] – include SSRS items from native server into documentation.
[ /ersfn ] – specify which SSRS items from native server are excluded from documentation.
[ /rsfs ] – include SSRS items from SharePoint server into documentation.
[ /ersfs ] – specify which SSRS items from SharePoint server are excluded from documentation.
[ /rsd ] – Reporting services details switch. Arguments are: data sources [dso], datasets [dst], embedded images [emi], page body [pbd], page footer [pft], page header [phd], parameters [prm], shared data sources [sdso] and shared datasets [sdst]. Arguments can be combined.
Return codes switch
The [ /return codes ] switch is a newly added switch, which is used to display all return codes to output console, while executing the application via CLI. This switch needs to be used in the following format:
ApexSQLDoc.com /rc /pr: [Project file] /v
0 – Success
1 – General error
2 – Invalid switch
3 – Duplicated switch
4 – Incompatible switches
5 – Missing argument
6 – Missing a dependent switch
7 – Invalid value
8 – Value out of range
9 – Invalid file path
10 – Invalid project file
11 – Unsupported edition
12 – Invalid activation key
13 – Trial has expired
14 – Connection timeout
15 – Connection failed
16 – IO error
17 – Operation canceled
18 – Application error
19 – Execution error
20 – Execution timeout
21 – Insufficient permissions
15 new CLI return error codes
ApexSQL Doc now has 21 return error codes from which 15 are newly added in the latest release.
A list of return error codes for ApexSQL Doc with their descriptions can be found below:
The <operation> has finished successfully
An error has occurred: <error>
Switch does not exist
Switches <switch1>, <switch2>… cannot be used more than once
Switches <switch1> and <switch2> cannot be used together
Missing required argument(s) for switch <switch>
Missing a dependent switch
Switch <switch1> is missing its dependent switch <switch2>
The value <value> for switch <switch> is Invalid
Value out of range
The numeric value provided for switch <switch> is out of the range. Allowed values are <range start> – <range end>
Invalid file path
Specified file path: <path> is invalid or the file does not exist
Invalid project file
Specified project file: <path to project file> is not a valid project file for ApexSQL <application name>
The Command Line Interface is not supported in the <edition> edition. To purchase the Professional edition, please contact firstname.lastname@example.org
Invalid activation key
The entered activation key is invalid. Please check that the correct activation key is entered or contact email@example.com for help
Trial has expired
Trial has expired. To extend your trial or purchase the Professional edition, please contact firstname.lastname@example.org
Connection to server <server> has timed out. Make sure that SQL Server is accessible and try again
Connection to server <server> has failed: <error description>
The application attempted to write to a file that already exists and the /force switch has not been set
The operation was canceled because the Ctrl+C or the Ctrl+Break was used
The following error has occurred: <error>
The execution of <script> has failed with following error: <error>
The execution of <script> has timed out with the following error: <error>
The operation cannot be completed because the user does not have the required permissions
The [ /silent ] switch is an another newly added switch. It can be used to disable all output to console, so that nothing is shown in the CLI.
The last but not the least, the [ /beep ] switch is added, which plays sound upon the finished operation.
August 8, 2016