Checkbox 7 - On-Premises Upgrade Guide

This document will guide you through upgrading your Checkbox On-Premise installation from version 6 to version 7.

Important Note: This document applies to version 7.10.0 or later. If you are using an older version, please download a newer version from your customer portal.

If you are installing Checkbox for the first time, please see the Checkbox 7 - On-Premise Installation Guide instead.

Important Note We do not recommend upgrading your production environment until you have conducted extensive testing in your Checkbox test/development environment.

Requirements / Prerequisites

Please review the following BEFORE starting the upgrade process.

Current installation MUST be running Checkbox version 6

If you are currently on Checkbox version 4.x or 5.x, you must first patch or upgrade to version 2018Q2 before upgrading to version 7.  

Server requirements for Checkbox 7

Before beginning the upgrade, please ensure that your server environment meets at least the minimum system requirements for Checkbox 7.  Depending on the volume of survey data that you collect and the size of your surveys, you may find that you will need more powerful hardware to achieve optimal performance.

 

COMPONENT

MINIMUM REQUIREMENTS

Operating System

32 and 64 bit versions of Windows Server 2008 R2, 2012, 2016, 2019

Web Server

Microsoft Internet Information Server (IIS) 7.0 or higher with AT LEAST 4 GB RAM*; Important: check the IIS module requirements to make sure that you have the proper IIS components enabled on your server.

Database

Microsoft SQL Server 2008, 2012, 2014, 2016. SQL Server Express Editions also supported**

Cloud Hosting

Amazon EC2, Amazon Elastic Beanstalk, Azure Virtual Machines, Rackspace Cloud Servers. Checkbox supports virtual machine environments on Microsoft Azure and Rackspace. Checkbox does NOT support  Rackspace Application hosting tools.

Browser

Microsoft Internet Explorer 11 or higher; Microsoft Edge, most recent versions of Chrome, Firefox, Safari***

Privileges

Administrator access to Web Server and Database Server required for installation.

Disk Space

1GB for application installation and base database; Overall database size depends on the number of surveys, users, and responses.

ASP.NET

.NET 4.6.1

Email

Checkbox supports using SMTP or Amazon Web Services SES for sending system emails, including survey invitations.

 

IIS / URL Requirements

Checkbox 7 On Premises supports two installation approaches:

  • Option 1: A single URL and IIS web site (default / recommended)
    This approach requires a single URL, e.g. https://www.yoursite.com, and then installs each of the three applications in virtual directories/folders so that the end result is that you have https://www.yoursite.com/api for the API, https://www.yoursite.com/admin for the Checkbox admin app, and https://www.yoursite.com/surveys for the site used to take surveys. 
     
  • Option 2: Three URLs and three IIS web sites
    This approach requires three unique / valid URLs. Each Checkbox site is configured with the application in the root of the URL. This approach is generally useful for scenarios where you'd like to install each Checkbox app on a different server or have more granular control over the settings or amount of system resources used by each applicatiaon.

SSL
We highly recommend that you use SSL on your Checkbox sites. Note that you cannot use SSL on some of the web sites -- it is all or nothing.

Valid License File

Obtain a valid Checkbox 7 license file (.lic file). For trial customers, there is a 30 day license included in the trial download. For licensed Checkbox customers, please download a Checkbox 7 license from your customer portal.

Upgrade Instructions

Step 1: Stop Checkbox 6 and related services (if applicable)

If you are upgrading a production environment or database that is being actively used by Checkbox 6, you must stop these web sites AND the Checkbox Messaging Service prior to starting the upgrade process. 

Once upgraded, you cannot run your old installation or its messaging service against the upgraded databases. 

Failing to do either of these will result in data corruption or loss and Checkbox Support cannot assist you in supporting your installation.

Step 2. Backup your Checkbox databases.

This is a crucial step. If any errors or issues arise from this upgrade you will need to immediately revert the upgrade. 

Backup your Checkbox database using a "Full" SQL backup. If you use a separate database for the Checkbox Messaging Service, you should back this up as well.

Please consult the Microsoft SQL Server documentation or talk to your database or IT administrator to perform this step.

Step 3: Move the Checkbox files to a location of your choice

Move all of the files contained in the Checkbox zip file into a location of your choice. The default location for IIS is c:\inetpub\ and using a folder under this location will generally be easiest in terms of configuring permissions. If you choose another folder, make sure that the IUSR has read and execute permissions.

IMPORTANT NOTE: The installer does NOT move the files. The placement of the files in this step is what will be used for the installation.

Step 4: Install the license files

You will need to place your Checkbox 7 license file in both the API\bin folder and CheckboxService folders. Please do this prior to running the installer.

Step 5. Run the Checkbox Installer to configure your installation and upgrade your database

You should perform this step on the server that you wish to install Checkbox on. Run the .exe file named “Checkbox-Installer.exe” in the root of the Checkbox 7 zip file. This application will request important settings information about your installation that will be used to configure the web applications and service for you. 

This step requires the following information:

  • The URLs that you will use for Checkbox.
    These should be valid domain names that are already configured / have DNS entries that resolve to the server you are installing on. If you’d like to use SSL (and have a valid SSL 
    certificate installed), you may use HTTPs.
  • Database connection information
    You should have the database hostname, username, password, and database name for both the core Checkbox database and the Messaging database.
  • SMTP or Amazon SES credentials
    This is required in order for Checkbox to send emails.

When you run the installer make sure to choose the "Upgrade" option to upgrade your Checkbox v6 database.

The Checkbox 7 installer will upgrade your database in its last step. Once this completes without error, you can move on to the next step. 

Please note: Windows Management Framework 4.0 is required to run the installer. If your system does not have it installed, you can install it from http://www.microsoft.com/en-us/download/details.aspx?id=40855

Step 6: (Optional) Enable Write Permission for the Logging Folder

By default, Checkbox writes error log files to the local disk in API\App_Data\Logs (if these folders don't exist, please create them).

You will need to give the Application Pool user write permission to this folder for this functionality to work correctly. Follow the "Default Logging Configuration / Installation Step" in the Configuring Error Logging instructions.

You can complete this step later if you'd like.

Step 7: (Optional) Add reCAPTCHA keys

If you'd like to use the reCAPTCHA survey item (used to stop spam survey responses), you'll need to follow the reCAPTCHA configuration instructions.  Note that this step can be completed at a later time if you'd like.

Step 8: Confirm that the Checkbox Admin app login page is available.

Once the sites have been configured in the previous step, the application should be available. You will want to navigate to your [AppURL]/login page. You should see a login page asking for a username and password.

You can now log into Checkbox using the same admin credentials as Checkbox 6

0 Comments

Article is closed for comments.