Checkbox 7 - On-Premise Upgrade Guide

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

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 6

If you are currently on an earlier version of Checkbox, 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 2008 R2, 2012, and Windows 2016

Web Server

Microsoft Internet Information Server (IIS) 7.0 or higher with AT LEAST 4 GB RAM*

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 uses SMTP or Amazon SES for sending system emails, including survey invitations.

 

IIS / URL Requirements

Checkbox version 7 requires 3 separate web applications / URLs (API, Checkbox Admin, and Checkbox Take Survey Front End) and a windows service (Checkbox Service for messaging) in order to function properly.

Please make sure that you have 3 separate URLs available to run Checkbox. Please note that Checkbox currently does not support running these applications as virtual directories.

If you are unfamiliar with how to set up IIS, here is a link to Granular IIS Requirements .

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: 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 4. Run the Checkbox Installer to configure your installation

You should perform this step on the server that you wish to install Checkbox on. Run the .exe file named “Checkbox-7-Install-UI” in the “installer” directory 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 tool will also generate all of the database tables, stored procedures, and starting data that you need for Checkbox.

The installer will also configure and install the required Checkbox Service, which will allow you to schedule email invitations using Checkbox.

This step requires the following information:

  • The three unique 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. Examples: http://checkboxadmin.yourdomain.com, http://checkboxapi.yourdomain.com, and http://checkboxsurvey.yourdomain.com . If you’d like to use SSL (and have a valid SSL 
    certificate), 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.

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. 

Step 5. Set up the Checkbox 7 websites in IIS

As mentioned in Step 3, you will need to create three distinct websites within Internet Information Services Manager (IIS) (using the .NET 4.0 CLR). Checkbox cannot run as virtual directories or Applications within a single website.

Important Note before modifying IIS in the steps below: If you are not familiar with setting up web sites in IIS we suggest that you consult your IT administrator.

When you create each site, the bindings/hostname for each site must match the value supplied to the installer in Step 2.

Be sure to define the Physical Path properly when configuring each site in the IIS:

  • The Checkbox API site should map to the “API” folder.
  • The Checkbox Admin site should map to the “app-admin” folder
  • The Checkbox Take Survey site should map to the “app-take-survey” folder

In addition, you will also need to properly configure file permissions so that the IUSR has read/write/execute permissions for folders listed below. For that reason, we suggest that you install put these folders in the wwwroot (typically c:\inetpub\wwwroot) as they typically have the correct permissions.

Step 6: 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

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.