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

Thank you for your feedback!


InstantKB 2018 to 2018-1

This article details the steps necessary o upgrade from InstantKB 2018 to the InstantKB 2018-1 release. For a complete list of changes between our InstantKB 2018 and 2018-1 releases please refer to our Fixes & Updates section below.

Fixes & Updates

InstantKB 2018-1 contains the following fixes and improvements...

  • Various improvements for "Email Contains" rules field
  • Fixes to no issues text on edit contact page
  • Fixes to ikb_sp_SelectAttachmentsForUser returning incorrect attachments
  • Fixed issue with ticket last modified date sometimes not updating
  • Fixed work flow label still being visible if no work flow existed
  • Fixes to overflow issues within markdown preview
  • Improvements to "Need Help" panel 
  • Fixes to Export to PDF if article contains embedded video
  • Fixed issues with label, priority & channels applying null values in ViewArticleDetails

Downloading InstantKB 2018-1

To begin your InstantKB 2018-1 download you'll need to visit your My InstantASP account. Visit your "My Licenses" page and click the "Download" button to the right of the InstantKB 2018-1 listing.

Once you've downloaded the ZIP file please extract the contents of the ZIP file to your local computer or web server desktop.

Upgrading Your InstantKB 2018 Database

IMPORTANT
Before you begin the database upgrade please ensure you create a backup your existing InstantKB 2018 database. Whilst it's highly unlikely you'll encounter any problems running our upgrade scripts it's always best practice to take a full backup of your current InstantKB database before running our upgrade scripts.

We would also suggest performing any upgrade locally or within a testing / staging environment to familiarize yourself with the upgrade process. We would not suggest applying the upgrade directly into production without first testing the upgrade process locally.

The basic steps to upgrade are listed below...

1. Open SQL Server Management Studio (SSMS) and connect to your existing InstantKB 2018 database. Create a backup of your existing InstantKB 2018 database.

2. Restore your InstantKB 2018 database backup under a new name, for example "InstantKB2018-1". We will run our upgrade script against this new restored database to add the new tables and stored procedures required for InstantKB 2018-1 whilst preserving all your existing data.

3. Again within SQL Server Management Studio go to File > Open and navigate to the DatabaseScripts folder within your InstantKB 2018-1 download. This is located at {InstantKB2018-1Install}\DatabaseScripts\UpgradeScripts\. You will need to open the "2018_to_2018-1.sql" file so we can execute this TSQL script against your restored InstantKB 2018 database..

4. Again within SQL Server Management Studio ensure your restored database is selected within the database drop down list within the SQL Server Management Studio toolbar. Once your sure you have your restored "InstantKB2018" database selected execute the 2018_to_2018-1.sql script against your restored InstantKB 2018 database. Once complete you will see the message "Query Executed Successfully" within the status bar of SQL Server Management Studio.

At this point your restored InstantKB 2018 database has been fully upgraded to InstantKB 2018-1. You can now point a fresh installation of the InstantKB 2018-1 files to this upgraded database. You'll notice all your existing data is preserved and you can login using the same credentials as before.

Install the InstantKB 2018-1 Files

NOTE
We would not suggest overwriting the 2018 files with the newer InstantKB 2018-1 files. You should install the new InstantKB 2018-1 web application alongside your existing InstantKB 2018 installation. Once everything is working you can simply rename the folders to switch your live site or change the physical path for your web site within IIS to point to the newer InstantKB 2018-1 files.

1. Copy the contents of the "src" folder within the InstantKB 2018-1 download to your c:\inetpub\wwwroot\instantkb20181 folder or alongside your existing InstantKB 2018 folder within staging or production. You can rename this folder to anything you wish.

2. Ensure the folder containing your InstantKB 2018-1 web site files is marked as a web application within IIS similar to your existing InstantKB 2018 web site or web application within IIS. If your opening the application via Visual Studio this is not necessary for local development but will be required for deployment into a staging or production environment.

3. Navigate to your older InstantKB 2018 installation folder within Windows Explorer. You will need to open the web.config file found in the root of your InstantKB 2018 folder within NotePad and update the database connection string to point to your restored & upgraded 2018 database. The default connection string is shown below...

<connectionStrings>
<add name="InstantASP_ConnectionString" connectionString="Server=localhost;trusted_connection=true;database=InstantKB;" />
</connectionStrings>

You can find your existing InstantKB 2018 database connection string within your InstantKB 2018 web.config file. You can simply copy this into your InstantKB 2018-1 web.config file. You may need to update the database name within your connection string if you've followed the steps above and restored a copy of your existing InstantKB 2018 database.

4. Copy your the "Uploads" from within the root of your existing InstantKB 2018 installation into the root of your new InstantKB 2018-1 folder. Overwrite the Uploads folder within InstantKB 2018-1 with your existing InstantKB 2018 Uploads folder.

5. Reapply any visual changes you may have made to your previous InstantKB 2018 Classic skin to the newer InstantKB 2018-1 Classic skin.

Upgrading from an older release?

If your upgrading from an earlier version of InstantKB you may need to run additional database upgrade scripts. For example if your currently running InstantKB 2016 you would need to run the following scripts in the order shown to fully upgrade your existing 2016 database to the latest 2018-2 schema whilst keeping all your existing data...

2016_to_2016-1.sql
2016-1_to_2016-2.sql
2016-2_to_2016-3.sql
2016-3_to_2016-4.sql
2016-4_to_2018.sql
2018_to_2018-1.sql

You should always install the same version of the InstantKB files to march your InstantKB database version.

Copy Existing Uploads Folder

Don't forget to copy your existing "Uploads" folder from your existing InstantKB 2018 installation folder into the root of your InstantKB 2018-1 folder. You will be prompted to overwrite the empty "Uploads" folder provided within the InstantKB 2018 installation. When prompted overwrite the empty InstantKB 2018-1 Uploads folder with your existing InstantKB 2018 Uploads folder. This will ensure uploads, profile pictures & images embedded within articles are still displayed correctly. If you don't copy the uploads folder profiles images & images embedded within articles may not appear after the upgrade.

Web.Config Changes

The web.config file has changed quite substantially with 2018-1. For this reason we would suggest starting with the new InstantKB 2018-1 web.config file and not trying to add the newer 2018-1 tags to your existing InstantKB 2018 web.config file.

You will need to copy the database connection string from your existing InstantKB 2018 web.config and use this within your newer InstantKB 2018-1 web.config.

That's It!

We hope you enjoy the 2018-1 update. Should you have any questions or feedback please open a support ticket, contact us or post your questions within our community forums.