Upgrade Kepion

Upgrading Kepion is a very straightforward process.  The topics in this page describe planning, testing, and upgrading your existing Kepion installation. We include information about best practices, as well as steps for upgrading a single node server and a multi-node installation.

Prepare for the Upgrade

Gather required files

Download the required files from the Kepion Resource Center.

Type of Install Files to Download
Standard Install Software Downloads > v6.0:

  • 6.0 Kepion Setup x64.zip
Manual Install Software Downloads > v6.0 > Manual Configuration:

  • EnableFeaturesOnServer.zip
  • Package.zip

Test the Upgrade

The best way to learn what impact a Kepion upgrade will have to your current environment is to test it. Knowing how an upgrade will affect your users and your server helps you plan and communicate before the actual upgrade, ensuring that your users will not be caught by surprise.

If you have a Kepion test environment this is a great place to test out the upgrade.

We recommend the following sequence for testing a Kepion upgrade:

Prepare a test environment

To start, create a test environment that mirrors your production environment as closely as possible. The closer your test environment is to the actual environment you will be upgrading, the more accurate a representation you will have of how the upgrade will impact you. This includes identical or similar hardware and operating systems, as well as the same authentication options and network access.

Upgrade the test environment

Refer to Upgrade Kepion.

Confirm that existing functionality works

After you have the new version of Kepion installed and configured in your test environment, you are ready to test. You should test basic functionality, along with any special aspects of server that your organization relies on.

These are some areas of testing to consider:

  1. User access: Confirm that Kepion users can sign in. Test your normal user sign in process. Have some of your users participate in the testing to make sure they are able to sign in as expected, and that they can get to the same content that they have access to in your production environment.
  2. Post data and run rules: Have users enter data on a few writeback forms and post data to the server. Usually calculation rules are configured upon posting. It is a great time to review the results after posting.
  3. Permissions and security: Confirm that permissions are still set as expected for users and content.

Test new features

Take a look at the new features that come with the version you are upgrading to, and at any features that were added between the version you currently have and the new version.

Perform the Upgrade

Make sure you’ve prepared for the upgrade by gathering required information. For more information, see Prepare for the Upgrade. Optionally (but recommended), test the upgrade on a test environment that mimics your production environment. For more information, see Test the Upgrade.

Before you upgrade

As a best practice, you should always make a backup of your Kepion application databases and CPMAppHost database before upgrading. This backup is necessary in the event that something unexpected happens during the upgrade, or if you need to roll back to your previous version of Kepion.

In IIS Manager, Stop Kepion Planning web site. This will prevent your users from updating numbers during the time you backup the databases in the next step.

Keep track of the Kepion version before upgrading.

Backup CPMAppHost and Kepion application databases.

For manual install, you also need to back up the files under the install directory.

In IIS Manager, Start Kepion Planning web site. The Kepion Planning web site needs to be online when you upgrade Kepion.

Upgrade Kepion

Perform the update steps on the Kepion Web Server.

Type of Install Upgrade Step
Standard Install 1. Unzip 6.0 Kepion Setup x64.zip, and run the setup.msi installer.

2. When you click “Finish” on the installer, it will launch Kepion in browser automatically. It may take a few minutes to process until you see the APPS page. Be patient while the upgrade script is doing its job.

Manual Install 1. Unzip EnableFeaturesOnServer.zip, and run the EnableFeaturesOnServer.bat script.

2. Unzip Package.zip, and copy and paste the included files to the install directory.

3. Connet to Kepion in IE browser to trigger the upgrade process. It may take a few minutes to process until you see the APPS page. Be patient while the upgrade script is doing its job.

Please refer to the manual setup guide on how to perform the first two steps.

After you upgrade

Check Event Viewer

At the time of upgrade, Kepion server will log each upgrade event to Event Viewer. You will see an upgrade message for each Kepion database that successfully upgrades, including CPMAppHost and application databases.

Here is a few key messages you should watch for:

For standard install, you will see a similar message when the installer is finished.

System database (CPMAppHost) is successfully upgraded to the installed version.

Each application database will have an individual upgrade message. The screenshot below shows the Sample App-Advanced application is upgraded successfully. Watch for a similar message for each application running on your environment.

If you encounter an error during the upgrade process, please refer to Troubleshoot Upgrade.

Deploy all the applications

If everything looks good in the Event Viewer, you have upgraded Kepion successfully!  To ensure that all the new features are ready to use, we recommend deploying all the applications in your environment.

Troubleshoot Upgrade

Sometimes (though rarely), there are custom configuration to the application database that is preventing upgrade from succeeding. Take a look at the error logs and see if anything is associated with a custom configuration.

If you are able to identify the root cause of the upgrade error, correct the custom configuration, and perform an in-place upgrade.

If you are not able to resolve the upgrade error, please contact Kepion at support@kepion.com. Do not use the system in a half upgraded state as these can cause unexpected errors.

In any case, you can perform a complete rollback.  See details in Full restore.

In-place upgrade

All Kepion servers are capable of in-place upgrade, which ensures that all SPs and views are in sync with the server. To trigger an in-place upgrade:

  1. In IIS Manager, Stop Kepion Planning web site
  2. In SQL, rollback the column in [CPMAppHost].[dbo].[Version].[Name] to “{Version Number before Upgrade}
  3. In SQL, rollback the column in {APPLICATION_DB}.[dbo.].[ApplicationInfo].[Version] to “{Version Number before Upgrade}
  4. In IIS Manager, Start Kepion Planning web site
  5. Go to IE and connect to Kepion
  6. View the progress of upgrade from Event Viewer
  7. Analyze any errors and send to Kepion team as necessary

Full restore

Make sure you have the following components available before you perform a full restore:

  • Old Kepion setup file
  • KepionSI information
  • CPMAppHost and Kepion application database backups

Steps to perform a full restore:

  1. Uninstall Kepion in Control Panel
  2. Restore the CPMAppHost and Kepion application databases in SQL Server
  3. Re-install Kepion with older setup (the version you have before upgrade)
  4. Configure Kepion and point to the existing CPMAppHost