SurpassLocal - Setup - CMS and Surpass

This article focuses on the setup of SurpassLocal deployments in CMS, the local management user interface in CMS and any pre setup that needs to take place in the main Surpass solution.

Surpass Setup

Prior to creating a SurpassLocal deployment in CMS a centre has to exist within the main Surpass solution. This is so CMS can link the SurpassLocal deployment to a valid Surpass centre; when this SurpassLocal deployment is in operation, it will only download tests that are scheduled to this Surpass centre. The centre reference field in Surpass will need to match the centre reference supplied in CMS. If you will be using SurpassLocal to deliver tests over multiple instances of Surpass, this reference should match across all other instances.

CMS Setup

There are two methods of creating SurpassLocal deployments in CMS; individually by selecting the "Create New Local Deployment" option, or in bulk using the option "Upload New Local Deployments". This article will focus on creating the SurpassLocal deployments in CMS; once this has been completed, SurpassLocal will need to be installed on the local server. The process that will need to be followed to achieve this has been documented in separate articles depending on the approach your organisation is using. SurpassLocal management is accessed by first navigating to Hub Management, and then selecting the 'SurpassLocal Management' button from your desired hub. If a SurpassLocal deployment is created using the "Create New Local Deployment" option they will need to follow the manual installation process, which will require a SurpassLocal engineer to authorise the installation. If the "Upload New Local Deployments" option is selected, SurpassLocal can be deployed using the automated process. Please find the links to these articles below:

Manual Installation

Automated Deployment

Access to SurpassLocal Management is controlled by the 'SurpassLocal' permission within the User Management screen. Here you can allow both View and Manage permissions for the SurpassLocal Management screens.

Creating a New Local Deployment

By selecting the ‘Create New Local Deployment’ link on the top-left of the page, you will be directed to a page that allows you to create an individual SurpassLocal deployment. You will be presented with several fields that are all mandatory, other than the Installation Key field. Each field has been described in the table below:

  Field

Description

Name

The name of the local deployment.

Centre Reference  

  The unique reference code used to identify the centre the deployment is associated with. The centre reference must match with at least one Surpass instance on the selected hub.  

Engineer Email

The email address for the deployment’s associated engineer. This is the address the installation key will be sent if the manual installation process is followed.  

Enter New Password  

This is the SurpassLocal API user password and must be between 8 and 15 characters.  

Confirm New Password  

Needs to be identical to the previous password.  

Automatic Deployment

Here you will be able to indicate with the radial button whether the deployment is automatic or not.

Installation Key

Here you may enter a custom installation key for this instance of SurpassLocal

When you’re satisfied with your settings, you may then select the ‘Create New Local Deployment’ button to save and exit the page. Once the system has verified that your centre exists within at least one Surpass instance on the hub selected, you will now see the new deployment on the Local Management Table. Please follow the manual installation article for the next steps in the installation process.

Upload new Local Deployments

By selecting the ‘Upload new local deployments' link at the top of the page, you will be directed to a page that allows you to bulk import SurpassLocal deployments. If you are a large scale organisation, adding these individually could be a time consuming operation, so there is also the ability to upload a CSV file that contains multiple SurpassLocal deployments. 

The CSV must contain the centre name, reference, installation key, and password for your local API user. CMS will then validate the CSV file to ensure that the centre references you have provided exist within Surpass, and that the CSV matches the expected format. Other validation will also take place such as the uniqueness of the reference. In the manual installation process, the installation key is randomly generated but you may upload your own install key to help make the deployment process easier. 

Below we have described each of the fields that are required to upload local deployment:

  Field

Description

Engineer Email

The email address for the deployment’s associated engineer. This is the address the installation key will be sent to if the manual installation process is followed.

Upload File

Here you will be able to browse for the CSV file to upload.

Automatic Deployment

Here you will be able to indicate with the radial button whether the deployment is automatic or not.

Local Management tab - CMS

On the Local management tab, you will be able to see a table listing all existing SurpassLocal deployments that have been created. This does not necessarily mean that it has been installed at that centre, but it may have been created using one of the above steps. This local management table provides the user with the ability to see active and inactive SurpassLocal deployments, and the last time these communicated with CMS. This serves as a useful page for an administrator to quickly identity the installation state of the test centres on their hub, or provide operational support, or to see if SurpassLocal is successfully connecting to CMS when diagnosing any issues.

The table below provides more information about each field:

  Field

Description

Actions

Change Password - Change the SurpassLocal API authentication password. SurpassLocal will need to communicate with CMS successfully before these credentials can be used

Deactivate - This should be used if you are looking to uninstall SurpassLocal and change the centre back to deliver "online" tests only. Ensure all tests on the SurpassLocal server have been uploaded before this is selected as tests within the central user interface will be voided, closing off the loop to upload tests using the user interface. If this is not followed, it will require database intervention; in some cases we may not be able to guarantee a successful upload.   

Update Surpass - If you have added a new instance of Surpass to the HUB this button will set up the Surpass centre for offline delivery in this new Surpass instance.

Delete - This will remove the SurpassLocal deployment. Deactivate must be selected before this is available.

Name

The name of the local deployment. By default, the local deployments are organised alphabetically by name.

Hub

Which hub the local deployment is associated with.

Centre Reference

The unique reference code used to identify the centre the deployment is associated with. The centre reference must match with at least one Surpass instance on the selected hub. Ensure centres have been added to Surpass prior to adding this.

Engineer Email

The email address for the deployment’s associated engineer. This is the address the installation key will be sent to if the manual installation process is followed.

Installation Key

The alphanumeric code required for installation of the deployment.

Status

Indicates whether the deployment is active. Inactive states inform the user that it still needs to be installed at the test centre or it is in the process of being deactivated.

Access Date

The date and time SurpassLocal last communicated with CMS. This also displays the latest SurpassLocal version.

 

Feedback and Knowledge Base