ApexSQL Doc FAQ
General
Please see the following article: Minimum user permissions required for documenting in ApexSQL Doc
Please see the following: link
ApexSQL Doc can create documentation in 5 different output formats:
- CHM format (Compiled help)
- Linked HTML
- DOC (Word document 97 - 2003)
- DOCX (Word document 2007 - 2013)
Yes. Check examples on ApexSQL Doc product page
Please see the following: link
ApexSQL Doc can create documentation in 5 different output formats:
- CHM format (Compiled help)
- Linked HTML
- DOC (Word document 97 - 2003)
- DOCX (Word document 2007 - 2013)
Yes. Check examples on ApexSQL Doc product page
Yes. Learn how to customize ApexSQL Doc documentation from this link
Database engine
In order to document from Azure, the owner of the server/database must configure the access to the server in firewall settings on his Azure server. For more details, about configuring firewall settings, follow this link
Yes. Uncheck Show sections with no relevant metadata to document option
Yes. Add all the servers and databases that you want to document. SSIS packages can be documented in the same file
Yes. Go to the Database options tab and uncheck details you don’t need in the final document, or use Option presets for fast, balanced or slow documenting process. To learn more how to speed up the documentation process, see this link
Yes. ApexSQL Doc generates Permissions section with appropriate permissions per user or role
No. Extended stored procedures cannot be documented
Yes. ApexSQL Doc decrypts encrypted functions, stored procedures, triggers and views. The user must be a system administrator
Yes, symmetric keys, asymmetric keys, and certificates can be included in documentation
No, the account that is running SQL Agent and SQL Server cannot be stored
Yes, Fixed Server roles can be documented
Yes, stored procedures created for replication are included in documentation
No, dependencies based on external application dependencies cannot be documented
If the referenced database is not included in the documenting process, ApexSQL Doc will not document cross-database dependencies. To document such dependencies all dependent databases must be selected for documenting
Extended properties
Yes. Go to Database options tab and check Include extended properties option. To learn how to add or edit extended properties before generating documentation, see this link
Integration services documentation
No. SSIS package dependencies cannot be documented
Yes. ApexSQL Doc can document packages encrypted with password, whether all data, or just sensitive one is encrypted
Analysis services documentation
Yes, for that you must select multiple databases from different servers before generating the documentation
For more information about on how to automate SSAS cube database documentation follow link
Reporting services documentation
All of them including: in the page body, header or footer (Text boxes, lines, tables, matrices, rectangles, lists, images, sub-reports, charts, gauges, maps, data bars, spar-lines and indicators)
Yes. ApexSQL Doc has a fully functional Command Line Interface, which can be used combined with PowerShell and batch scripts and automate the documentation process by using CLI switches
When it comes to documenting SSRS reports from the file system all versions of SSRS, from 2005 are supported. On the other hand, SSRS report versions 2016, 2014, 2012 and 2008 R2 are available for documenting from native and SharePoint web services
Yes. Full documentation of datasets (integrated and shared) is available, including the SQL/MDX
HTML documentation
Yes. To compile HTML project to CHM format, run the following command in CLI:
%ApexSQL Doc path%\hhc.exe %HTML files path%\apexdoc.hhp
Where %ApexSQL Doc path% is the installation folder of ApexSQL Doc and %HTML files path% is the directory where the HTML files that are to be compiled are stored
To compile your HTML project to Help2 format, run the following command:
%Help 2.0 SDK path%\hxcomp.exe" -p %HTML files path%\apexdoc.HxC
Where %Help 2.0 SDK path% is the folder of Help 2.0 SDK and %HTML files path% is the folder where the HTML files that are to be compiled are stored
Yes. Uncheck Delete chm intermediary files (applicable to chm output format only) option. CHM project files and the associated HTML content files will be saved in the Intermediary subfolder. These files can be edited at will. Once the edits are complete, simply compile the .chm file manually using the MS Help File Compiler – hhc.exe – located in the ApexSQL Doc installation folder. The 'hhc.exe' must be run via a command line:
hhc <filename>
where <filename > = help compiler project file *.hhp created in the project 'Intermediary' folder
Example: hhc myfile.hhp
"C:\Program Files\Common Files\Microsoft Shared\Help\dexplore.exe" /helpcol ms-help://Namespace/TitleID
Where Namespace is a namespace of the help file and TitleID is a title identifier of the help file
Tableau documentation
Yes, but you must select multiple sites from different Tableau servers before generating the documentation
Yes. The Command Line Interface of ApexSQL Doc, can be used combined with PowerShell and batch scripts to automate the documentation process by using CLI switches
Yes, images such as diagrams, charts and other images are generated in Tableau site documentation
To document Tableau sites, server administrator privileges are required