Upgrade Guide

Steps to complete in order to do an upgrade of your current installation. Please note that customizations may exist in your environment that are not documented here.

Introduction

This document is to assist with the upgrade of the SMTX solution SSP to the newest version. This upgrade requires a number of standard steps. Additional steps, specific to your environment can be added to the checklist at the bottom of this document.

Upgrade Proces

The checklist below shows all steps to be executed in order to complete the upgrade to the latest version. Please complete each step before continuing to the next steps.

Preparation

• Download the default.zip and customerspecific.zip files from the SMTX software website

  • The download files are over 500MB, so please make sure to do this step well in advance.

• After download, check that the downloaded files aren't marked as "Blocked" by windows.

  • Go to the file properties in Explorer and check on the first tab if the option Unblock is displayed.

  • Unblock the file when being displayed.

  
• Check System health

  • Verify that the system is currently working correctly in order to avoid a long search after upgrade for issues not related to the upgrade. ​

• Backup Database

  • Make a backup of the database to be upgraded. ​

• Backup Website

  • Copy IIS application files from your SSP application folder to a backup folder. Do not remove the folder structure. Include the folders Common, Forms, Workflow, KM, Webstore and Ticketing.

  • Please note that the Forms folder can be very large due to attachments stored in this folder. You may want to consider an incremental backup of this folder. ​

• Backup Scheduler

  • Save a copy of the scheduler config file. The folder where the scheduler is installed will be referred to as Scheduler Folder. ​

• Backup web.config

  • Save a copy of the web.config file in the root installation folder. Although this file is not overwritten, it’s a good practice to store this file with the other backup files.

• Copy the downloaded ZIP files to a working folder on the server and extract them.

  • We advise to have a folder called Install and you create subfolders for each version that is installed. Keep the current and previous version as a backup.

• Custom front-end UI

  • In case your organization makes use of a custom front-end, download the update application from the location you received and put the files in the same installation folder as the release files.

Installation

• Start the IIS (Internet Information Services) Manager and stop the SSP web server and stop the windows task running the Scheduler task.

  • Or at least stop the SSP website when more sites run on the server ​

• Copy the folders contained within the \web-update folder to your SSP installation folder.

  • Check the currently installed folders and write these down. You should only copy the folders from the update that currently exist. (for example Common, Forms, Workflow,...)

  • You should overwrite all existing files and folders. The web-update contains no config files and no stylesheet files. If you have done other customizations, you should do them again after this step. ​

  • Do this for both the files contained in default.zip and CustomerSpecific.zip

• Run the database script located in \dbscripts\SQL.sql

  • This script will upgrade your database. Make sure to connect to the correct database using SQL Management Studio and run the script without any modifications. ​

• Go to the \scheduler\scheduledtask-update folder and copy all files and paste them into your folder containing the Scheduler installation.

  • This provides the scheduler with the new application files. You can overwrite all existing files. ​

• Start IIS Let the Windows Task scheduler run again ​the SSP task

Customizations

Please be aware that there might be additional tasks required for your environment. A custom front-end UI may be upgraded. Please refer to any internal documentation if these custom tasks exist.

Testing

• Check Person sync Verification if person data is loaded correctly ​

• Check workflow Test to see if process can be started and updated ​

• Check external interfaces Test if emails can be sent and received and verify that any external interfaces still work. ​

• Check if tasks run without errors (delete the ones not used by particular customer) ​ ​

• Test SSO Single sign On for automatic login ​

• Test attachments Uploading of attachments requires additional folder access rights ​

• Check if log files are created Correct configuration of log files and their location ​

• Check access with non admin user

Rollback

In case you need to roll-back the installation, please follow the procedure below

• Restore database

  • You can’t undo the database changes and therefore need to restore the previously made backup. ​

• Start the IIS (Internet Information Services) Manager and stop the SSP web server and stop Scheduler service

  • Or at least stop the SSP website when more sites run on the server ​

• Open the Windows Services screen and look for the SSPScheduler service.

  • Stop this service. In case you are running the scheduler as a Scheduled Task, pause the scheduled task in Windows. ​ ​

• Copy the folders contained within the folder to your SSP installation folder. ​ ​

• Go to the \common folder and copy all .dll files that have SMTX and BL in their name (about 40 files) and paste them into your folder.

  • This provides the scheduler with the new application files. You can overwrite all existing files. ​

• Start IIS ​ ​

• Start SSPScheduler service or let the Windows Task run again