What are the minimum user permissions required to use ApexSQL Doc?
What are the system requirements for ApexSQL Doc?
Please see the following: link
How are ApexSQL Doc Standard and Professional licensed?
ApexSQL Doc Standard and ApexSQL Doc Professional are licensed per user. To learn more about licensing, read the following article: How are ApexSQL tools licensed?
What are the differences between ApexSQL Doc Standard and Professional editions?
ApexSQL Doc Standard allows you to document SQL Server databases in various output formats.
ApexSQL Doc Professional offers advanced features to SQL Server databases documentation like graphical dependencies and data model diagrams, and support for documenting BI technologies (SSAS, SSIS and SSRS), and fully functional CLI
For more details about ApexSQL Doc edition differences, see Compare section on ApexSQL Doc product page
Learn more about feature differences between Community, Standard and Professional editions of ApexSQL tools included in ApexSQL Developer bundle on this link
What output formats can ApexSQL Doc create?
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)
Can I view a sample document?
Yes. Check examples on ApexSQL Doc product page
Can I customize ApexSQL Doc documentation?
Yes. Learn how to customize ApexSQL Doc documentation from this link
What permissions are needed to document Azure databases with ApexSQL Doc?
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
I have a lot of sections that contain info such as: "No extended properties defined", "No statistics exist" and "No check constraints exist". Can I hide a section if it’s empty?
Yes. Uncheck Show sections with no relevant metadata to document option
Can I document more than one database in the same output file?
Yes. Add all the servers and databases that you want to document. SSIS packages can be documented in the same file
Can I balance documenting speed with details that will appear in the final document?
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
Does ApexSQL Doc document object-level permissions?
Yes. ApexSQL Doc generates Permissions section with appropriate permissions per user or role
Does ApexSQL Doc document extended stored procedures?
No. Extended stored procedures cannot be documented
Can I document encrypted database objects?
Yes. ApexSQL Doc decrypts encrypted functions, stored procedures, triggers and views. The user must be a system administrator
Can ApexSQL Doc document symmetric keys, asymmetric keys and certificates?
Yes, symmetric keys, asymmetric keys, and certificates can be included in documentation
Does ApexSQL Doc store the account that is running SQL Agent and SQL Server?
No, the account that is running SQL Agent and SQL Server cannot be stored
Is it possible to document Fixed Server roles in the ApexSQL Doc?
Yes, Fixed Server roles can be documented
Is it possible to document stored procedures that have been created for replication?
Yes, stored procedures created for replication are included in documentation
Can ApexSQL Doc document dependencies based on external application dependencies?
No, dependencies based on external application dependencies cannot be documented
How do I document cross-database dependencies?
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
I want to include extended properties in my documentation. Is this possible?
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
Does ApexSQL Doc document SSIS package dependencies?
No. SSIS package dependencies cannot be documented
Can ApexSQL Doc document encrypted packages?
Yes. ApexSQL Doc can document packages encrypted with password, whether all data, or just sensitive one is encrypted
Analyzing services documentation
Can I document Multidimensional and Tabular databases and have separate documentation for both in one document?
Yes, for that you must select multiple databases from different servers before generating the documentation
How can I create SSAS documentation using the command line application?
For more information about on how to automate SSAS cube database documentation follow link
Reporting services documentation
What SSRS report page items can be documented?
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)
Can SSRS report documentation be automated?
What versions of SSRS reports can I document in ApexSQL Doc?
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
Can I document the SQL/MDX used to populate the SSRS dataset?
Yes. Full documentation of datasets (integrated and shared) is available, including the SQL/MDX
Can I compile my own HTML project if I decide later that I want it in CHM (Help 2) or I want to edit the intermediary files?
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
I want to be able to make additional edits to the chm file generated by ApexSQL Doc. Is this possible?
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:
where <filename > = help compiler project file *.hhp created in the project 'Intermediary' folder
Example: hhc myfile.hhp
How can I view my Help 2 project generated from command line mode? Do I have to register a namespace and a help file before viewing?
A project has been already registered after generation by ApexSQL Doc. Simply run the following command:
"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