SurpassLocal - Setup - Manual Installation

This article will explain the process of manually installing SurpassLocal. Before installing SurpassLocal, an instance must first be configured within CMS; please contact BTL Service Desk to set up this instance. Further information about setting this up can be found in this article. Below is a diagram to help show the flow of a standard SurpassLocal installation. 

Once the instance has been set up, an email will be sent to the specified SurpassLocal engineer which will include an installation link to an EXE file. If this is not provided, please request the installer from the BTL Service Desk. This file will be used to install SurpassLocal on the test centre server.

Your Local engineer will then need to run the SurpassLocal installer file that was provided in the previous email, specifying the location of the database and the virtual website that will be created in IIS. Further information about the installer and the steps required can be found here.

The SurpassLocal connection wizard will then be launched. Here the engineer will check the diagnostic page to see if there were any errors during installation, enter the installation key that was provided in the initial email, and specify any relevant proxy settings before being shown a summary.

Once you have installed SurpassLocal, the connection wizard will be automatically launched. The following screens are presented to the engineer in the connection wizard:
  • Diagnostic Page - Any issues that occurred during installation will be highlighted here.
  • Installation Key - This screen provides the engineer a method of entering the installation key that uniquely identified this SurpassLocal deployment.
  • Proxy Settings - If your local test centre has a proxy server in place this screen provides the engineer the ability to enter these details so they can be stored against this deployment.
  • Summary - A final chance to review all of these settings before SurpassLocal attempts to create a connection with CMS.

If all of these settings are okay, SurpassLocal will communicate with the Customer Management System and send a second email to the engineer. The engineer will then need to click the link in this email, which will then notify CMS to update this SurpassLocal deployment as "Active". Clicking this link will also authorise CMS to call Surpass to update the centre to be authorised to deliver SurpassLocal tests; this will be done for each instance of Surpass for the hub the SurpassLocal deployment was associated to. Once CMS has successfully set up the centre in Surpass, the SurpassLocal engineer will be re-directed to an activation page, as seen below.

SurpassLocal is now fully activated and will poll Surpass to download tests that have been scheduled for that centre and for "offline" delivery. See the operation article for further details on what happens during the synchronisation process.

Another method to check that your SurpassLocal deployment is active is to visit the SurpassLocal API help page this should be accessible once an installation is complete. This will be available at the IIS address that was specified during installation. http[s]://[hostname/ip]:[port]/ 

Feedback and Knowledge Base