Optionally provide private feedback to help us improve this article...

Thank you for your feedback!


InstantKB 2015 Breaking Changes

This article covers some of the breaking changes introduced within our InstantKB 2015 release.

NOTE: This is intended to help existing InstantKB customers upgrading to the 2015 release. If your installing InstantKB 2015 for the first time and you are not migrating data from a previous version you can skip this article.

Common Issues

To help you quickly address isues you may encounter after upgrading to InstantKB 2015 we've covered a few common questions we foresee below...

After upgrading to InstantKB 2015 I am unable to login

This is likely due to the default encryption method we used being changed within InstantKB 2015. To resolve this problem see follow the steps detailed in the "Web.config Changes" section below.

After upgrading to InstantKB 2015 I see broken images

We removed from icons within our InstantKB 2015 release. You can resolve any broken icon images you see by following the steps within the "Broken Rule, Tab & Ticket Icons?" section below.

After updating to InstantKB I'm not receiving rule notifications

We've added the ability for you to enable and disable individual rules within InstantKB 2015. By default all upgraded rules from previous versions of InstantKB will be disabled by default. You will need to visit the Manage Rules page and re-enable each rule. For further information please see the "Re-enable Your Rules" section below.

Web.Config Changes

We've changed the default encryption method used to encrypt sensitive data stored within the InstantKB database with our 2015 release. InstantKB 2015 now defaults to using 256 AES symmetric encryption with cipher block chaining for all encryption.

If your upgrading from a previous version of InstantKB you will need to ensure the encryption method used by InstantKB 2015 matches the encryption method used by your existing installation. If the encryption methods do not match you won't be able to login to InstantKB 2015 using your existing username / email & password.

To ensure InstantKB 2015 uses the same encryption as your previous installation please follow the steps below...

1. Open your InstantKB 2015 web.config file within NotePad.
2. Locate the following application setting....

<add key="InstantASP_CryptographyMethod" value="AES" />

If your upgrading from InstantKB 2014 you may need to change this setting to match the default encryption used by InstantKB 2014. This is shown below...

<add key="InstantASP_CryptographyMethod" value="SHA512" />

If your upgrading from an older version of InstantKB you can either remove InstantASP_CryptographyMethod application setting completely or update this as shown below...

<add key="InstantASP_CryptographyMethod" value="TripleDES" />

If you install the InstantKB 2015 files and upgrade an existing database to the latest InstantKB 2015 schema

Re-enable Your Rules

With InstantKB 2015 we've introduced the ability for you to enable and disable individual rules. This can be helpful if you wish to disable but not delete a rule. By default after you upgrade from InstantKB 2014 or earlier to InstantKB 2015 all existing rules you may ahve created will be disabled by default. You will need to visit the Manage Rules page for your tab and re-enable the rules you wish to use. You can do this very easily as shown below...

Re-enable Your Escalation Rules

Similar to inbound and outbound rules you can also disable individual escalation rules within InstantKB 2015. If you have existing escalation rules and are upgrading from an earlier version you will need to re-enable the escalation rules you wish to use after the upgrade process

Editor Changes

Article Headings

For InstantKB 2015 we now suggest using the "Formatting" drop down list within the editor to define headings within your article text. You should not use the "Apply CSS" drop down list within the editor to style regular text to look like a heading.

Adding Headers in 2015....

Using the formatting option as opposed to the apply CSS option to format your headers ensures your articles are more semantically correct and will appear more consistent within views where stlyes are not rendered. For example in Print View or in new modes like Reading Mode Microsoft Edge.

To ensure old heading still look like headers within existing articles we've kept the 3 CSS classes that were previously available to format headers however these CSS classes have been moved to the very bottom of the "Apply CSS" drop down list within the editor to encourage you to use the formatting options going forward. .

New CSS Classes

We've introduced a number of new built-in CSS classes you can use within articles to quickly created formatted areas within your articles. You can use these global CSS classes to format various areas of your articles as shown below...

If you've previously customized the RadEditorCssClasses.xml file to add your own unique custom CSS classes for use within articles you will need to copy your custom CSS classes into the RadEditorCssClasses.xml file provided within the InstantKB 2015 download.

If your upgrading from InstantKB 2014 all existing CSS classes you've used within InstantKB 2014 will work within InstantKB 2015. If your upgrading from InstantKB 2011 or earlier you will need to copy the previous styles within your skins/{skin}/styles/RadEditorCssClasses.xml into the RadEditorCssClasses.xml file provided with InstantKB 2015.

Broken Rule, Tab & Ticket Icons?

With InstantKB 2015 we've introduced a new set of icons you can choose from when adding or editing rules & tabs within InstantKB. This means if your upgrading from an older existing version of InstantKB to our 2015 release you may see broken images alongside your tabs, rules or tickets within InstantKB.

To resolve this problem we would suggest updating the icons used for your existing rules & tabs within your new InstantKB 2015 installation. You can edit these icons from the Admin CP via the Manage Tabs & Manage Rules page for your tabs. You will need to edit each tab & rule and use the "Select Icon" link to choose a new icon from the available icons provided within InstantKB 2015.

Alternatively if you prefer to keep your existing rule & tab icons within the InstantKB 2015 you will need to copy all the images within the "/Skins/{SkinName}/Images/SmallIconsOld" folder into the "/Skins/{SkinName}/Images/SmallIcons/" folder. Once the deprecated icons are copied back into the "SmallIcons" folder this should ensure any icons you've selected previously for tabs or rules work correctly.