Version 3.5.4a

From KnowledgeTree Document Management Made Simple

Jump to: navigation, search

Contents

Overview

This is a maintenance and bug fix release of KnowledgeTree Version 3.5.4 - for KnowledgeTree Community Edition and KnowledgeTree Commercial Edition.

Release Date: 3.5.4a

  • KnowledgeTree Server: 15 December 2008
Notes:
* This is a release of KnowledgeTree Commercial Edition, and KnowledgeTree Community Edition.
* The latest available KnowledgeTree Client Tools release is version 3.5.4 - Commercial Editions only


What's New

KnowledgeTree Server 3.5.4a

  • Japanese Language pack for KnowledgeTree Commercial Edition


KnowledgeTree 3.5.4a is primarily a maintenance and bug fix release. The only new feature is the Japanese Language pack for KnowledgeTree Commercial Edition.

This releases focuses on improving and stabilizing the upgrade process, and on resolving a few security related issues. We have also fixed a number of bugs, including the document alerts email link, metadata versioning, and search in KnowledgeTree Tools - view full details in the Defect Repair section below. For information on the new features added to KnowledgeTree 3.5.4, see the 3.5.4 Release Notes.

Compatibility with other KnowledgeTree Products

KnowledgeTree 3.5.4a works with the following Tools and Add-ins:

  • KnowledgeTree Tools for Windows (KnowledgeTree Explorer etc) Version 3.5.4
  • KnowledgeTree Hot Folders Version 1.0.2; Version 1.1.0 Beta
  • KnowledgeTree Drop Box (Beta) Version 1
  • KnowledgeTree Office 2007 Add-in (Beta) Version 1

Downloading and Installing KnowledgeTree

System Requirements

Ensure that your environment meets at least the minimum system requirements.

Note: The requirements for the Source Only package (Community Edition only) differ from the stack installed systems. Check the   
KnowledgeTree website and the KnowledgeTree Installation and Upgrade Guide for the latest Source Only requirements.

Upgrading

Upgrades of Beta and Release Candidates to Latest Stable Release are not supported. 


If you are upgrading from a previous version of KnowledgeTree; then, before you begin ...

  • Check your upgrade path and other important upgrade notes here.
  • Ensure that the MySQL process for KnowledgeTree is stopped before upgrading. On some systems, the Upgrade Installer is not automatically stopping the MySQL process.


Download KnowledgeTree

Notes:
* If you are a KnowledgeTree Commercial Edition customer, you will receive an email with a direct link for this version.
* If you wish to install KnowledgeTree Community Edition, follow the Community Edition link above.
* If you wish to install the KnowledgeTree Commercial Edition Trial for evaluation purposes, follow the Commercial Edition 
  link above. 
* Registration is required for both the Community Edition and the Commercial Trial Edition. After registering, you will 
  receive an email with the link to the download area, where you can choose the appropriate download package - Windows/Linux;  
  and, for the Community Edition download, Stack Install or Source Only. 
* If you need help with this download, please contact KnowledgeTree Sales.


Install KnowledgeTree

How to install KnowledgeTree Commercial Edition

1. Download and install the following KnowledgeTree Commercial components from the Commercial download area, using the Commercial Edition stack install wizards for each of the following:

  • KnowledgeTree Commercial On-premise Server
  • KnowledgeTree Client Tools for Windows (Note: Run setup.exe -i.e. not the msi file - on each client machine where you want to install KnowledgeTree Client Tools for Windows)
  • KnowledgeTree Commercial License (Premium/Plus/Basic, or Enterprise Trial)
  • KnowledgeTree Hot Folders (Beta) - optional
Notes:
* All Commercial components, except for KnowledgeTree Hot Folders, are available on the Commercial Edition Download page. 
* The download for KnowledgeTree Hot Folders may be found here. The latest available version of KnowledgeTree Hot 
  Folders is Beta 1.0.2
* If you are not sure which license you need, Compare Products before purchasing a license, or 
  download the Enterprise Trial.
* Full download and installation / upgrade instructions are documented in the 
  KnowledgeTree Installation and Upgrade Guide. 
* Instructions for setting up your system are documented in the KnowledgeTree Administrator Manual. 
* Instructions for KnowledgeTree Hot Folders are documented in the KnowledgeTree Client Tools User Guide. 
* All KnowledgeTree documentation is available from the KnowledgeTree website. 
* For more information on installing KnowledgeTree, see also http://wiki.knowledgetree.com/Installing


2. Log in to KnowledgeTree’s Web interface to install your KnowledgeTree Commercial License.

Notes:
* KnowledgeTree’s Web interface Login page displays in your Web browser directly after you run the Server 
  Setup Wizard. 
* Use the following default credentials to log in the first time: 
** Username: admin
** Password: admin


3. Configure a connection to KnowledgeTree through KnowledgeTree Client Tools for Windows, on each client machine where KnowledgeTree Client Tools is installed.


4. Set up KnowledgeTree for your organization.


How to install KnowledgeTree Community Edition

There are two install options for KnowledgeTree Community Edition:

  • Use the KnowledgeTree Community Edition Installer (installs all required components); OR,
  • Perform a Source Only (manual) install (note: Source Only installations are not supported)


Using the Community Edition Stack Installer

1. Download KnowledgeTree Community Edition - choose the Stack Install; then, click through the Server Setup Wizard to install KnowledgeTree.

2. Once Setup completes, KnowledgeTree's Web interface login page opens in your browser. Use the following default credentials for the initial log in; and then, set up KnowledgeTree for your organization:

  • Username: admin
  • Password: admin
Notes: 
* See the KnowledgeTree Installation and Upgrade Guide, and the KnowledgeTree Administrator Manual for full 
  instructions around installing and setting up your system.


Using the Community Edition Source Only package

1. Download and install the KnowledgeTree Source Only package.

Note:
* Instructions for the manual install are documented in the 
  KnowledgeTree Installation and Upgrade Guide. 
* Instructions for setting up your system are documented in the KnowledgeTree Administrator Manual. 
* For more information on installing KnowledgeTree, see also http://wiki.knowledgetree.com/Installing

Defect Repairs: 3.5.4a

KnowledgeTree Server

Improved Upgrade Process

The following improvements to the upgrade process facilitate a smooth upgrade, and the safety of data during upgrade:

  • A service check step added to the upgrade installers prevents upgrade from starting unless all services are stopped.
  • Redundant Zend encoded optimizer files, which were left over from old upgrades, are removed during upgrade to 3.5.4a (KTS-3945).
  • Improvements to the backup and rollback process that occurs during upgrades.
  • KTS-3938. The upgrade sql file server_name.sql was causing database upgrade to fail. The file is now removed to prevent this issue from occurring.
  • KTS-3911. KTAgent failed with errors after upgrading to 3.5.4 because the agent.exe file was missing from the Commercial Upgrade Installer. This file is included in Version 3.5.4a.
  • KTS-3927. Dashboard Document Indexer Statistics "refreshLuceneStats" refresh shortcut caused "400 Bad Request".
  • Checked that the mime magic file location setting is correct after an upgrade and a full install. Changed the path to ${fileSystemRoot}/../common/share/file/magic
  • Resolved database issues related to the database upgrade and server name issues.


Retention of Configuration Settings after Upgrade

Improvements to the upgrade ensures that configuration settings are retained and migrated to the configuration section in the database, and on Commercial upgrades, to ensure that Commercial settings are maintained and added to the database:

  • KTC-639. Configuration settings (config.ini and/or DB) were not updating correctly after an upgrade. SSL enabled variable in config.ini was not being adhered to.
  • KTC-3942. After an upgrade, the prompts for reasons on check out and check in was no longer displaying because Commercial settings were not written to the database.
  • The settings in config.ini must be correctly migrated to the database.
  • SSL was being disabled by the upgrade.
  • Changing the log level in the configuration administration section should not rely on ktlog.ini to work.
  • Moved varDirectory into the database, and added code to ensure the Installer updates the config settings in the database and not in the config.ini.
  • KTS-3939 / KTS-3940 / KTS-3941. Upgrades must retain Apache, PHP, and MySQL configuration: retain existing my.cnf, retain existing httpd.conf, and existing my.cnf.
  • Client Tools were not being moved into the database on upgrade from Community Edition to Commercial Edition.


Fixes to KnowledgeTree Tools Search

Search in KnowledgeTree Tools was not working correctly:

  • KTS-3916. Errors were reported with Search in KnowledgeTree Tools. The resolution was to apply, where Permissions were found to cause issues, a Web Services fix that adds a call to determine whether the requestions user has permissions on the folder.


Security

General Security Updates:

  • A number of cross-site-scripting issues were resolved.
  • Steps were added to ensure that htaccess files are present and valid, and to prevent directory listing
  • KTS-3921. An error in the DropDocuments plugin was allowing ordinary users, in some instances, to log in as admin user with admin permissions (KTS-3921) The plugin was refactored to fix this issue.


Server IP and Name Setting

Server IP and name setting was investigated, and the server IP was made configurable to resolve a number of issues around getting Indexing to work after installing or upgrading KnowledgeTree. This will also ensure that moving the server or changing the IP and/or port does not cause errors:

  • Internal addresses are auto-populated on install and on upgrades.
  • KTS-3882. Store the internal and external IP addresses for the server_name in the database. Ensure that the port is appended. A new configuration setting has been added to DMS Administration - System Configuration (General Settings-Server Settings), where internal and external IP addresses and ports can be defined and changed when, for example, the server is moved to a different IP or port. And for installs off the main web root (source installs), the rootUrl must also be set in DMS Administration – General Settings – KnowledgeTree.
  • Incorrect IP also broke the links in the email sent from KnowledgeTree for Document Alerts.
  • KTS-3913 (related call KTS-3882). Indexing was not working. The problem with the indexer not being run is caused by the internal url that curl uses for the script. If the server has not been set up to use the server name internally then it will fail. The internal url for the server will be used (defaulting to 127.0.0.1) and can be adjusted in the config settings on: DMS Administration – Configuration Settings – General Settings – Server Settings.
  • KTS-3918. On Linux, after a fresh install of KnowledgeTree, the Indexer was trying to connect to apache at port 80, but KnowledgeTree was installed at port 8080. The fix ensures that the installer updates the port on which the Indexer connects.
  • KTS-3928. Document Indexer was not working and cronIndexer failed.


Other Fixes

  • Document Alerts - an error in the link in the Document Alerts email:

KTS 3943. Changed the function used to create the link URL. The link is now created using the server_name variable stored in the database to ensure that Alert email links have the correct IP. The server_name setting may be modified from the system setting section in DMS Administration.


  • Document Shortcuts - adding a Document Shortcut appears to create a copy of the document:

KTS-3944. The shortcut was created correctly but displayed the incorrect icon because the proxies were not updated with the new upgraded code. The resolution was ensure that the post-upgrade actions function clears the cache and deletes all proxies to allow regeneration with the new code – clearing the proxy cache (<knowledgetree directory>/var/proxies) fixes the issue.


  • Re-reading plugins caused fatal errors:

Plugin helper must be empty before re-reading plugins (delete from plugin helper). A user reported that they received fatal errors when re-reading plugins. This issue could not be reproduced, but some defensive code has been added


  • Workflow Transition Comments

Workflow transition comments should display only for the document on which the comment was made. Comments added when transitioning a document in a workflow were linking to the workflow and not displaying only for the document where the comment was made. The issue was fixed to ensure that comments are linked to the document and not to the workflow.


  • Metadata Versioning

The metadata version should increment on changes to the metadata: KTS-3924. The metadata version was not incrementing when changing metadata through the Web interface ‘Edit Metadata’ action


  • Checked mime magic setting in config section in DB


  • Session connection - error when downloading large document

KTS-3930. A user reported that, when downloading a large document, KnowledgeTree was only allowing one connection per session. This issue was traced to the session. KnowledgeTree locked the session file while executing the download script, causing other requests attempting to access the session to hang, which prevented the user from browsing KnowledgeTree until the download was complete. This issue was fixed by modifying the do_main() method of the KTDocumentViewAction class in plugins/ktcore/KTDocumentActions.php.


  • Added Japanese i18n to 3.5.4a release


  • The SSL enabled variable was missing from config.ini


  • Advanced search on Available Fieldsets

KTS-3926. Fixed an error resulting from advanced search on available fieldsets.


Known Issues

KnowledgeTree Server

In some instances, depending on your network setup, an indexing error occurs in the log files (Windows and Linux). To resolve this issue, create a vhost for KnowledgeTree, instead of using a subfolder - i.e. this fix will work for default installations but not where KnowledgeTree is installed in a subfolder. For example, the URL https://mykt.myorg.org/ will work. The URL https://www.myorg.org/mykt/ will NOT work.


  • Cross-site-request-forgery:

As a Web-based application, KnowledgeTree may be vulnerable to cross-site-request-forgeries (CSRF). CSRF is entirely different to an XSS attack. Whereas a CSRF attack exploits the trust a server places in a user, an XSS attack exploits the trust a user places in a server. CSRF attacks are difficult to determine because the HTTP request containing the attack is sent by a trusted user. To reduce the risk of CSRF attacks, we strongly recommend that KnowledgeTree system administrators familiarize themselves with the issue of CSRF, and take the necessary precautions to protect their KnowledgeTree installations from such attacks.


  • KTC-669: Errors with zip on bulk download, bulk checkout, download all

Non-admin users may be unable to use Download All, Bulk Download, and Bulk Checkout - actions requiring use of zip.


  • KTC-668: When upgrading on Linux, on the 3.1b Open Source to 3.4.6 upgrade path, the Upgrade Installer reports that MySQL is not shutting down, and the upgrade is stopped.


On some installs, upgrading to 3.5.4a results in the document storage directory being set to the default directory as well as the variable being hidden in the web interface Administration section. Editing the path in the config.ini file also has no effect on the actual document storage path. For a work-around, please see http://wiki.knowledgetree.com/Hidden_Document_Storage_Directory_in_3.5.4a


Return to Main Release Notes

Personal tools