You'll receive

Bi-weekly updates

Exclusive discounts

Product update alerts

 

ApexSQL Doc release notes

Release:

2017.05.0732

Date:

July 27, 2017

Enhancements:

  • Support for SharePoint Server in doc, docx and pdf output formats

Fixes:

  • "No data source is selected for documentation" information message appears when trying to document database schema snapshots, SSAS databases, SSIS project files or SSRS items separately
  • "Specified cast is not valid" warning message appears when trying to connect to SQL Server 2016 SSISDB catalog
  • "Object reference is not set to an instance of an object" error message is shown when documenting SSAS 2016 Tabular databases in pdf output format
  • SSIS control flow diagrams are not shown in documentation when documenting SSIS 2016 packages that contain CDATA section other than DesignTimePropertis in the package source
  • Tableau site documentation is missing when documenting Tableau server without other data sources in doc, docx and pdf output formats
  • Incorrect format for SQL Server packages switch [/ssp] is present in the "Save as batch" window if no SSIS package from SQL Server is selected in the SSIS packages grid in Integration services tab
  • Missing information that the creation of database schema snapshot process has finished successfully
  • "Parse error: [Incorrect syntax near '.'] at [position: 2994, line: 68, column: 40]" error is encountered when generating database documentation in doc, docx and pdf output formats
  • SSIS packages from the SSISDB Catalog and SSIS project file are not shown in documentation when documenting them along with databases in doc, docx and pdf output formats
  • Two or more SSRS items from file system cannot be documented at the same time using the CLI switch [/rsff]
  • CLI error return code [1] for "general error" is shown when a database schema snapshot is successfully created through the CLI

Changes:

  • SSIS package "Design time properties" XML code is no longer generated inside of "Package properties" section in documentation

Release:

2017.04.0695

Date:

June 19, 2017

Enhancements:

  • Support for Tableau server in chm and html output formats
  • CLI switches:
    • Include Tableau Server sites [/tss]
    • Exclude Tableau Server sites [/etss]
    • Include Tableau Online sites [/tos]
    • Include Tableau server details [/tsd]
    • Create database snapshot [/cdbsnp]
    • Include database snapshot [/dbsnp]
    • Database snapshot output directory [/dbsnpod]
    • Database snapshot file name [/dbsnpfn]

Fixes:

  • “Object reference is not set to an instance of an object” is encountered when documenting databases with customized object options for SQL tables
  • “Object reference is not set to an instance of an object” is encountered when a database schema snapshot is documented in chm and html output formats
  • Unhandled exception is encountered when removing a created database schema snapshot from the selection grid in the Database engine tab
  • Application stops responding when connecting to Tableau Server with credentials for Tableau Online
  • Unhandled exception is encountered when editing a column Description of a SQL stored procedure in the Extended property editor window
  • SQL tables are missing from documentation when documenting through the CLI and specifying the switch for including the “Permission” section for SQL tables in the documentation
  • Timeout expired and "A network-related or instance-specific error" message is encountered when documenting database schema snapshots in chm and html output formats
  • Saved selected database snapshots in the project file are not checked as selected when the project file is opened again
  • Settings from the Options window are not saved in the project file
  • Switching the extended property from one to another in the Extended property editor will reset the selection in the grid
  • SQL Server data type "nvarchar(-1)" is displayed in the doc, docx and pdf documentation instead of "nvarchar(max)" for SQL table column statistics
  • “Graphical dependencies” section remains open after clicking the “Collapse all” hyperlink in documentation in chm and html output formats
  • Wrong formatting of executed SQL tasks code in SSIS documentation
  • Wrong formatting of user variables code in SSIS documentation
  • Wrong formatting of connection managers code in SSIS documentation
  • The window minimize button in the documentation progress bar does not minimize the entire application
  • The progress bar appears under the Server objects tab when using the Community or Standard edition of the application
  • The “Search” button in the Extended property editor is not synchronized with the “Close” button in the “Search” section
  • Documentation can be created even when no data source is added or selected
  • The last used file path for adding a database snapshot is not remembered
  • When choosing the location to install application, there is no option to create a new folder
  • A second warning message “Connection to server failed. Make sure the server is running” is encountered when trying to connect to an inaccessible Tableau server
  • Tab stops are not configured properly for “Add Tableau server” window
  • “Delete intermediary files” checkbox can be selected by clicking on a blank space next to the same option button
  • “Document style” in Style tab in Defaults window can be selected by clicking on a blank space next to the same option button
  • “OK” and “Refresh” buttons are not available for a long time in Local tab in Servers browser when connecting to a new server
  • Defaults window tabs specific for the Standard and Professional editions of the application are available in the Community edition after closing the restriction message
  • Unselected options from the Site details tab are included in Tableau Online documentation in doc, docx and pdf output formats
  • Wrong object name and icon are displayed in the "Edit extended property" window in the Extended property editor
  • Added database schema snapshots are not shown in “Batch script” section in "Save as batch" window

Changes:

  • CLI switch Output format [/of] is now Output type [/ot]

Release:

2017.03.0669

Date:

May 15, 2017

Enhancements:

  • Database schema snapshots in doc, docx and pdf output formats
  • Support for Tableau server in doc, docx and pdf output formats

Fixes:

  • Missing informative message when there are no database schema snapshots selected in the Database engine tab and one of the Database engine sub-tabs are clicked
  • Customized copyright text is not documented when generating documentation through a batch file
  • Settings from the Options window are not saved in the application project file

Release:

2017.02.0642

Date:

April 18, 2017

Enhancements:

  • Database schema snapshots in chm and html output formats
  • Support for SQL Server vNext CTP1
  • Support for SQL Server Management Studio v17.0 RC3 integration

Fixes:

  • “Null reference exception” error is encountered when documenting an empty SSAS tabular model database
  • SQL columns and SQL indexes documentation columns are misaligned when setting the Options presets slider to Detailed
  • SQL Server properties cannot be excluded from the generated documentation in chm, html, doc, docx and pdf output formats
  • SQL Server objects cannot be documented without SQL Server properties in chm, html, doc, docx and pdf output formats
  • Wrong key column is shown for SQL indexes documented in chm and html output formats
  • Table of contents nodes for SQL Server objects and properties are missing from documentation in doc, docx and pdf output formats
  • “Could not find the part of the path” error is encountered if Illegal file naming characters are used in documentation output folder path when documenting SSAS tabular model databases in chm output format
  • “Object reference not set to an instance of an object” error is encountered if Illegal file naming characters are used in documentation output folder path when documenting SSAS tabular model databases in docx, doc and pdf output formats
  • Description from columns is missing in SSAS tabular model database documentation in chm, html, doc, docx and pdf output formats
  • Data model diagrams are not generated in the database documentation when the “Additional attributes for tables and columns” option is enabled in the Database options tab
  • Auto update statistics description is wrong for SQL Server properties in documentation in chm and html output formats
  • Data model diagrams are being generated in the documentation even if the “Data model diagram” option in the Database options tab is disabled when the project is saved and used as a batch file
  • “Additional attributes for tables and columns” option is not saved in the Database options tab in the Project defaults window
  • “Dependency type” and “Dependency layout” options are not saved in the Database options tab in the Project defaults window
  • SQL views pages are missing from the documentation in chm and html output formats
  • Default output location is used instead of the user defined output location when generating documentation in html output format
  • SSIS packages passwords are visible in the Integration services tab
  • Connection timeout and Execution timeout options allow letter characters to be typed in the SQL Server Connection options window
  • When setting the Option presets to Fast only the “Show server node in .chm documentation” option is enabled in the Database options tab
  • “This page can't be displayed” message appears in file system SSIS packages documentation in chm output format
  • Object filter is no longer applied after generating documentation in chm, html, doc, docx and pdf output formats
  • Documentation is generated containing all database objects when Contains and Ends with filter clauses are used in the database objects filter
  • Table of content nodes for SQL Server objects and properties are missing from documentation in doc and docx output formats
  • Wrong key column is shown for SQL indexes in documentation
  • Columns in documentation are misaligned for SQL indexes and SQL columns when the option presets are set to detailed

Changes:

  • Computed column details can now be excluded from documentation when the “Additional attributes for tables and columns” option is unchecked in the Database options tab
  • SQL Server objects can be documented without also having to document SQL Server properties

Release:

2017.01.0599

Date:

March 01, 2017

Enhancements:

  • GUI themes:
    • Colorful
    • Dark

Fixes:

  • “Object reference not set to an instance of an object” error is encountered when generating database documentation with unselected "Indexes" option in the Table options menu in the Database objects tab
  • Data flow and control flow diagrams are missing from the generated documentation for a SSIS 2012 package with non-English characters
  • “Object reference not set to an instance of an object” error is encountered when documenting SSIS 2016 packages from the file system when only SSIS 2016 is installed
  • Data model diagrams are missing in documentation for SQL tables that contain a Data model diagram with dimensions larger than 2,432 x 39,474 pixels
  • “Parse error: [Incorrect syntax near '@CONSECUTIVO'] at [position: 1286, line: 71, column: 37]” error is encountered when generating documentation for a SQL Server 2008 R2 database which contains the try_parse statement, in doc, docx and pdf output formats
  • SSIS packages cannot be added in Add integration service packages window from more than one default named Integration services instance
  • Half of the options in the Database options tab cannot be selected when navigating using keyboard controls
  • SQL table with unique index in database graphical dependency diagram is linked to a missing page in chm and html documentation
  • Changing the “Compile timeout” value in Options window doesn’t have any effect on the duration of chm documentation compilation
  • "AutoMapper.AutoMapperMappingException" error is encountered when documenting a SSAS multidimensional database with no measure group dimensions in chm and html output formats
  • Documenting SSIS packages from the SSIS 2012 package store or from the file system generates empty documentation in doc, docx and pdf output formats when only SSIS 2012 is installed
  • Code for SQL tasks is not formatted in SSIS package chm and html documentation output formats
  • Code for user variables is not formatted in SSIS package chm and html documentation output formats
  • (Shift+Enter) shortcut cannot be used to skip to another row in the Comments textbox under the Output tab in the Options window
  • Option presets are not responding fluently to preset slider position changes
  • SQL code for XML schema collection is not clearly formatted in chm and html documentation output formats
  • No syntax highlighting for SQL code for documentation in doc, docx and pdf output formats
  • The Windows taskbar is not displayed when hovering mouse when the “Auto-hide the taskbar” option is checked and the application is maximized
  • Data model diagrams section expands when clicking the Collapse button in the Graphical dependencies section in chm and html documentation output formats
  • Table sections are not collapsing in the Data source views page of the SSAS multidimensional database documentation in chm and html output formats
  • Index columns section is not properly formatted in chm and html documentation output formats, when the "Explicitly document indexes" option is checked for SQL tables under the Database objects tab
  • SSRS items can’t be removed when the Delete keyboard button is pressed in the Add reporting services items window
  • The application cannot be integrated in SQL Server Management Studio 16.5.3
  • The “Extended properties” option under the Package details tab and the Database objects tab under the Defaults window is disabled when “Include extended properties” option is unchecked in Database options tab

Changes:

  • Sample values “Sample header text” for page header and “Sample footer text” for page footer are removed from the application Standard edition documentation
  • CLI return error code [3] for “invalid switch format” error is now [7]
  • CLI return error code [3] for “value out of range” error is now [8]

Release:

2016.05.0481

Date:

October 27, 2016

Enhancements:

  • Support for SSAS 2016 Tabular databases written in TMSL
  • Save project as batch file

Fixes:

  • Incomplete table in server configuration page in Azure database documentation
  • Wrong page linked for SSIS configuration settings in HTML documentation
  • Wrong page linked for SSIS configuration settings in CHM documentation
  • Broken links in CHM documentation for all table links under "Datatypes" section
  • The application does not document Schemas objects when chm is set as output
  • Documentation creation failed because the intermediary file path for SSIS cannot be found
  • Unable to execute file in temporary directory. Setup aborted, when downloading and installing application
  • The default output location is not saved in the project file
  • The documentation output format is not saved in the project file
  • Object filter settings not working right when selecting a few objects
  • SSAS Database details tab missing Project defaults
  • The "Filter" check boxes column is excessive in the "Database objects" tab
  • Missing scrollbar in SSAS documentation at MDX script page in Calculations
  • Shortening the title of reporting service item in generated DOC format
  • Analysis & add reporting services dialogs cannot be closed by ‘Esc’ key
  • SSRS documentation main page is not displayed at start
  • SSRS item details tab missing Project defaults
  • Missing shortcut for Add SSAS database option in Options menu
  • Missing shortcut for Add SSRS database option in Options menu
  • SSISDB documentation main page is not displayed at start
  • Bad documentation style in HTML format
  • Collapse image in SSRS documentation in html format
  • Data model diagram not generated for the table that does not have Primary key defined
  • Extended properties cannot be edited on a column level for specific database

Release:

2016.04.0425

Date:

September 15, 2016

Enhancements:

  • Export CLI help as HTML switch [/hth]
  • Logging level switch [/log]
  • 15 new return error codes:
    • Invalid value
    • Value out of range
    • Invalid file path
    • Invalid project file
    • Unsupported edition
    • Invalid activation key
    • Trial has expired
    • Connection timeout
    • Connection failed
    • IO error
    • Operation canceled
    • Application error
    • Execution error
    • Execution timeout
    • Insufficient permissions

Fixes:

  • Incomplete table in server configuration page in Azure database documentation
  • Output file formats remain locked as in community mode when application is activated
  • Scrolling the mouse wheel does not affect the scrollbars in Output options for Styles and Custom text forms
  • Parse error: Incorrect syntax near 'SELECT' is encountered when documenting a specific database
  • Metro style documentation saved in a project file is documented in a different style via CLI
  • Parse error: 'Cannot Recognize Token' is encountered when documenting specific database in docx format
  • The 'value' for parameter @StartDate is missing from SSRS documentation in Word/PDF format
  • Error is encountered when documenting SSISDB Catalog package with 'space' character in file name
  • Documentation of SSISDB catalog packages created empty in docx/pdf format on Windows 7
  • Parse error: [Cannot Recognize Token [ ] in [position: 5774, line: 196, column: 27]] at [position: 5774, line: 196, column: 27] in query [ype, Encoding, LocalParent, LocalChild, LockStatus, PendingCommand)
  • “Query” dropdown missing in a certain part of the SSRS documentation in chm/html format
  • Settings from SSIS project file missing when loading a ApexSQL Doc project file
  • When refresh button is clicked, all of the loaded SSAS databases disappear
  • “Query” dropdown missing in a certain part of the SSRS documentation Word/pdf format
  • SSRS items are grouped together with SSAS databases in .docx documentation
  • Wrong section title in SSRS documentation navigation pane
  • Missing information about usage format for /rsfn switch in CLI help
  • Missing information about usage format for /ersfn switch in CLI help
  • Missing information about usage format for /rsfs switch in CLI help
  • Missing information about usage format for /ersfs switch in CLI help
  • Empty SQL section in the documentation
  • Empty SQL query definition section displayed in SSAS documentation
  • Wrong error code and output in CLI when trying to connect remote server without valid credentials
  • Missing output for successfully completed operation in CLI
  • Wrong error code and output for invalid specified file path in CLI
  • Wrong error code and output for invalid specified project file in CLI
  • Wrong error code and output in CLI when application is used as Standard edition
  • Wrong error code and output in CLI when trial period has expired
  • Wrong error code and output in CLI when MSSQLSERVER service is paused or terminated
  • Wrong error code and output in CLI when operation is terminated by user

Changes:

  • New product icon

Release:

2016.03.0403

Date:

August 01, 2016

Enhancements:

  • SQL Server Management Studio 2016 integration
  • SQL Server Reporting Services documentation
  • Document SSIS packages from SSISDB catalog
  • Document SSIS packages from project files (.dtproj)
  • Document SSIS package details:
    • Project parameters
    • Log entry information
    • Extended properties
    • Configuration settings
  • SSIS source and destination mapping
  • Dependencies between SSIS packages and referenced database objects
  • Support for SSIS 2016

Fixes:

  • "Parse error: Incorrect syntax near '@vLogin'" error is encountered when documenting databases in doc, .docx and .pdf output formats
  • "Parse error: Incorrect syntax near 'int'“ error is encountered when documenting databases in doc, .docx and .pdf output formats
  • "Parse error: Incorrect syntax near 'AS'“ error is encountered when documenting specific database in doc, docx or pdf output formats
  • "Parse error: An object or column name is missing or empty“ error is encountered when documenting specific database in doc, docx or pdf output formats
  • "Application error: 'Exception in GetDataItemTableId'" error is encountered when documenting specific SSAS database
  • ApexSQL Defaults in SSIS package details tab does not work
  • ApexSQL Defaults doesn’t work for any Dependency options settings
  • "Parse error: Incorrect syntax near ','"
  • "Parse error: Incorrect syntax near 'SYSTEM_VERSIONING'"
  • "Parse error: Incorrect syntax near 'FOR'"
  • "Unhandled exception: 'Object reference not set to an instance of an object'" is encountered when documenting specific SSAS database
  • My defaults in Database details tab is not working correctly
  • “Parse error: Incorrect syntax near 'XML'” is encountered when documenting a specific SQL Server database in .pdf format
  • Settings for documenting Data model diagrams are not turned on by default
  • Missing switch for including Dictionary in Documentation
  • Unsupported file types can be included in Add integration services packages modal dialog
  • Sending Logs not working in SSMS addin
  • "System.NullReferenceException" is encountered when documenting SSIS packages when not having the required Integration services installed
  • Can't document a single package from the file system, via CLI
  • Unnecessary dialog pops up when clicking my defaults in SSAS database details
  • Can't document a single package from package store, via CLI
  • Can't document a single package from SQL Server, via CLI
  • "Parse error: Incorrect syntax near '('" is encountered when documenting master database from SQL Server 2014
  • Output options not accessible in certain situation when no datasource is added
  • "System.NullReferenceException" is encountered when connecting to two SSIS servers and selecting the Package details tab
  • "System.StackOverflowException" is encountered when documenting a specific database in Word/PDF formats
  • Error encountered when documenting SSIS packages from a project file in CLI or PowerShell
  • It is possible to generate documentation without any input
  • Documentation can be generated with empty SSISDB catalogue
  • Incorrect password error when documenting encrypted SSIS package with valid credentials in PDF format

Release:

2016.02.0357

Date:

April 19, 2016

Enhancements:

  • SQL Server 2016 RC3 support
  • SQL Server on Amazon RDS support
  • SQL Server Analysis Services documentation
  • Database model documentation
  • The following Azure SQL Database V12 object and properties are now fully supported:
    • Objects:
      • Assemblies
      • Asymmetric Keys
      • Certificates
      • Defaults
      • Encryption
      • Extended properties
      • Fulltext catalogs
      • Fulltext stoplists
      • Indexes
      • Partitions, partition functions, and partitions schemes
      • Rules
      • Search property lists
      • Sequences
      • Symmetric keys
      • XML schema collections
  • Enhancements in previously supported object types:
    • Indexes:
      • COLUMNSTORE indexes
      • Relational indexes:
        • PAD_INDEX
        • FILLFACTOR
        • SORT_IN_TEMPDB
        • ALLOW_ROW_LOCKS
        • ALLOW_PAGE_LOCKS
        • MAXDROP
        • DATA_COMPRESSION
    • Stored procedures:
      • WITH ENCRYPTION
      • FOR REPLICATION
      • EXTERNAL NAME
    • Tables:
      • ON keyword
      • TEXTIMAGE_ON
      • column_definition
        • NOT FOR REPLICATION
        • ROWGUIDCOL
      • column_constraint, computed_column_definition, table_constraint
        • FILLFACTOR
        • ON
        • NOT FOR REPLICATION
      • index_option
        • PAD_INDEX
        • FILLFACTOR
        • ALLOW_ROW_LOCKS
        • ALLOW_PAGE_LOCKS
        • DATA_COMPRESSION
        • ON PARTITIONS
    • Triggers:
      • WITH ENCRYPTION
      • CLR-triggers
      • FOR REPLICATION
      • EXTERNAL NAME
    • User defined types:
      • CLR-types
      • ROWGUIDCOL
    • Users:
      • Database-contained users
    • Views:
      • WITH ENCRYPTION

Fixes:

  • "Parse error: Incorrect syntax near 'index'" error is encountered when documenting a database in Word format
  • SSIS diagrams are not documented when using Word or PDF output formats
  • Activation upgrade from Standard to Professional edition is disabled
  • Missing scroll bars in CHM output format
  • Project saved in evaluation of ApexSQL Doc cannot be loaded in Standard edition
  • Error when documenting SSIS store packages in Word/PDF “Could not find a part of the path 'C:\Users\User_name\AppData\Local\ApexSQL\ApexSQLDoc\Intermediary\Temp8048\SSIS\WIN-L9QH41R7LP9\package_index.htm'”
  • Parse error: [Incorrect syntax near 'ON'] error is encountered when documenting a Azure SQL Database V12 in Word/PDF format
  • Broken images in the Preview section under the "Styles" tab
  • Command line window appears every time while generating documentation and its maximized

Changes:

  • ApexSQL Doc “Developer version” is renamed to ApexSQL Doc “Standard edition”
  • Documenting integration services is now available only in ApexSQL Doc “Professional edition”

Release:

2016.01.0326

Date:

December 11, 2015

Enhancements:

  • SQL Server 2016 CTP3 support
  • SQL Server Management Studio 2016 CTP3 integration
  • Interactive graphical dependencies diagram
  • Granular documentation of object level attributes

Fixes:

  • Table options pane from the database object menu is cut on some display resolutions
  • SSIS diagrams won't be displayed in DOC or PDF output document if some specific options are unchecked in the "Package details" tab
  • The application causes SQL Server Management Studio to stop working when the add-in is not integrated
  • The same variables are documented for each task separately
  • "Some packages could not be loaded without valid credentials" error is encountered when documenting specific SSIS package
  • Scrolling in any application's tab is not available until any option is changed
  • Ctrl+A doesn’t select all checkboxes in Database objects
  • Selected extended property for the database will be documented even if the extended properties are excluded from the documenting process
  • The description column is not removed from the output document if the "Include extended properties" option is unchecked in the application options
  • The "TrackColumnsUpdatetedEnabled" item is not correctly specified in the output documentation
  • Documentation in PDF is not properly formatted
  • "System.OutOfMemoryException" error is encountered when documenting specific package
  • The "Document procedure/function result set" option is not synced with the "Recordset" function attribute
  • The application fails to include custom header/footer settings for doc, docx, and pdf output formats, when using the project file in the CLI
  • The "Shortcuts" tab is added under the "Options" form
  • The "Extended property editor" column filter becomes unusable after setting the filter and clicking the filter icon in the top row
  • The "DependencyViewerConsole" process does not stop when documenting a database in PDF format using the CLI
  • The "DependencyViewerConsole" process does not stop when documenting a database in CHM or HTML format using the CLI or GUI
  • The application fails to properly apply the chosen date format in the output document
  • "Input string was not in a correct format" error is encountered when documenting specific SSIS package
  • Column names are not displayed properly in the "Table statistics" section of the report in CHM and HTML format
  • The add in file for SQL Server Management Studio integration is created in the following location: C:\Program Files\ApexSQL\ApexSQLSourceControl2015
  • Obsolete example for deprecated HxS file format found in the Examples folder of the installation folder
  • The "Transact SQL syntax highlighting" option remains checked even if the "Data definition language (DDL) script" option is checked
  • The application does not format HTML tags in the extended properties
  • Specific columns cannot be excluded from the documentation
  • The installation wizard offers SQL Server Management Studio integration even if that version is uninstalled
  • The application is unable to document database without showing the Server node
  • A parsing error is encountered when documenting specific database for DOC/DOCX and PDF file formats
  • The add-in menu in SQL Server Management Studio is not consistent with other ApexSQL menus
  • SSIS diagrams cannot be excluded from the documenting process
  • The application can be installed even if the minimum system requirement is not met
  • The application's add-in is not alphabetically sorted in Object explorer
  • ApexSQL Doc does not generate graphical dependencies for database objects that have only outbound dependencies

Changes:

  • The application now requires Microsoft .NET framework 4.5.2
  • Windows Server 2003 is no longer supported

Release:

2015.04.0315

Date:

September 04, 2015

Fixes:

  • The application does not document database objects, if the Cumulative update 7 for SQL Server 2012 Service Pack 2 is installed
  • A parsing error is encountered when documenting specific database for DOC/DOCX and PDF output file formats

Release:

2015.03.0312

Date:

May 15, 2015

Fixes:

  • "Unexpected error occurred. Method 'ApexSql.Doc.Properties.CliStrings.ExtendedPropertiesHelp' not found." error is encountered when running the "/?" switch in the CLI
  • SQL code won't be highlighted for the specific objects
  • "System.IndexOutOfRangeException" error is thrown by the "Remove" button inside the "Integration services" tab
  • The header/footer settings is not being used when generating PDF
  • "Property accessor 'Children' on object 'System.Int32' threw the following exception:'Object does not match target type.'" error is encountered when removing SSIS package source
  • The dependency viewer console process stays in the task manager, even after the command prompt window is closed, when documenting from GUI
  • Specific object types are not shown in the output document
  • No images for dependencies are displayed in the report generated from CLI with appropriate switches used
  • The application fails to preview inter-database dependencies
  • Custom text will be wiped out after opening a project from previous version
  • The install wizard does not recognize version of running SQL Server management Studio and will not allow installation, even when the running version is unchecked for add-in integration
  • The "Document server properties" option fails to updated in the main form until the application restart
  • The logo will be removed if intermediary files are set to be deleted after documenting
  • Missing table icons inside document generated from CLI
  • Columns width is not properly determined in the generated documentation
  • The "Use short names" tooltip does not show up in application Deafults, if the option is not enabled
  • The application is installed successfully even both SQL Server Management Studio (2012 and 2014) are running
  • "Parameter is not valid." error is encountered when documenting SSIS package whose diagram position exceeds the limit of 65k pixels
  • The application help is not redirected to knowledge base content
  • The application adds excessive lines in SQL script for tables when the "Include DDL script" option is checked
  • "Parse error: [Incorrect syntax near 'TRANSACTION']" error is thrown when documenting database from SQL Server 2005
  • Date format change inside options is accepted only after application restart
  • Documenting database from SSMS 2014 will display incorrect tab labels in application
  • Saved projects from previous applications major versions cannot be opened
  • "The given key was not present in the dictionary." error is encountered when documenting SSIS package in PDF/DOC/DOCX format
  • The image placeholder will be inserted automatically, and documented as a broken image when using the application on x86 OS and SQL Server 2005 x86 installed
  • All icons in dependency type/layout drop menus are same

Release:

2015.02.0304

Date:

March 6, 2015

Enhancements:

  • Documentation options presets have been added - Fast, Balanced, Slow and Custom
  • The "One-click documentation" option from SQL Server Management Studio has been added
  • The application now supports Azure SQL Database V12
  • The documenting process is now up to 6% faster for DOC and DOCX output formats
  • The documenting process is now up to 12% faster for PDF output format

Fixes:

  • "Parse error: [Incorrect syntax near 'COLLATE'] at [position: 485, line: 16, column: 85]" error is encountered when documenting specific database
  • The "Cancel" button on error reporter closes SQL Server Management Studio
  • "The given key was not present in the dictionary" error is encountered when documenting an SSIS package from Integration Services 2008
  • "Parse error: [Incorrect syntax near 'CELLS_PER_OBJECT'] " encountered when documenting specific database
  • The application GUI does not refresh on database and server objects form, when changing documentation presets
  • The image on Custom text is broken after the application first run
  • After the "/op" switch is applied it is possible to apply all other option switches
  • The "Remove image" button is disabled when the image is added
  • "System.NullReferenceException" error is encountered when opening a project with double-click
  • The application can be uninstalled even if it is still running
  • The "Remove image" button in the "Custom text" tab remains enabled after removing an image
  • The image inserted in header/footer will be broken if the intermediary files location is changed after the image is added
  • The default settings will not be applied when starting the application from SQL Server Management Studio, if they are changed
  • The default selection of the server and database object cannot be applied until the application is restarted
  • The "Extended properties" on database object level cannot be set to "unchecked" in the "Defaults" section
  • Particular date formats specified in the "Output" section are not applied the same in the "Naming" tab
  • The content of the "Preview" section will disappear when pressing the F5 key
  • Changes made in the "Defaults" section for the "Custom text" tab will revert any previous changes made in the "Custom text" tab in the main form
  • The "/ff" switch can be specified, even when the "/ffh" and/or "/fff" switches are specified
  • The application will stay in community mode after activation, and requires a restart
  • The "Server info" section remains in the documentation even when the Server objects/info are excluded from documenting
  • The logo position switches to "Header and footer", even when the position is set to "Header" or "Footer"
  • Removing the "Copyright link" value does not disable the text in the output document to be shown as link
  • Server objects cannot be set separately for different servers when documenting from more than one server
  • SQL code inside 'Job' step is not formatted correctly
  • Missing informative message when both "/sina" and "/sinn" switches are used
  • "The given key was not present in the dictionary" message is shown when Executables and Precedence constraints are unchecked in the "Package details" tab
  • Missing informative message that the project needs to be saved when clicking the "Open" button to open another project
  • Missing icons for documented SSIS package in the .chm format
  • The CHM compiler stops working when specific packages document are being documented
  • The width of the tables is different when documenting in PDF and Word formats
  • Hyperlinks do not work in the generated PDF document
  • The collapse/expand characters are not consistent in HTML output document
  • The default location for add-in files is changed after a specific Windows update
  • Clicking the "Defaults" button in the "Custom text" tab fails to set the options to user defaults
  • The application fails do document an image when the same documenting process is initiated twice, one after another
  • Header and Footer settings are not applied when using the CLI
  • The default page settings are not applied when documenting in the CLI
  • "The specified intermediary files location folder does not exist" error is encountered when documenting database using the CLI

Changes:

  • The "Startup action" section under the "Options" tab is removed

Known issues:

  • The "Transact-SQL highlighting" option does not work consistently on all objects

Release:

2015.01.0290

Date:

December 31, 2014

Enhancements:

  • The application now supports documenting of Control flow diagrams
  • The application now supports documenting of Data flow diagrams
  • Documenting process is now up to 50% faster for all output formats
  • Graphical dependencies documenting is now up to 23% faster, depending on the output format
  • Display page numbers in .doc/.docx/.pdf documentation
  • Choose either to name graphical dependencies with schema qualification or server

Fixes:

  • The "Include table of contents in .doc and .docx formats" option is incomplete
  • Diagrams for packages are missing when path for Intermediary files is changed
  • Filter for Roles shows each role twice
  • The "Include table of contents in .doc and .docx formats" option cannot be changed in the application defaults
  • The "One or more errors occurred." error is encountered when documenting database from Azure
  • Incorrect image for Messagetype objects in the Extended property editor grid
  • Incorrect and inconsistent message during the installation, if the application is already running
  • The "Pivot" icon in the Data Flow diagram is not properly documented
  • The "Merge Join" icon is not properly documented
  • The "Flat File Destination" icon fails to appear in the output document
  • The Connection Managers section in the main report pane indicates that "No item exists", even it is clearly visible after expanding the three in left pane that these actually exists in the package
  • The application fails to generate Data Flow diagram for teh particular SSIS package
  • The "Index was outside the bounds of the array." error is encountered when documentng specific package
  • The control flow diagram is not properly created for the particular object
  • The temporary images used to document graphical dependencies will be created in the destination path instead in the intermediary folder
  • The background color is inconsistent for all color in the Custom text tab - "Preview" section
  • The "Data at the root level is invalid. Line 1, position 1." error is encountered when documenting specific package
  • The application fails to initiate from SQL Server Management Studio Object Explorer
  • Extended property editor cannot be used on databases with more than 20,000 objects
  • Deselecting some columns in 'Select Column Option' results that grid with remaining columns doesn't populate all space left
  • Incorrect preview for the specific characters in the "Preview" section of the "File name" template
  • The "Save changes to the project" dialog appears even if there is no changes made in the project
  • Excessive scroll bar inside the "Preview" pane, from the "Custom text" tab
  • The date tag is not previewing in the "Preview" section of the "File name" template settings in the "Naming" tab
  • The application is installed in a separate folder in the Start menu
  • The "Preview" section fails to appear when the application is started
  • The background color is inconsistent for all color in the Custom text tab - "Preview" section
  • Specific databases cannot be documented in html, doc, docx and pdf with graphical dependencies included
  • The header and footer text in the Custom text tab are formatted as Bold, Italic and Underline by default
  • Wrong number for the maximum characters allowed is specified in the "Creating the documentation has failed" window
  • The "Explicitly parse database for improved dependency accuracy" option needs to be disabled/grayed when the "Include dependency list/tables" option is unchecked
  • The "Include data definition language (DDL) script" option keyboard shortcut does not work
  • The date tag is not previewing in the "Preview" section of the "Documentation title" template settings in the "Naming" tab
  • Date format field in output options should be pre-defined drop down pick list
  • The state of the buttons in the "Custom text" tab is not recognized
  • Initiating the "Defaults" button, switches the image position to "None", instead completely removing image path
  • Missing "Name" column in the documentation when documenting SSIS packages in DOC, DOCX, and PDF
  • The connection password is not saved even if the "Remember password" is checked
  • The "/ps" and "/po" switches can be specified for the chm or html documenting even if this is senseless
  • The image inserted in header/footer is broken in the output chm document when the intermediary files location is not set to default
  • The row filter in the "Extended property editor" window is case sensitive
  • The "Extended property editor" window will close on ESC key without any warning message
  • The application can be uninstalled without warning if SQL Server Management Studio is still running
  • Missing switches for the new options in the "Custom text" tab
  • The application fails to format HTML tags in the extended properties
  • The "Parse error: Parse error: Error : [Incorrect syntax near 'AS']" error is encountered when documenting specific database in doc, docx or pdf
  • The application fails to generate documentation in the HTML output format

Release:

2014.03.0277

Date:

October 31, 2014

Enhancements:

  • The application now integrates as an add-in in SQL Server Management Studio 2014/2012
  • An option to add images in header/footer of the output document is added for CHM and HTML output formats
  • An option to choose a page orientation (portrait or landscape) of the output document is added for DOC, DOCX, and PDF output formats
  • An option to select the page format (A3 or A4) of the output document is added for DOC, DOCX, and PDF output formats
  • Options to edit header/footer text, font, formatting, and color are added
  • An option to select the dependency level for object dependencies is added
  • An option to include/exclude extended properties on the object type level is added
  • Graphical dependencies documenting is now up to 24% faster, depending on the output format

Fixes:

  • The "/f" switch does not work
  • The project file is processed incorrectly, when opened with a double click
  • The application fails to create graphical dependencies for the first database, when two or more databases are included in the processing
  • The application cannot document Windows Azure SQL Databases in CLI
  • The application hangs when the switches are duplicated
  • The "/?" switch does not work in the CLI
  • The "The given key was not present in the dictionary." error is encountered when canceling the documenting process
  • The application fails to document graphical dependencies for objects with 100 and more parent/children objects
  • The documentation fails if the "<object_name>.gif" icon is renamed in the application install directory
  • Intermediary files are not deleted, and the dependency viewer process remains active, when canceling the documenting process
  • The "Scale" option in the "Dependencies" tab does not work
  • The documenting process hangs for hours on a specific database function
  • The "Collapsible image" is displayed instead of "+" sign in some parts of the documentation
  • The "System.Argument exception Parameter is not valid" error is encountered when starting another instance of the application, while one instance is still running
  • Inconsistent list of the available tags in the Custom text tab, and in the application "Default" settings
  • The "/srd:n" switch will not exclude the "Server info" node from the documentation
  • SQL Server login status is not documented when using doc, docx, or pdf as an output format
  • The dropdown menu of grid filtering in the "Extended property editor" window does not offer reselection
  • The "System.IndexOutOfRange exception" is encountered when documenting database information on specific databases
  • Documenting process hangs when documenting specific database
  • Generating documentation failed if the already existing folder is specified using the /od switch in the CLI, when using the HTML output format
  • Documentation dictionary is not sorted in alphabetical order in specific situations
  • The "Destination patch check" message pops up when documentation is created from CLI

Known issues:

  • Extended property editor cannot be used on databases with more than 20,000 objects
  • The application does not integrate as an add-in in SQL Server Management Studio 2008/2005

Release:

2014.02.0265

Date:

July 29, 2014

Enhancements:

  • The application now fully supports SQL Azure
  • The application now supports PDF output format
  • The application now supports new metro style for the generated documentation

Fixes:

  • The application cannot detect SQL Server 2005 version when installed on the x64 bit Windows Server 2003 operating system
  • Incorrect name of the application log files
  • Local servers cannot be removed from the drop down list in the 'Add SQL Server' window
  • The "Custom text" changes every time when clicking on the "Defaults" options
  • The "Send logs" functionality is incomplete when a mail client is not present in the system, and after the first attempt every press on the "Send logs" option will not work while causing the application window flashing
  • When the "Use filter" check box is set manually, it will stay checked even after pressing the "Uncheck all" check box
  • Unchecking the "Make sections collapsible" option will not remove the warning message related to the JavaScript from the "Preview" section
  • The "Full preview is not available with JavaScript turned off." message in the "Styles" option is misguiding and wrong
  • When checking the "Server objects" and the "Database objects" check box for the Object type, the associated Use filter check box will be checked automatically as well
  • The incorrect version of the application is shown in the Control Panel after the application is updated to a newest version
  • The "MaximumDegreeOfParallelism" in the Table properties section of the final document displays a negative value
  • The "Graphical dependencies" are excluded from the report for the objects which do not have any dependent child objects even if the "Parents and descendants" option is set
  • Visible legacy windows when activating the application
  • After updating to a newest version an old icon is displayed on the desktop
  • Incorrect link to the product page in the Support section in the Resource tab
  • The "Sample preview" in the "Output" option preview is missing
  • The "Collapse all" option in a documentation is not working in the Google Chrome browser
  • Incorrect tooltips are used for options
  • Inconsistency between icons in the main GUI
  • Incorrect name of the 'Database description' in the 'Extended property editor' window
  • Incorrect clickable area for the "Server objects" option
  • An option to resize or scroll window in the "Project defaults" window is missing
  • Incorrect GUI changes when the "Table options" option is selected
  • The "Granular filter" editor drop down menu for selecting the name or schema is always empty
  • The “Could not connect to SSIS <server name>" message will popup when the user wants to connect to SQL Server for documenting the SSIS package
  • The "Database engine" option submenus should not be disabled until a datasource is selected
  • Incorrect details in a documented documentation for the "Current Compatibility Level" option
  • Some Latin characters are replaced with Chinese logograms when application is installed and used with the Chinese version of Windows OS
  • The application cannot document databases from a local server after trying to connect on a SQL Azure
  • The Table of Contents does not exist in the .doc and the .docx format
  • The "System.OutOfMemoryException" error is encountered when trying to edit a database with ~10,000 procedures in the "Extended property editor" window
  • The "System.OutOfMemoryException" error is encountered when documenting databases with a large number of stored procedures
  • The filetable information is missing in the doc/docx file format
  • The "The documentation can be incomplete" warning message is shown while compiling a document for a database with the unicode characters
  • The "Timeout expired. The timeout period elapsed prior to completion of the operation or the server is not responding" warning message is displayed after the application is hanging for 20 min in the Documenting state
  • The "Incorrect syntax near 'DDL_DATABASE_SECURITY_EVENTS'" error is encountered when documenting a database containing both the application and the database roles to the doc/docx formats
  • The "An entry with the same key already exists" error is encountered when documenting SQL Server 2000 database to the doc/docx file format
  • The "The surrogate pair (0xD952, 0xD952) is invalid." error is encountered when processing a database in the doc/docx file format
  • The "An entry already exists" error is encountered when documenting a specific database
  • The application is not releasing the RAM memory used for documenting after the documenting process is finished
  • There is no information in a generated documentation to the status of a created SQL Server login
  • The "Property cannot be updated or deleted" error is encountered when changing description for the Primary key objects
  • The "Destination patch check" dialog pops up every time when a documentation is created in the CLI
  • The "Permission to access the server" option in a created documentation is showing incorrect information for a SQL Server login
  • When refreshing the "Preview" option in the "Custom text" tab all text will be deleted
  • The "An exception occurred. The string was not recognized as a valid DateTime. An unknown word starting at index 0." error is encountered when generating documentation using the European date format
  • The "Parse Error: incorrect syntax near 'is'" error is encountered when the documentation is generated using the European date format
  • The "Object invalid. Extended properties are not permitted on 'dbo.', or the object does not exist" error is encountered when saving description in the "Extended property editor" dialog
  • Wrong spelling of the "List of stored procedures" subtitle of the stored procedure's "See also" section in the generated CHM documentation
  • Word wrapping in the documented .chm and .html file formats is not working
  • The "Extended property editor" window is not resizable and cannot be minimized or maximized

Changes:

  • The application has been split into three editions - Community, Standard and Professional

Known issues:

  • Extended property editor cannot be used on databases with more than 20,000 objects
  • The application cannot generate documentation in doc, docx, and pdf output formats for databases with more than 20,000 objects

Release:

2014.01.0253

Date:

May 29, 2013

Enhancements:

  • The application now fully supports SQL Server 2014
  • The application now fully supports SQL Server Integration Services 2014
  • The application is now compatible with Windows 64-bit operating systems

Fixes:

  • The "Project defaults" option is not saving options for the entire application
  • Missing tooltip description after the "Bitwise set" option
  • The "Connection managers" section in the main report pane indicates that "No item exists", even it is clearly visible after expanding the three in the left pane that these items exist in the package
  • The "System.NullReferenceException: Object reference not set to an instance of an object" error is encountered when documenting SQL Server Integration Service packages from the file system
  • The application cannot flush the RAM memory used during the documentation process after the documenting process is finished
  • The "Trial expired" warning can be avoided if already existing application project is opened
  • The "System.IO.IOException" error is encountered when using HTML as output file type
  • Clicking the first checked check box will uncheck all others check boxes for the server and database objects
  • The "Dependencies" tab from the "Project Defaults" option has a spelling mistake - "Dependecies"
  • The "Cancel" button from the "Output" dialog does not work when the date format is marked as invalid
  • The "About" form includes incorrect copyright year information
  • The "Date format" sample preview in the "Options" dialog is not shown when any value is inserted
  • Missing information box with an explanation of available data format entry in the "Options" dialog
  • The "Output" dialog titles are half-visible
  • The "Refresh" button clears preview area from the "Styles" tab
  • The "Ctrl + A" keyboard shortcut does not work for the "Comments" field in the "Options" dialog
  • The "Index was outside the bounds of the array" error is encountered when documenting specific database
  • The "Could not connect to SSIS Package Store" error is encountered when trying to connect to Integration services
  • The "Extended property editor" feature can be accessible after the initial trial period is expired
  • Temporary folders are not deleted automatically when documenting to html format
  • The "Styles" option preview does not utilize the user data from the "Options" dialog
  • The application hangs in documenting state with the "Include system objects" option selected and doc/docx output file type is chosen
  • The "Object reference not set to an instance of an object." error is encountered and process is terminated in case the database with reference to missed objects is documented in any of doc/docx formats
  • The "An object or column name is missing or empty." parse error is encountered when documenting specific database
  • Documenting in .docx format is not possible on SQL Server 2012 for the specific databases
  • The "Out of memory" error is encountered after generating the documentation for the database which contains Unicode characters
  • The "Out of memory" error is encountered when documenting result exceeds 4000 pages in .docx format
  • The "Out of memory" error is encountered when creating the documentation for multiple large databases at once
  • Database with Unicode characters in the name cannot be documented in CHM format
  • The "Out Of Memory" error is encountered when documenting large database from remote SQL Server in doc/docx format
  • MS Office 2010 warns about unsecure contents and blocks editing of generated .doc file
  • The "At least one package should be specified" error is encountered when documenting Integration Service packages from various sources
  • Superfluous [] characters in the "Event notification" title
  • The "Warnings: Some packages cannot be loaded in whole or in part without valid credentials" error is encountered when documenting SQL Server Integration Services package(s) 2012
  • The "Craniate ERM Diagram ‘Component Licensing'" error is encountered when the "Graphical dependencies" option are selected

Changes:

  • New user interface that follows Metro UI style
  • The application now requires Microsoft .NET framework 4.0
  • Windows XP is no longer supported

Release:

2013.02.0238

Date:

July 5, 2013

Fixes:

  • The "System.IO.FileNotFoundException" error is encountered when creating a new project if .NET Framework 4.0 is installed in the system

Release:

2013.01.0237

Date:

May 7, 2013

Enhancements:

  • A tool-tip has been added to the "Date format" option in the "File output" section of the "Output" tab of the "Options" dialog in order to clarify that time can be formatted using the "Date format" option as well as to stress that the date format is case sensitive

Fixes:

  • The "Some packages cannot be loaded wholly or in part without valid credential" message is displayed shown when attempting to document SSIS packages
  • The "NotEnoughRightsException" error is encountered when attempting to document a database and the login used to authenticate to the SQL instance where the database resides isn't a member of the db_owner or sysadmin SQL roles
  • The "The program encountered a problem. We are sorry for the inconvenience" error is encountered when attempting to document SSIS packages
  • The application log files aren't created
  • The encrypted packages cannot be fully loaded even when using valid credentials
  • The CHM file topics containing SQL objects' documentation are sorted incorrectly in the Content tab of the generated CHM document
  • The SQL objects listed in the "Objects that depend on" section of the documentation are sorted differently in DOCX and CHM generated documentation
  • Encrypted objects are missing from the generated DOC and DOCX documentation
  • The "Statistics structure and age" section is missing from the generated DOCX documentation
  • The columns listed in the "Datatypes" section of the generated DOCX documentation are sorted in a descending instead of an ascending order
  • An incorrect icon is used for SQL Server role objects in the generated DOC and DOCX documentation
  • SQL sequences are documented differently in the generated DOC and DOCX documentation and the entire "Sequence properties" section is missing from them
  • Links to the "Backup devices", "Server roles" and "Server info" sections of the generated DOC and DOCX documentation are missing from the "See also" section
  • The values for the owner and creation date properties of SQL search property lists are missing from the generated DOC documentation
  • An incorrect value is shown for the type property of SQL jobs in the "Job properties section" of the generated DOCX documentation if the target SQL instance of the documented SQL jobs is unavailable
  • The application becomes non-responsive while documenting SQL stoplists
  • The name of the SQL instance saved in the project persists in the "SQL Servers" list located on the "Select databases for documenting" page, although a different SQL Server has been selected
  • The text in text fields in the "File format", "Styles" and "Naming" pages of the "Output options" section of the project dialog cannot be selected using triple-click or the Ctrl+A keyboard shortcut
  • The "Add" button on the "Add integration service packages" dialog is not fully visible
  • Graphical dependencies for SQL sequences are missing from the CHM documentation created using the CLI
  • The uninstallation process can be started while the application is still running resulting in an incomplete uninstallation
  • The tooltip for the "Extended properties" icon in the Main grid is missing
  • The "Close project", "Save" and "Save project as" options don't appear in the Quick access toolbar until a project is opened
  • The text in the error "Unknown error has occur" is spelled incorrectly
  • Only the major version of the application is shown in the Version column of the Add/Remove programs in the Windows Control Panel
  • If only SQL services are to be documented, information about the related SQL queue and SQL contract is missing from the generated Help 2.x documentation
  • The non-default color scheme is not applied to the left menu
  • The icons used to represent the commands for adding database engines in the menu and on the "Select databases for documenting" page are different
  • The number of selected databases and packages is not updated in the application's status bar when packages and databases are checked using the Space bar
  • The "Edit" button in the "Select packages for documenting" page is enabled even if no packages are selected
  • The values for "Data space in use and reserved for use", "Index space and usage", and "Allocated and unused space", in the "Database information section" are different in the generated DOCX and CHM documentation for the same database; the values for "Containment", "File stream non-transacted access level" and "File stream directory name" are missing from the generated DOCX documentation
  • The text in the message "Some packages cannot be loaded in wholly or in part without valid credentials", which appears when attempting to document unsupported SSIS packages, is spelled incorrectly
  • The title of the "Recent projects" item located in the Quick access list is spelled incorrectly
  • The items "Create a new project", "Open existing project" and "Save project as… " located in the Quick access list don't have tool-tips
  • The title of the topics documenting schemas in the generated DOCX and CHM documentation are different
  • The options located under the "DDL options" and "Miscellaneous" sections of the "Performance intensive options" page are not visible if the application window is at minimal window height
  • The link to the "Server index" section of the generated CHM and Help 2.x documentation is missing from the "About this documentation" section
  • The "Compilation error" error is encountered when generating Help 2.x documentation for SQL Server Integration Services Packages
  • Objects cannot be selected or deselected using the Space bar in the "Object filter grid"
  • The wrong SQL Server version (2011 instead of 2012) is shown in the "Object index" title of the "Objects by type" documentation topic
  • SQL Columnstore indexes are not documented correctly in the generated CHM documentation
  • The "Save changes dialog" is shown when closing a project immediately after it was opened, although no changes have been made
  • The size of the SQL stored procedure parameters is documented incorrectly
  • The "Description" section for primary keys is missing from the generated CHM documentation
  • The "Parse error: [Incorrect syntax near 'DESC']" error is encountered when documenting a database with non-clustered indexes containing an INCLUDE clause
  • The dependency graph only shows the SQL objects selected for documentation and the SQL objects which depend directly on them
  • 'Parse error: incorrect syntax' error is shown and the process is terminated when documenting a database which contains objects with Unicode characters in their names
  • "Some packages cannot be loaded wholly or in part without valid credentials" warning message is displayed when generating documentation for SSIS package file with no password set

Release:

2012.01.0232

Date:

June 20, 2012

Enhancements:

  • SQL Server Integration Services 2012 Packages can now be documented
  • The following SQL Server 2012 object types can now be documented in DOC/DOCX format:
    • Sequences
    • Search property lists
  • Usability improvement – Object types sorting in the 'Database objects' filter can now be reset to default by holding the Ctrl key and left-clicking on the 'Object type' column

Fixes:

  • Start menu Help file shortcut opens ApexSQL Doc 2008 online help documentation
  • "Failed to run hh.exe" error message is encountered when generating documentation for a database containing long View object names
  • Online help documentation is opened upon help request even when local CHM help documentation file is present in the application installation folder
  • Non-documented Logins are hyperlinked in User Properties documentation section
  • '{date}' tag is converted to 'MM/dd/yyyy' text instead of actual date when specified in file or documentation name templates
  • Application remains open after answering Yes to 'Save changes to project?' question displayed following an action to close the application
  • Project management dialog is not shown after answering Yes to 'Save changes to project?' question displayed following an action to open another project
  • 'Save changes to project?' question is displayed for project that hasn't changed following an action to open another project or to close the application
  • Extended properties are included in the SQL section of generated document when 'Include extended properties' setting is OFF
  • 'Type of Secondary XML Index' and 'Primary XML Index' Index properties are not documented when 'Explicitly parse the database for improved dependency accuracy' setting is OFF
  • "Cannot open database <database name> requested by the login. The login failed. Login failed for user <user name>" error message is encountered following an action to document an offline database
  • Fixed length nvarchar Procedure parameter size is documented with half the actual size for SQL Server 2000 databases
  • Database 'Torn Page Detection' setting is not documented in DOCX format as checked when the setting is ON
  • Servers under Server Index section of SQL Servers are sorted in descending order when documenting in DOC format
  • 'Maximum File Size' column is too narrow in Data Files and Transaction Log Files sections on Database overview page when documented in DOC/DOCX format
  • Trigger name in Triggers section for Tables is missing Trigger schema when documented in DOC/DOCX format
  • 'Objects that depend on <trigger>' and 'Objects that <trigger> depends on' sections do not include schema name of the Trigger when documented in DOC/DOCX format
  • Command section of Job step is not documented in DOC/DOCX format when 'Include data definition language (DDL) script' setting is OFF
  • Datatype is displayed as Type in the Objects section for User when documented in DOC/DOCX format
  • SQL script syntax is not highlighted in the Command section of Job step when documented in DOC/DOCX format
  • Schedule section is preceded by a calendar icon when documented in DOC/DOCX format
  • Procedure Column Level Dependencies section is missing when documenting in DOC/DOCX format
  • 'DescendentsHelp' option of 'Graphical dependency type' (gdt) CLI switch doesn't have correct description 'show the object and all descendants including children and grandchildren in the dependency graph'

Known limitations:

  • The application has to be started with administrative privileges to document SSIS 2012 packages

Release:

2011.01.0229

Date:

December 16, 2011

Enhancements:

  • SQL Server Denali databases can now be documented
  • Application now documents the following new SQL Server Denali/2012 object types:
    • Sequences
    • Search Property Lists
    • File Tables
  • Tooltips have been implemented for all output options
  • Graphical dependencies have been improved to include the following object types:
    • Users
    • Rules
    • Schemas
    • Asymmetric Keys
    • Symmetric Keys
    • Certificates
    • Fulltext Stoplists
  • Dependencies are now identified with higher accuracy when 'Explicitly parse database for improved dependency accuracy' option is OFF
  • Additional columns have been introduced for Table indexes in 'Compiled HTML Help file (.chm)': 'Description' and 'Size KB'
  • The following new switches have been added to CLI:
    • /seo [/sequence_options] – Specifies Sequence documenting options
    • /splo [/search_property_list_options] – Specifies Search Property List documentingoptions

Fixes:

  • Hyperlinks to excluded or non-existing and hidden object types may be created in 'See also' sections in 'Compiled HTML Help file (.chm)' format
  • Extra columns may be added to nonclustered index DDLs when 'Explicitly parse database for improved dependency accuracy' option is ON
  • 'Server Info' hyperlink is created in 'See also' sections in 'Compiled HTML Help file (.chm)' format when 'Document server properties' option is OFF
  • System Services are documented when 'Include system objects' option is OFF
  • Server objects are documented in 'Word document 97-2003 (.doc)' and 'Word document 2007 (.docx)' formats when 'Document server properties' option is OFF
  • 'Database Overview' hyperlink is created in 'See also' sections in 'Compiled HTML Help file (.chm)' format when 'Include database summary information' option is OFF
  • Application roles are not shown in database object filter
  • Filtered out objects remain unchecked on database object filter after the respective filter is removed
  • Empty filters can be created for server and database objects on respective object filters
  • 'Check All' command may check not all objects on server object filter depending on the invocation
  • Unchecked objects become checked when cancelling changes to an existing filter on database object filter
  • Fulltext Stoplist selection is not saved into a newly created project the 1st time it is saved
  • Objects cannot be checked/unchecked with <space> on database object filter
  • Progress is not reported in CLI when documenting in 'Word document 97-2003 (.doc)' and 'Word document 2007 (.docx)' formats
  • Progress is reported incorrectly when documenting in 'Word document 97-2003 (.doc)' and 'Word document 2007 (.docx)' formats
  • {objectname} custom text tag expands to full path for SSIS packages when documenting in 'Compiled HTML Help file (.chm)' format
  • Last opened project is not opened at start up when 'Show last opened project' is selected as startup action
  • Startup action changes from 'Show last opened project' to 'None' after an existing project is opened
  • 'Maximum Length' property value is documented doubled for NCHAR and NVARCHAR-based User Defined Data Types
  • Database status is always documented as 'Unknown'
  • 'Column Level Dependencies' section is missing for Triggers in 'Word document 97-2003 (.doc)' and 'Word document 2007 (.docx)' formats
  • 'Triggers' section is missing for Tables in 'Compiled HTML Help file (.chm)' format
  • 'Index Statistics Structure and Age' section is always empty in 'Word document 97-2003 (.doc)' and 'Word document 2007 (.docx)' formats
  • 'Objects that depends on' section is not alpha ordered for Triggers in 'Compiled HTML Help file (.chm)' format
  • 'Change Tracking' property value is documented as 'A' vs 'AUTO' for fulltext indexes in 'Word document 97-2003 (.doc)' and 'Word document 2007 (.docx)' formats
  • 'Index Columns' section is missing for fulltext indexes in 'Word document 97-2003 (.doc)' and 'Word document 2007 (.docx)' formats
  • "Specified cast is not valid" error is encountered when documenting SQL Server 2000 database in 'Word document 97-2003 (.doc)' and 'Word document 2007 (.docx)' formats with 'Statistical data analysis' option ON
  • An extension is always appended to the output file name in CLI when documenting in 'Word document 97-2003 (.doc)' and 'Word document 2007 (.docx)' formats
  • Date format is not applied to generated documentation in 'Word document 97-2003 (.doc)' and 'Word document 2007 (.docx)' formats
  • 'Description' and 'Size KB' columns are missing from 'Indexes' section for Tables in 'Compiled HTML Help file (.chm)' format
  • Index names with unallowed characters are not enclosed in brackets in page titles
  • Table names with unallowed characters are not enclosed in brackets in 'See also' sections
  • 'Precedence Constraints' section generated for SSIS packages is not alpha ordered
  • System.ComponentModel.Win32Exception exception is encountered when documenting more than 100 SSIS packages simultaneously
  • Unworkable hyperlinks to User Defined Data Types are created for Defaults in 'Help 2.x file (.hxs)' format
  • Empty document is created in CLI if output file name is specified with '.chm' extension
  • Application doesn't prompt to save changes in the currently opened project when creating a new one after documentation in 'Word document 97-2003 (.doc)' or 'Word document 2007 (.docx)' format has been generated
  • Application doesn't prompt to save changes in the currently opened project when creating a new one if it has been modified
  • Creation date is put without time in generated documentation in 'Compiled HTML Help file (.chm)' format
  • Line breaks are not inserted in user comments in generated documentation in 'Compiled HTML Help file (.chm)' format
  • Copyright hyperlink does not open in generated documentation when specified without the "http://" prefix
  • Custom text tags may be either expanded incorrectly or partly ignored depending on the combination

Known limitations:

  • Extended property editor cannot be used on databases with more than 20,000 objects
  • Documenting Stored Procedures that indirectly/through another Stored Procedure or Function call replication system Stored Procedures with 'Include Documentation of Procedure/Function Result Sets' option ON may result in replication jobs not functioning properly
  • SSIS Denali/2012 packages cannot be documented

Release:

2010.01.0228

Date:

April 11, 2011

Enhancements:

  • Application now supports 2 new output formats:
    • Word document 97-2003 (.doc)
    • Word document 2007 (.docx)
  • Encrypted SQL Server 2005/2008 objects can now be decrypted and documented (requires membership in the sysadmin server role)
  • Fulltext Stoplists can now be documented
  • SSIS Packages resided in SQL Server 2008R2 can now be documented
  • Extended properties on databases are now get documented
  • New VS 2010 style is now available for HTML-based output formats and set by default in all new projects
  • Custom text edit boxes now offer HTML syntax highlighting and auto completion of HTML tags
  • New Office 2007 style interface with ribbon bar, quick access toolbar, and ApexSQL Doc button has been introduced
  • New Resources ribbon bar has been introduced for quick access to Help page, Support forum, Training page, FAQs, Knowledge base, Troubleshooting, Contact and Get Updates dialog boxes
  • New standard Project Management dialog has been introduced
  • Project Management dialog now shows recently used projects or projects stored in any folder of choice
  • Projects can be Pinned/Un-Pined to Recent Projects list on Project Management dialog
  • Project description can be edited directly from Project Management dialog
  • 'Show on Startup' option has been added to Project Management dialog box
  • Startup Action options group has been added to Options dialog to control Project Management dialog behavior. Available choices are 'Show Project Management dialog', 'Show last opened project' and 'None'
  • Project Defaults can now be defined for newly created projects
  • Project options can now be saved as current user defaults settings
  • Project options can now be reset either to current user or to ApexSQL defaults
  • Each project option has now an associated tooltip with description
  • New Object Filter Editor allows to filter objects based on 'Exclude if' or 'Include if' conditions
  • New Object Filter Editor can use the following comparison operators: 'Equal', 'Not Equal', 'Between', 'Not between', 'Contains', 'Not contains', 'Begins with', 'Ends with', 'Any of' and 'None of' and the following logical operators: 'And', 'And not', 'Or' and 'Or not'
  • Main window status bar has been redesigned and now shows numbers of selected databases and SSIS packages and output format
  • New tooltip balloons have been added to data source bars of main window status bar
  • Options dialog has been redesigned with new Office 2007 button bar
  • Application can now be presented in 3 color schemes: Blue, Silver and Black
  • The following connection options have been added to Add/Edit SQL Server dialog: 'Execution timeout' and 'Encrypt connection'
  • The following new switches have been added to CLI:
    • /fso [/ft_stoplist_options] - Specifies Fulltext Stoplist documenting options

Fixes:

  • System.OutOfMemoryException exception is encountered when editing extended properties of a database with more than 10,000 objects
  • System.OutOfMemoryException exception is encountered when documenting databases with more than 10,000 objects
  • Crainiate.ERM4.Layouts.GraphException exception is encountered when cancelling documenting if 'Graphical Dependencies' option is ON
  • Objects are not alphabetically ordered in the 'Objects that depend on' section of User Defined Data Types
  • Package source doesn't get documented for packages located in SSIS Package Store 2008 or SQL Server 2008
  • Maintenance plan SSIS packages located in SSIS Package Store 2008 don't get documented
  • 'Run As' Job step property is always empty in generated documentation
  • DDL Triggers don't have 'Graphical Dependencies' section
  • SSIS packages store 2005 and 2008 cannot be documented simultaneously if they have the same name
  • Carriage returns are not preserved when documenting SQL Statement Source property of SSIS package
  • Non-schema bound objects get shown under 'Objects By Schema' node in table of contents of generated documentation
  • Documentation generated with 'Show Nodes for Object Types that don't Exist in Documented Database' option ON contains links to non-existing object types in 'See Also' sections
  • Ctrl+C doesn't terminate ApexSQLDoc.exe process in CLI
  • 'Relationship' sub-node doesn't get shown under Table nodes under 'Objects By Schema' node in table of contents of generated documentation
  • For documenting databases from CLI membership in the db_owner database role is required
  • PAGE LOCK and ROW LOCK attributes of Primary Keys aren't shown as part of DDLs in 'SQL' section in generated documentation
  • Table referenced in ENABLE TRIGGER statement in stored procedure isn't shown in 'Objects that depend on' section in generated documentation
  • Table referenced in DROP STATISTICS statement in stored procedure isn't shown in 'Objects that depend on' section in generated documentation

Changes:

  • Copyright settings have been moved to Application options
  • Default Intermediary Files Location has been changed to \Users\<user name>\AppData\Local\ApexSQL\ApexSQLDoc2010\Intermediary
  • Regular Help button has been replaced with question mark button in title bar on all dialogs and windows
  • Custom Tags Converter has been removed
  • 'Document Only Checked Databases' and 'Document All Databases Except Checked' options have been removed
  • The following deprecated CLI switches have been removed:
    • /s [/server],
    • /d [/database],
    • /u [/user],
    • /p [/password],

Known limitations:

  • Extended property editor cannot be used on databases with more than 20,000 objects
  • Documenting stored procedures that indirectly/through another stored procedure or function call replication system stored procedures with 'Include Documentation of Procedure/Function Result Sets' option ON may result in replication jobs not functioning properly

Release:

2008.08.0226

Date:

October 5, 2009

Enhancements:

  • The following CLI switches now accept IP addresses (surrounded with square brackets) in addition to data source names: /server, /database_engines, /integration_service_packages, /sql_server_packages
  • Modules section of assembly documentation now show assembly methods along with where they're usage

Fixes:

  • System.OutOfMemoryException exception is thrown when documenting large databases (thousands of objects)
  • UserBreakedProcessException exception is thrown on attempt to save project after documentation process is cancelled
  • Variables in SSIS packages are not documented
  • Toolbar contents disappear after pressing Reset button in the Customize (toolbar) dialog
  • Public server role is not shown on Object Filter step nor is it documented
  • SSIS packages comparison engine exception is thrown on attempt to document SSIS packages without Integration Services 2005 installed locally
  • Deleted SSIS packages are recognized as Password Protected on Package Selection pane
  • /exclude_integration_services_packages CLI switch does not exclude specified SSIS packages from the documentation
  • /integration_services_packages CLI switch does not allow to document several packages at once
  • System.FormatException exception is thrown when documenting SSIS package with a single Data Flow Task
  • "Account <name> is not db_owner for selected database" warning message appears twice when applicable for each database selected for documenting
  • "Critical error occurred when loading database metadata" error is thrown on attempt to document database under not db_owner account
  • It's impossible to connect to SSIS packages Store of locally installed Integration Services 2008
  • Reference to non-existing foreign key is shown as a link in table documentation
  • "Deprecated switch" message is displayed when a wrong value is specified for /server_object_types CLI switch (wrong message)
  • Objects get deselected on Object Filter step after selection profile export
  • Application does not remember location of last saved project
  • Application does not allow entering password for password protected SSIS packages
  • Servers are not sorted properly in SQL Server connection dialog shown for Integration Services
  • Users do not appear as Login references in generated documentation
  • Link to the user-defined datatype used in procedure parameters goes to non-existing page when documentation is made in HTML format
  • Embedded CrLf is not documented for Execute SQL Task item of SSIS packages affecting overall look of SQL statements contained in this source
  • Only first dependencies level is shown for views and procedures in graphical dependencies diagrams
  • SQL Server alerts in French language are not documented
  • Application documents dependencies on built-in SQL Server functions (it shouldn't)

Changes:

  • "SSIS Package Store" package location is now divided into "SSIS Package Store (SQL Server 2005)" and "SSIS Package Store (SQL Server 2008)"
  • /integration_services_packages CLI switch format was changed to service1[:SQL2005|SQL2008].package1.package2...packageN[:password]
  • /exclude_integration_services_packages CLI switch format was changed. Its format is now service1[:SQL2005|SQL2008].package1.package2...packageN

Release:

2008.07.0225

Date:

April 13, 2009

Enhancements:

  • It is possible to document SSIS 2008 packages now

Fixes:

  • In case of documenting SSIS 2008 packages when there is no SSIS 2008 installed appropriate prerequisite information is shown to user now

Changes:

  • Offline help file is no longer provided and ApexSQL Doc will now directly access online help from the default system browser

Known limitations:

  • Decrypting of encrypted objects not supported for MSSQL2005 objects
  • CHM topic cannot display Unicode characters (only English characters will be displayed correctly in CHM topic)

Release:

2008.06.0222

Date:

December 11, 2008

Enhancements:

  • Added user friendly form with information of software pre-requisites and required Components not included with Installation

Fixes:

  • Exception when trying to connect to SSIS on machine where SSIS are not installed
  • CHM compiler stopped work because of long lines in binary fields in package were documented
  • /tse switch doesn't exclude selected server objects in the loaded profile
  • IP address is parsed incorrectly in switches where dot is used
  • Exception when change "Extended Property name" in the Extended property editor
  • /pr switch doesn't get user/login from /u and /p
  • SSIS MSDB folder names with . are processed incorrectly

Known limitations:

  • Decrypting of encrypted objects not supported for MSSQL2005 objects
  • CHM topic cannot display Unicode characters (only English characters will be displayed correctly in CHM topic)

Release:

2008.05.0220

Date:

September 19, 2008

Enhancements:

  • Added new CLI switch /intermediary_files_keep (/ifk). With this switch you can tell application to keep intermediate files
  • "Add Folder" option in Add Integration Service Packages dialog will now add packages from selected folder and all subfolders

Fixes:

  • Package names used in /isps, /pfs, /ssp switches are case sensitive
  • Precision, Length, Scale properties from Datatypes are empty
  • MS SQL 2008 filtered indexes are not showing Filter Definition property correctly
  • Stop work when is switching to Extended Properties login dialog by Alt-Tab from another application
  • Stop work on application exit from main menu
  • "Store encrypted password" is not saved in SSIS SQL Server dialog
  • Tree view is not updated after project is loaded
  • Name is not displayed for 2005 version projects in the projects grid
  • Fields shown in the existing projects grid are not default
  • System.ArgumentException exception when documenting AdventureWork2008 database
  • Hierarchyid is incorrectly documented as [sys].[hierarchyid] or [database].[sys].[hierarchyid]
  • UDT name is incorrectly shown in column section for dependent UDT
  • Different login form is shown when reconnecting to another server or db from extended property editor
  • Both extended property editor and custom tags converter do not remember last opened database
  • Password column querying is removed during Login documentation
  • Extended properties aren't displayed for indexes in DDL section
  • Application folder is used for intermediary files if non-existent path is specified
  • Incorrect options field description
  • Apply button does not enable even with changes to the intermediary folder
  • Add Folder feature adds packages only from the last subfolder
  • Package validation problem
  • There is no vertical scroll bar at Package Selection panel
  • 120 dpi problem
  • Error may occur on machine w/o Integration Services installed
  • Non-standard symbols for alerts are displayed incorrectly
  • Server connections Settings for previous projects saved for new one
  • UI updates to login form of extended property dialog
  • Assigned server roles aren't hyperlinked on login pages of generated documentation
  • Dependencies for/on credentials aren't reported
  • "Intermediary files folder" option behavior differs between GUI and CLI
  • There's no CLI switch to control intermediary files deleting/retaining
  • Intermediary folders aren't/may not be deleted with corresponding option on
  • Selection profiles are exported incorrectly for a type all objects
  • Stop working when the project is opened in another instance
  • Incorrect default folder in open project dialog
  • Clear button caption has navy font color
  • Server name in status bar and Data Sources tree view are not updated
  • Graphical dependencies show wrong objects
  • Extended Property Editor doesn't work on AdventureWorks2008 DB
  • CHM compiler must stop working when documenting some databases
  • Exception on machine with Integration Server installed
  • Incorrect child dependencies may be documented for triggers
  • Parser exceptions are/may be handled incorrectly
  • Assigned server roles aren't hyper linked on login pages in generated docs
  • Certificate dependencies are/may not be reported with respective option enabled
  • Problem with loading previously saved projects loading
  • Pressing Defaults in Options dialog sets new Help 2 Settings
  • Links in dependencies sections for AdvetureWorks db are not displayed
  • /essp switch - superfluous description
  • /i switch without /dbes or /s /d switches generates empty CHM without name
  • /tse switch doesn't work as exclude for objects from loaded profile
  • /sync switch works improperly

Changes:

  • Default folder for project saving/opening is changed to MyDocuments/ApexSQL/ApexSQLDoc2008
  • Default documenting folder is changed to MyDocuments/ApexSQL/ApexSQLDoc2008
  • Default intermediary folder is changed to MyDocuments/ApexSQL/ApexSQLDoc2008/Intermediary
  • Changing Intermediary files location in Options form will not automatically create folder. Specified folder must exist
  • Usage for CLI switch /essp has changed. This switch is now used like this: server[.user[.password]]:package1.package2

Known limitations:

  • Decrypting of encrypted objects not supported for MSSQL2005 objects
  • CHM topic cannot display Unicode characters (only English characters will be displayed correctly in CHM topic)

Release:

2008.04.0219

Date:

September 17, 2008

Enhancements:

  • New MSSQL2008 support
    • Geography, geometry and filtered indexes are detected and documented
    • Table types are detected and documented
    • improved Fulltext indexes are detected and documented. They contain FullText stoplist name and documented ddl supports mssql2008
    • IsReadOnly property of Function parameters is detected and documented
    • New date/time types are documented
    • IsSPARSE property is documented for columns
    • OrderColumns property added to functions
  • New custom tags converter tool. This tool can be used to convert old SUMMARY, PARAM custom tags to extended properties
  • Added new CLI switch /intermediary_files_location (/ifl) that specifies location used for intermediary files storing

Fixes:

  • Problem with documenting stored procedures interacting with linked servers
  • Tree nodes for Variables in SSIS package documentation are always empty
  • Rules, certificates, symmetric and asymmetric keys, and roles aren't shown in the Extended Property Editor
  • Windows logins are scripted with syntax errors if the default language of SQL login is not specified; application may throw an exception during documentation
  • /tse command line switch doesn't invert object selection for objects specified in /sync switch
  • Databases that have long object names cannot be documented in HTML output format
  • "Stop working" may appear after opening the existing project
  • Project default path in the file open dialog is not standard
  • Edit SQL Server dialog has wrong caption
  • SSIS Packages selection panel may not appear after connecting to SQL Server
  • Database documentation page doesn't have Description column and doesn't display its extended properties
  • Existing column filters aren't applied to a newly selected database in the Extended properties editor
  • User type's extended properties are not updated under MS SQL 2005
  • Incorrect icon may be used for package files in generated documentation
  • Not all packages from SSIS/MSSQL data source may be loaded/shown
  • Unnecessary message is shown when documentation is cancelled
  • Command line interface has problems with documenting packages from SSIS/MSSQL: empty documents generated
  • Extended properties under MSSQL2005 cannot be updated
  • Problem with SQL Server selection for documenting SSIS requires application restart
  • Warnings details do not show all password protected packages
  • Command line mode doesn't display any message for password protected packages
  • System.IO.DirectoryNotFoundException exception may be thrown if Intermediary folder location does not exist
  • Trusted connection is used in the Command Line mode even if user and password are specified
  • System services are/may be shown in services object filter with "Include system objects" option turned off
  • Double-clicking an .axpd file does not open it in ApexSQL Doc even if the file extension has been assigned to ApexSQL Doc
  • /d cli switch in combination with /pr switch does not work; /d switch ignored

Changes:

  • Roles listed in 'Roles with this login' section now directly link to their corresponding Roles section
  • CLI switches /s, /d, /p, /u will be removed in next versions. Please use /dbes instead

Known limitations:

  • Decrypting of encrypted objects not supported for MSSQL2005 objects
  • CHM topic cannot display Unicode characters (only English characters will be displayed correctly in CHM topic)

Release:

2008.03.0216

Date:

July 14, 2008

Changes:

  • Intermediary folder location can be customized in options

Known limitations:

  • Decrypting of encrypted objects not supported for MSSQL2005 objects
  • CHM topic cannot display Unicode characters (only English characters will be displayed correctly in CHM topic)

Release:

2008.02.0215

Date:

July 01, 2008

Fixes:

  • Generated document does not contain description for Job object
  • When server login is changed while app is running, clicking Details in the Warning dialog shows as empty
  • When 'Include system objects' is ON, 'NullReference' exception is encountered during documentation
  • Incorrect importing of Object filter
  • Incorrect loading of ApexSQLDoc 2005 projects
  • LocaleID in package properties shows ID instead of Description
  • Invalid dialog shown when adding SSIS package store as data source
  • Last file path used when opening projects is not remembered; default file path is used instead
  • Content of the Intermediary folder is removed even if the option "Delete CHM Intermediary Files" is OFF
  • Application stops working when an Integration Service data source is added and Integration Service is not installed on the machine
  • Errors encountered during the documentation process when app is installed on a Vista machine
  • Missing Description section in User page of generated document
  • Incorrect caption text for Credentials in documentation
  • Incorrect alignment of Database description in Extended Property Editor (120 dpi mode)

Changes:

  • If long folder paths are used when output type is HTML, 'Output folder too long...' warning is displayed
  • Temporary folder used during documentation changed from application folder to My Documents\ApexSQL\ApexSQLDoc\Intermediary
  • Description column is removed in generated documentation for FullText Catalogs, Asymmetric Keys, Certificates, Symmetric Keys as Extended Property is not defined for these objects
  • Added Description column to documentations list of Databases

Known limitations:

  • Decrypting of encrypted objects not supported for MSSQL2005 objects
  • CHM topic cannot display Unicode characters (only English characters will be displayed correctly in CHM topic)

Release:

2008.01.0214

Date:

June 12, 2008

Enhancements:

  • Up to 400% faster documentation than previous version
  • New user interface that includes easier-to-use Project Dialog
  • New Extended Property Editor (Tools | Extended Property Editor)
  • New Data Sources step in wizard for managing multiple data sources and database/package selections
  • Documents multiple databases from multiple servers at the same time (for both MSSQL2005 and MSSQL2000)
  • Documents multiple SSIS Packages located in multiple locations (SQL Server, SSIS Package Store, and File system) at the same time
  • Documents SSIS Packages that are encrypted with a password
  • Extended support for assemblies; ability to document CLR name property, binary code, files and modules lists
  • Now documents server object types: backup devices, linked servers, server roles
  • Now documents MSSQL2005 database object types: asymmetric keys, certificates, symmetric keys
  • Ability to include or exclude system objects in database documentation
  • Ability to customize which server objects to document
  • Ability to preview documentation format and custom text
  • Job topic in generated documentation now has Schedules and Steps subtopics with corresponding Job Schedule and Job Step pages
  • Improved dependency detection for the following objects:
    • Users, schemas and roles
    • Xml Schema Collection
    • Services
    • Event Notifications
    • Routes
  • Maximum limit of 10 levels for dependency detection removed
  • Improved navigation using new wizard nodes: Dependency options, Database options, Performance Intensive Options, and Integration Service Options
  • New CLI switches:
    • /database_engines (/dbes)
    • /integration_services_packages (/isps)
    • /package_files (/pfs)
    • /exclude_database_engines (/edbes)
    • /exclude_integration_services_packages (/eisps)
    • /server_object_types (/so)
    • /server_include (/sinc)
    • /server_exclude (/sexc)
    • /ssis_details (/isd)
    • /asymmetric_key_options (/ako)
    • /certificate_options (/cko)
    • /symmetric_key_options (/sko)
  • Cross database dependencies are now detected and documented
  • Dependencies are now detected when DATEADD, DATEDIFF, DATENAME, DATEPART functions are used
  • Dependencies are now detected in CONVERT function and OVER clause
  • Cross database dependencies for column-level dependencies are now detected and documented

Fixes:

  • Permissions for MSSQL2005 object types (Assemblies, remote service bindings ...) not detected and documented in Permission sections of users and roles
  • Column-level dependencies not accurately detected for tables and views
  • Dependencies are not found when EXCEPT and INTERSECT are used in DDL script for some database objects
  • Application stops responding if huge databases are documented
  • If server has Collation code 'Compatibility_50_409_0' (database Intranet)', exception is thrown during documentation
  • If database object has large number of dependencies, graphical dependencies are not created
  • Creating CHM documentation fails when two or more languages are used in object types chosen for document
  • If Job step and Job schedule have the same name, link to Job Schedule does not open correct page in document
  • CHM documentation has invalid/missing window caption when language used by OS is English
  • DDL for MSSQL2005 Logins is documented incorrectly
  • There's a long delay when cancelling documenting process
  • Clearing Date Format in Options | General shows both date and time instead of date only
  • 'Do you want to save changes' prompt is not shown when application is closed and project is modified
  • Role permissions section in documented Role does not contain permissions for assemblies
  • User permissions section in documented User does not contain permissions for assemblies and remote service bindings
  • 'Users with this login' section in Login section of generated document populated incorrectly
  • 'Roles with this login' section in Login section of generated document populated incorrectly
  • Relations between Assemblies and datatypes are not shown in dependency graphics
  • Technical comments if object name contains certain set of characters ('/*') are incorrectly documented
  • Dependencies to user 'dbo' are not found
  • Service is not detected as dependency for Route
  • Dependencies are not correctly detected when sp_addtype is user for @owner parameter
  • Column dependencies not detected when WHERE FREETEXT and WHERE CONTAINS are used in DDL of database objects
  • Column dependencies not detected when ALTER COLUMN is used in DDL of database objects
  • Some column dependencies are not noted for triggers
  • Dependencies were not detected correctly if different database objects had same names

Changes:

  • DDL Trigger now has 'Implementation Type' property in DDL Trigger Properties section in generated documentation
  • Added Totals information to schema object collection and referencing/referenced tables section in documentation
  • Added compile timeout option to Options dialog | General. This option is related to compilation time when compiling to CHM
  • Added Clear button beside Maximum Items Shown in File Menu in Options dialog | General. Clear button will clear recent projects list
  • Role Properties section is added to documented Roles containing some general properties of Role
  • All CLI switches related to custom tags are removed (/tagged_comments, /tc, /tagged_comments_files, /tcf)
  • Custom tags option is removed; application does not use custom tags anymore
  • Custom tags section in generated documentation is removed
  • Copyright tab moved from Tools | Options to wizard step Output | Copyright; information is now project specific
  • Connection timeout option moved from Tools | Options | General Options to Connection dialog (dialog that is shown when connecting to database engine)
  • Cancel button replaced by Close button which closes currently open project
  • Options section in wizard is removed
  • Formatting, Custom Text, and Naming options are now moved to Output wizard step
  • Optional Items are moved to Database Options wizard step under Database Information step and are shown only when database engine is chosen for documenting
  • Graphical Dependencies options are moved to Dependency Options under Database information step in wizard
  • Extended properties options are moved to Database Options wizard step under Database Information step in wizard
  • 'Prompt to Save changes Event' section in Options | General is removed
  • Help 2 tab in Options renamed to Help 2.0. Small description on Help 2.0 format is added to Help 2.0 tab in Options dialog
  • Tagged Comments tab is removed from Options dialog
  • Buttons in options dialog are now positioned vertically on the right side of dialog instead of placed on the bottom of dialog
  • "Step x of y" and progress meter removed from status bar
  • Status bar now shows current Project name and list of all data sources included in project instead of just one server and its database selections
  • Login wizard step is replaced with Data Sources step where you can manipulate data sources
  • Choose Action wizard step is removed; projects are now created and opened using new Project dialog
  • Database selections wizard step is removed; databases can be selected under new Data Sources wizard step
  • Database Details wizard step is removed; all options are moved to Database Options wizard step
  • Description of 'Choose Data Source' wizard step is updated; this wizard caption is now shown on Data Sources step instead of Login step
  • 'Execute job' property in documented Alert Properties table changed from plain text to a link to corresponding job
  • default.axdp file is no longer used
  • FullText Catalogs are now compatible with MSSQL2000; fulltext catalog object type is now positioned before Function in Object Types and Object Filter steps and in generated documentation
  • Server Details wizard step now contains only 'Server Details' options; server object types are now moved to new Server Object Filter step
  • Default Folder for projects and output files is changed to be MyDocuments/ApexSQL/ApexSQLDoc instead of application folder
  • Server information topic in generated documentation is moved to appropriate server name topic; renamed to 'Server Info'
  • Database objects topic in generated documentation moved under Server name topic (under Database Engine)
  • Database Information topic in generated documentation is removed; moved under appropriate database name topic
  • Pages that are documented and shown in CMH, Help 2.0, HMTL format are now fully Unicode
  • Project name is now displayed in caption of Main window
  • Info compiler messages are no longer shown when compiling to Help 2.0 format
  • Category property row for MSSQL2005 alerts is removed in documentation of Alerts
  • {servername} tag is changed to {datasourcename} tag in naming and Custom Text steps; {servername} is now deprecated tag
  • Format of /include CLI switch is changed from DAtabase1.TypeConstant:Expression to Server1.Database1.TypeConstant:Expression
  • Format of /exclude CLI switch is changed from Database1.TypeConstant:Expression to Server1.Database1.TypeConstant:Expression
  • /pi switch changed to support all new performance intensive options from User Interface
  • /server_details CLI switch is changed. Arguments used for choosing server objects are removed (lo, cd, jb, al, op); server objects that should be documented can now be specified in new /server_object_types switch
  • Description column is removed from 'Recordsets returned' table in generated documentation for functions and procedures
  • 'Stored Procedures' topic is renamed to 'Procedures' topic in generated documentation

Known limitations:

  • Decrypting of encrypted objects not supported for MSSQL2005 objects
  • CHM topic cannot display Unicode characters (only English characters will be displayed correctly in CHM topic)