This article details the steps necessary to update an existing InstantKB.NET 2.0.3 installation to the InstantKB.NET 2.0.4 release. You can also find information in this article on the additions, updates & fixes included within 2.0.4.
AJAX based Glossary ToolTips
Tooltips are now automatically provided for glossary terms that appear within articles. This allow you to provide contextual tooltips providing further information for specific terminology based on the terms defined within your glossary. To activate the tooltips simply hover your mouse over a glossary term within articles. You can include HTML such as links or formatted text within the fooltps..
Tags matching glossary terms will also now provide a contextual tooltip...
If you choose to disable the glossary for any member group the tooltips will not be displayed for that member group.
Improved Field Templates
- You can now set a default value for hidden fields within a field template.
- We removed the "enabled" column on field templates as this was causing confusion and is no longer required if you can set a default value for hidden fields.
- Improved logic to ensure a field cannot be set to required if hidden.
Workflow Improvements
- Improved work flow step change actions. You can now apply change actions if the field is hidden within a field template .This provides much more flexibility by allowing you to hide fields from staff members whilst still setting change actions on fields as staff members move content through workflow. Workflow step change actions will now also always override form values even if changed within a form before submission.
Improved Category Management
We've added two new options to staff permission sets to allow you to further control the options available to staff members when editing categories. You can now disable the ability to move categories however more importantly you can now hide the member group selection from staff members when creating & editing categories. Disabling the member groups ensures staff members can only create categories within the member groups in which they belong. This is create i you want to allow several departments to manage separate categories within a stab...
We also resolve some issues around the context menu within the Staff CP used for managing categories if you disabled certain editing options.
Staff Permission Set Additions
Added several new staff permission set options. These new settings provide further control over the authoring features available to your staff members within your knowledgebase.
- Fixed issue running InstantKB.NET on x64 machines. You will need to contact us for a x54 version of our InstantASP.Licensing.dll. You'll need to replace this single file with a version compiled to target Any CPU.
- Fixed issue with "An invalid character appears in the header name" exception when sending email's from InstantKB.NET using SMTP authentication. Also improved SMTP SLL support.
- Fixed issue with global time zone offset not being applied as the default time-zone offset during registration.
- Fixed issue with workflow drop down list not showing new work flow steps immediately after adding new steps
- Fixed issue which prevented some staff members from editing private articles.
- Fixed issue with Staff & Admin shared notes not saving within some browsers.
- Fixed minor formatting issue with status & priority columns within ViewArticles.ascx.
- Fixed issue with article abstract tooltip not always appearing when hovering over article titles.
- Fixed issue with category name not appearing within category column if added to datagrid view for non-admins.
- Fixed exception when saving workflow step if no next steps are defined.
- Fixed issue with create by & modified by columns not showing if set within a view.
- Fixed issue with upload & delete article templates within staff permission sets not working correctly.
- Fixed exception if you attempted to access reports as an administrator not associated with any of your member groups.
- Fixed issue with Manage Categories context menu if you disable adding & editing categories within staff permissions.
- Fixed issue with GenericIdentity not serializing correctly under .NET 3.5 & 3.5 SP1.
- Fixed issue which didn't move staff members into a new primary department if you delete that department.
- Fixed issue with PDF export paths.
------------------------------------------------
1. Download InstantKB.NET 2.0.4
Download the 2.0.4 update from your My.InstantASP area.
If your an existing 2.x customer the 2.0.3 download will be available automatically on your My Licenses page at http://my.instantasp.co.uk/MyLicenses.aspx. Download the 2.0.3 update and extract the contents of the zip file to your desktop. This will create a new folder on your desktop called InstantKB204DEV or InstantKB204EUL.
2. Update your existing 2.0.3 files
The quickest way to update is to simply copy the entire contents of the "InstantKB20" folder from the latest update (excluding web.config file) again to your current InstantKB.NET installation. This will replace all existing 2.0.3 files. If you choose to replace all files you may wish to skip the web.config and Skin\Classic\MasterPage.master file to preserve your database connection string and any visual customization's. If you own a single server license or are behind a firewall and received a file based license you should ensure you have a backup of your "\Bin\InstantASP_Licenses.config" file to restore this once the update is complete.
Replacing only the updated files
If you've customized / modified a number of InstantKB.NET files you may wish to simply copy only the updated files into your installation. You can find a list below of all updated files within the 2.0.4 release. There are no new files with this update. You'll need to ensure you update the existing files with the latest versions from the 2.0.4 download.
3. Update your existing 2.0.3 database
Once you've updated your files you'll need to run a script against your InstantKB.NET SQL Server database to upgrade this to 2.0.4. There are two small database changes in 2.0.3. To update your database you'll need to first connect to your database within SQL Server Management Studio or Enterprise Manager.
Once connected you'll need to open the "InstantKB20\DatabaseScripts\UpgradeScripts\2.0.3_to_2.0.4.sql" file and execute this SQL file against your current InstantKB.NET database. You can also find the upgrade script attached to at the bottom of this article.
The following files have been updated with the 2.0.4 update. If you wish to only apply the updated files you should copy the files from the InstantKB.NET 2.0.4 download listed below into your existing 2.0.3 installation.
Update Assemblies
All assemblies will need updating...
- InstantASP.Common.dll
- InstantASP.Common.Configuration.dll
- InstantASP.Common.Data.dll
- InstantASP.Common.UI.dll
- InstantASP.InstantKB.dll
- InstantASP.InstantKB.Data.dll
- InstantASP.InstantKB.UI.dll
Updated Skin Files
You will need to update the following skin files. You will need to copy these files from the 2.0.4 release into all existing 2.0.3 skins...
- Skins\Classic\Admin\Controls\AdminViewFieldTemplate.ascx
- Skins\Classic\Admin\Controls\AdminInsertUpdateStaffTabPermissionSet.ascx
- Skins\Classic\Staff\Controls\StaffInsertUpdateCategory.ascx
- Skins\Classic\Controls\ViewArtcles.ascx
Updated CSS Files
Two CSS files have been updated. We have added three new CSS classes. If you've modified the style sheets and wish to simply add the new styles we've provided further below the new CSS claseses.
- Skin\Classic\Styles\InstantASP.InstantKB.Ui.css
- Skin\Classic\Styles\InstantASP.Common.Ui.css
Updated JavaScript Files
The following JavaScript files will require updating...
- JavaScript\InstantASP.Common.UI.js
- JavaScruot\InstantKB.js
Language Pack Files
To accomodate for the new staff permission set options a number of new values have been added to the Resources.xml. This will need updating to ensure the new text is displayed within the Admin CP.
- Globalization\rn-US\Resources.xml
Two stored procedures have been updated with the 2.0.4 update.
- ikb_sp_InsertUpdateArticle
- ikb_sp_DeleteDepartment
You can find a script to update your existing InstanKB.NET 2.0.3 stored procedures attached below. You can also find this script within the InstantKB.NET 2.0.4 download within the "\InstantKB20\DatabaseSCripts\UpgradeScripts\2.0.3_to_2.0.4.sql".
Three new CSS elements have ebeen added to assist with the new glossary tooltip feature.
InstantASP.Common.UI.css
Modify the "ToolTipControl_BackGround" class as within InstantASP.Common.UI.css as shown below...
.ToolTipControl_BackGround
{
position: absolute;
z-index: 99999;
font-family: Verdana, Arial, sans-serif;
font-size: 8pt;
color: #1F5080;
border: solid 1px #8FAEBE;
background-color: #FFFFD9;
display: none;
padding: 10px;
cursor: help;
}
.ToolTipControl_BackGround a
{
color: #1F5080;
}
.ToolTipControl_BackGround a:hover
{
color: #0482FE;
}
InstantASP.InstantKB.UI.css
Add the following class to InstantASP.InstantKB.UI.css...
.glossaryToolTip
{
text-decoration: underline;
cursor: pointer;
}
Once you've updated the files listed above and updated your database you should visit your existing InstantKB.NET installation. If everything was successful you should be able to continue using your knowledgebase as before. As always if you have any questions or run into any problems during the upgrade don't hesitate to leave your comments below, open a support ticket or contact us.