SurpassLocal - Installer

This article focuses on the SurpassLocal installer and how it can be used to setup, update, and deactivate. Below each of these topics has been described in detail.


If SurpassLocal has not been installed previously on the test centre server, it will automatically launch the install wizard. Here the engineer will provide the install wizard with information so it can deploy SurpassLocal successfully to the test centre server, this includes:

  • CMS Environment
  • IIS Website Information
  • Destination folder
  • Database Information
The installer can also be silently rolled out. To find out more information about how this can be achieved, please read this article.

CMS Environment

The engineer must specify the CMS environment that this SurpassLocal deployment relates to. If this is a production test centre installation, this will be to the address provided in the below dialogue box. However, this installation may be a test or staging environment. If this is the case, you will need to make sure the correct environment is specified here. 

For more information about the supported versions, please see the 'Minimum Requirements for SurpassLocal' article.

IIS Website Information

The information entered within this screen is what will be used when the SurpassLocal website is created within IIS. This is the address the SecureClient will need to communicate with during test delivery, and also makes up the address for the SurpassLocal API.

Destination Folder

During setup of SurpassLocal, files need to be deployed onto the server for the solution to work. The address specified in the destination folder screen is where the root folder of the website will pointed at and where these files will be copied to. This will default to C:\

Database Information

During setup, the engineer will also have to specify the location of the database where SurpassLocal will store its information. This information will be removed 24 hours after it has been successfully synchronised back to Surpass central, and any test sessions that were not attended will be voided off using standard surpass logic, synchronised in this state, and updated in the central service.


If you have already installed SurpassLocal on the test centre server and the engineer runs the file, they will be presented with the option to update or uninstall. With regards to updating the solution, it is worth checking with BTL that the version you have been supplied is currently supported in the environment you are running this in. You will need to ensure the relevant version of Surpass and CMS is in Production before you update a working solution. In certain cases, development may have been done that would require you to ensure all test responses have been synchronised to the central service. Please work with BTL to understand if this is necessary.

Selecting 'next' through the dialogue windows will deploy the relevant files and run the required SQL scripts to update SurpassLocal to the next version. Once this can connect to CMS the version will be updated on the local management tab so this centres version can be tracked by admin users.  

This can also be silently updated. To find out more information about how this can be achieved please read this article.


The other option that an engineer can select if SurpassLocal is already installed is 'uninstall'. This will completely remove the SurpassLocal website, database and any files that were deployed. However, this will only remove SurpassLocal from the test centre; this will still exist in CMS and will still be set up in Surpass as an offline centre, reverting these changes must be done by an administrator in CMS. Please contact BTL if you wish to deactivate a SurpassLocal deployment.

It is important to note as the database is completely removed this will also remove any response or result data that was stored on the SurpassLocal server. Ensure that all data has been synchronised back to the central service before running this, otherwise this could result in data being lost.

We also support the ability to silently uninstall SurpassLocal. To find out more information about how this can be achieved, please read this article.

Feedback and Knowledge Base