Checkbox 7 - On-Premises Manual Database Upgrade Instructions

This document will guide you through the steps to manually upgrade your Checkbox 6 database to Checkbox 7.

Important Note We highly recommend that you try upgrading with our Checkbox 7 Upgrade installer as documented in our standard upgrade instructions. Please perform a manual upgrade only when instructed to by Checkbox Support.

** THIS DOCUMENT APPLIES TO THE LATEST VERSION OF CHECKBOX 7 ONLY ** Before attempting this, please download the latest version from your customer portal. We do not support manual upgrades with prior versions. 

Requirements / Prerequisites

Before starting this process, please confirm that:

  • Your SQL Server access has the proper permissions and is connecting to the proper database
  • You have a working version of your Checkbox 6 database (If you have previously attempted an upgrade and it failed, revert back to a database backup. You cannot run the upgrade scripts on the same database multiple times)
  • You have a backup of your Checkbox 6 database in case you need to revert
  • You have downloaded the latest version of Checkbox 7 from your customer portal.

Performing the Manual Upgrade

The scripts that you need to run are in the installer\scripts folder of your Checkbox Version 7 download.

It is highly recommended that you run these scripts directly on your database server (e.g. a local session or RDP connection) as opposed to using SQL Server Manage from a remote computer. This will provide the best performance for the process.

Important Note Run these scripts in the following order (note steps 13 and 18 require you to customize the script slightly). Be sure to run each script *exactly how it is written* (except for the minor changes required and described in steps 13 and 18).

If You Encounter Errors During a Manual Upgrade

If you encounter any errors (you can ignore warnings), please stop and do not continue with the upgrade. Open a support ticket (or update your existing ticket if you have one open for this issue) with the step and script name that your upgrade failed on as well as the error message.

Upgrading the core Checkbox database

Performance Note  There are many factors that can impact the time required to run all of these scripts, including the size of your database, the complexity of your surveys, the number of responses collected, and the overall performance and configuration of your SQL Server. Step 3, which upgrades the Checkbox Survey data, is most likely to take the longest. 

These scripts should be run against your core Checkbox database.

  1. Upgrade\Checkbox6_Patch_Schema.sql
  2. Upgrade\Checkbox6_StoredProcedures.sql
  3. Upgrade\Checkbox6_Patch_Data.sql   (this script may take some time to run on larger databases)
  4. Upgrade\Checkbox6_DefaultText.sql
  5. Upgrade\Cleanup_Elder_Procedures.sql
  6. Upgrade\Cleanup_Procedures.sql
  7. Upgrade\Cleanup_Сonstraints.sql
  8. Upgrade\Cleanup_Tables.sql
  9. Upgrade\Upgrade_Schema.sql
  10. Upgrade\Upgrade_Help_Functions.sql
  11. Upgrade\Upgrade_Data.sql
  12.  REQUIRES MANUAL EDIT: open Upgrade\Upgrade_Content_Entries.sql and replace {API_URL_PLACEHOLDER} with the URL to your API website (include http or https and do not add a trailing / at the end)
  13. Upgrade\Upgrade_Schema_Cleanup.sql
  14. Patch\Checkbox_Patch_Schema.sql
  15. Patch\Checkbox_Patch_Procedures.sql (**If you encounter a warning about a missing stored procedure 'ckbx_v7_sp_Security_ListAccessibleFolders', you can safely ignore this warning.)
  16. Patch\Checkbox_Patch_Help_Functions.sql
  17. Patch\Checkbox_Patch_Data.sql
  18. Patch\Checkbox_Patch_Schema_Cleanup.sql
  19. REQUIRES MANUAL EDIT: open Patch\Update_Product_Version.sql and replace {VERSION_PLACEHOLDER} with 7.0

Upgrade your Messaging Database

Note: This might be the same database as your core Checkbox Survey database.

  1. CleanInstall\Email.sql
  2. Patch\Messaging_Patch_Schema.sql
  3. Patch\Messaging_Patch_Procedures.sql
  4. Patch\Messaging_Patch_Data.sql


Verifying a Successful Upgrade

Once all scripts have been successfully executed, you will want to log into your account and ensure that no errors are received. We recommend fully testing all functionality using your test environment prior to upgrading your production environment.


Article is closed for comments.