ApexSQL Doc release notes

Release: 2013.01.0237
Date: May 07, 2013
Description: Major fix release

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
Release: 2012.01.0236
Date: March 18, 2013
Description: Hot-fix release

Fixes:

  • Different exceptions are encountered due to .Net Framework 4.0 support implementation via the "ApexSqlDoc.exe.cofig" file
Release: 2012.01.0235
Date: January 24, 2013
Description: Hot-fix release

Fixes:

  • 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
Release: 2012.01.0234
Date: November 22, 2012
Description: Hot-fix release

Fixes:

  • '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
Release: 2012.01.0232
Date: June 20, 2012
Description: Major feature, medium fix release

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
Description: Major feature, medium fix release

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
  • 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 documenting options

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
Description: Major feature, medium fix release

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
Description: Medium fix, minor feature release

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
Description: Minor fix, minor feature release

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
Description: Minor fix, minor feature release

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 crashes because of long lines in binary fields in package that was 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
Description: Medium fix release

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
  • Crash when switching to Extended Properties login dialog by Alt-Tab from another application
  • Crash 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
  • Crash with project 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 crashes 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
Description: Medium fix, medium feature release

Fixes:

  • 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
  • Crash 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
Description: Medium fix release

Changes:

  • Intermediary folder location can be customized in options

Known limitations:

  • Decrypting of encrypted objects not supported for MSSQL2005 objects

Release: 2008.02.0215
Date: July 01, 2008
Description: Medium fix release

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 crashes 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
Description: Major feature release, medium fix release

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 selection
  • 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 (/sync) /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)