Proprietary

OptaSense OS5.11 Manual – Module 5

Installing OptaSense OS5.11
Valid for OS5 versions 5.11 until superseded

Date: February 2021

Issue: Issue 2

OptaSense Ref: OptaSense/ISM/968

© OptaSense Ltd 2021 OptaSense® OS5.11 Manual - Module 5

 Proprietary OptaSense/ISM/968 – Issue 2

Amendment Record
Issue Change Reason for Change Date
Request
1 N/A First Release January 2020
2 N/A Logo Update February 2021

Contact:
support@optasense.com

The document contains information proprietary to OptaSense® and whose unauthorised disclosure would cause damage
to the interests of OptaSense®. Requests for permission for wider use or dissemination should be made to your
OptaSense® account manager.

Specification is liable to change without warning – please contact OptaSense® for latest version.

Reference: OptaSense/ISM/968

Copyright © OptaSense® Ltd 2021, Cody Technology Park, Ively Road, Farnborough GU14 0LX

Proprietary
© OptaSense Ltd 2021 1 OptaSense® OS5.11 - Module 5
 Proprietary OptaSense/ISM/968 – Issue 2

Contents
1 Introduction & Preparation ................................................................................................. 3
2 Preparing for the Install or Update of OS5 Software ............................................................ 4
OptaSense Software Install or Update ........................................................................................................ 4
3 Installing OptaSense ........................................................................................................... 5
4 First time install OS5 specifics ............................................................................................. 7
Starting OptaSense OS5 .............................................................................................................................. 7
Applying a System Licence ........................................................................................................................ 12
5 First time running on a new CU ......................................................................................... 13
Starting OptaSense OS5 ............................................................................................................................ 13
5.1.1 Accounts and Roles ............................................................................................................................... 13
5.1.2 Threats / OPS Filtering .......................................................................................................................... 14
5.1.3 General System Configuration .............................................................................................................. 15
5.1.4 Login ......................................................................................................................................................... 16

Proprietary
© OptaSense Ltd 2021 2 OptaSense® OS5.11 - Module 5
 Proprietary OptaSense/ISM/968 – Issue 2

1 Introduction & Preparation

This module covers both the first-time installation of the OptaSense software, as well as updating the software
to the latest release.

Proprietary
© OptaSense Ltd 2021 3 OptaSense® OS5.11 - Module 5
 Proprietary OptaSense/ISM/968 – Issue 2

2 Preparing for the Install or Update of OS5 Software

Make sure that before you install or upgrade a system, you have a current and complete backup of
the OptaSense Software and config. Some or all of the following may be required to affect an
installation:
• The OptaSense complete configuration which can be exported via the wizard, OptaSense
OS5.11 Manual – Module 6 – Configuration Wizard User Manual for full details.
• The system description file.
• System maps. These will either be kept in the config folder for standalone installations or
on the C: drive of the CU for networked installations. Maps are normally stored in a maps
folder. Observe the full folder path when copying to other CUs.
• On first installation or upgrade the system will require a license. However, the software
will provide the necessary information required to gain a licence.
• A copy of the latest setup application – please contact OptaSense for a link to the latest
software release.

OptaSense Software Install or Update

OptaSense regularly release major and minor updates. The process for installing both is the same,
unless there have been hardware configuration changes in which specific upgrade notes will be issued.
In all cases the series of actions to perform are the same.
Note: If you are installing OS5 to an additional CU only and not to the entire system then the system
does not need to be stopped. Instead proceed directly to the next section.
Prior to installing the software or a new version of the software the following actions should be
undertaken:
• Read the release notes carefully to check for any specific installation instructions and
compatibility issues.
• Check that the system is complete and that all nodes are in communication with each
other. This can be done either via command prompt and pinging, or with the network
checker1.
• Uninstall the previous release of software from all CU’s connected to the system if
applicable.

1
If the System is not complete, please consult with OptaSense on the ramifications of installing to a semi
complete system prior to taking any action.

Proprietary
© OptaSense Ltd 2021 4 OptaSense® OS5.11 - Module 5
 Proprietary OptaSense/ISM/968 – Issue 2

3 Installing OptaSense
If you are installing OS5 onto a new, clean CU, then you do not need to change any system
functionality and the new CU can join the existing installation.
The process for installing is as follows:
• Insert a USB memory stick with the required OS5 setup application.
• Navigate to the USB memory stick on the CU and double click on the setup application.
• A ‘User Account Control’ window may open asking ‘Do you want to allow the following’
program from an unknown publisher to make changes to this computer?’ Select ‘Yes’.
• The OS5 setup wizard will start (Figure 1). Select ‘Next’.

Figure 1: OptaSense 5 Setup Window

• The ‘Choose Install Location’ window opens (Figure 2). The destination folder is already
populated. Select ‘Install’.

Figure 2: ‘Choose Install location’ window

Proprietary
© OptaSense Ltd 2021 5 OptaSense® OS5.11 - Module 5
 Proprietary OptaSense/ISM/968 – Issue 2

• The software will then be installed at the chosen location.

Figure 3: Software Installation

• An option to have the software ‘automatically start on log in’ appears next. This is set to
the preference of the operator client.
• The ‘setup wizard completion’ window opens (Figure 4). Select ‘Finish’.

Figure 4: Completed Setup Wizard

• Repeat these steps for every other CU on the system

Proprietary
© OptaSense Ltd 2021 6 OptaSense® OS5.11 - Module 5
 Proprietary OptaSense/ISM/968 – Issue 2

4 First time install OS5 specifics

The following items will only need to be applied during a first time install and will not need to be
applied during an update or when an additional CU is added. If these actions have been completed
skip ahead to the next section.

Starting OptaSense OS5

The following steps need to be followed to configure the system.
• Run the OptaSense software by selecting the ‘Operator Interface’ from OptaSense 5.11
folder in the apps section of the windows start bar.

Figure 5: Windows 10 Start Bar

• The user will then be presented with a screen as shown in (Figure 6). This window
summarises the change history for the previous software versions, as well as providing the
latest release notes for the version that has been installed. The user must click ‘view’ to
launch the Release Notes and the user must read these notes to ensure they are aware of
the most recent changes.

Proprietary
© OptaSense Ltd 2021 7 OptaSense® OS5.11 - Module 5
 Proprietary OptaSense/ISM/968 – Issue 2

Figure 6: OS Change History Screen

• These key files can be recovered from the ‘System Information’ button for reference.
• Once the user has read and understood the release notes, select ‘Continue’.
• The software will then begin to launch. The first input required by the software is the IP
address for a node. Enter any node IP address from the approved ND.

Figure 7: Enter IP Address Screen

• For new installations, the below screen will be observed.

Figure 8: New Installation Screenshot

• The installation will then ask the user for the config for the new system. If the user selects
‘Advanced Setup’ this will make the ‘Let Software Use Defaults For Any Missing Files’
option available. The default for this option is the software will use default settings for
missing files.
• For new configs that have been created using the config creator, it is recommended that
default settings be used for missing files.

Proprietary
© OptaSense Ltd 2021 8 OptaSense® OS5.11 - Module 5
 Proprietary OptaSense/ISM/968 – Issue 2

Figure 9: Select Config Screen

• Once the config has been selected, the software will then ask for the NTP Server IP address.
The user should enter the node IP address as illustrated in the approved system ND. In
OS5.11 the use of an NTP server is mandated – this will either be a system wide NTP server
provided by client or the use of an OptaSense provided GPS/Modem unit enabled for NTP
functionality.
• Next, the user should select choose a ‘Replication Factor’. Information is provided on the
choice of replication factor below. OptaSense 5 uses a distributed database, the user has
the option as to how far this is distributed. The best option for most systems (especially
small ones) is to aim for 100% replication. There are some circumstances in larger systems
where a less than complete replication factor is required – for more information please
consult with OptaSense staff.

Proprietary
© OptaSense Ltd 2021 9 OptaSense® OS5.11 - Module 5
 Proprietary OptaSense/ISM/968 – Issue 2

Figure 10: Enter NTP Server Screenshot

• The software will then compare the CU time with the NTP server time. If the two have a
time difference greater than 900ms, the software will then reduce the time difference so
that it is below 900ms. This may take some time depending on the difference.

Figure 11: Configuring NTP Screen

• Once the NTP configuration has completed, the software will begin to configure and
finalise the software installation.

Figure 12: Configuring Software Screen

• With the software configured, the user will be prompted with the screenshot as shown in
(Figure 13). This screenshot illustrates the connectivity of each of the IU’s for the system.

Proprietary
© OptaSense Ltd 2021 10 OptaSense® OS5.11 - Module 5
 Proprietary OptaSense/ISM/968 – Issue 2

If required, the setup details of the IU can be edited in this window in order to connect to
the IU.

Figure 13: IU Connectivity Window

• Once the configuring of the IUs has been completed, the user should select ‘Continue’ to
complete the software installation.

Proprietary
© OptaSense Ltd 2021 11 OptaSense® OS5.11 - Module 5
 Proprietary OptaSense/ISM/968 – Issue 2

Applying a System Licence

Once the software runs, the licence expired, or missing window will appear. Select ‘Save System
Information’ this file should be saved and sent to licences@optasense.com

5.10.0

10

Figure 14: Licence Window

Having received the licence from OptaSense, drag and drop the file into the licence window illustrated
in (Figure 14). If the licence has been accepted the following window (Figure 15) will appear, indicating
that it was successful and the length of time remaining on the licence. This will be shown as a number
for temporary licences or as ‘∞’ for permanent licences.

5.10.

10

Figure 15: Accepted Licence Window

Once this is complete the Wizard will launch – proceed to the (Section 5) First time running on a new
CU to configure the system specifics that appear as a first time run on every new install.

Proprietary
© OptaSense Ltd 2021 12 OptaSense® OS5.11 - Module 5
 Proprietary OptaSense/ISM/968 – Issue 2

5 First time running on a new CU

The following items will only need to be applied when running for the first time on a new CU or a
first time install.

Starting OptaSense OS5

A feature of the latest software is an easy to use wizard to configure several aspects of the software.
The following is a description of each section of the wizard and how these are used to configure the
system (Further information is available in OptaSense OS5.11 – Module 6 - Configuration Wizard User
Manual)
1. Section 1 is used to configure Accounts and Roles.
2. Section 2 shows what Threats will be shown on the CU. The second tab allows the user to
select which OPS are displayed on the CU.
3. Section 3 defines the login type for the current configuration. Either an offline or online
account can be chosen. As online logins are no longer supported, offline login must be
selected.
4. Section 4 is the General GUI configuration, this allows the User to allocate the memory for the
CU.

5.1.1 Accounts and Roles

The Account Management Category enables the operator to modify the user login parameters. The
Login Type section allows the operator to select whether the user authorisation when logging on is
completed.

Additional users can be added in the User Configured accounts section by selecting ‘Add User’
similarly users can be edited or deleted in the same way.

Figure 16: Section 1 of the installation wizard

Proprietary
© OptaSense Ltd 2021 13 OptaSense® OS5.11 - Module 5
 Proprietary OptaSense/ISM/968 – Issue 2

Once the admin has created a role they can then click on the associated ‘Commands’ and ‘Windows’
button. The ‘Commands’ allows you to select what privileges that role has. The ‘Windows’ button is
to select the windows the role is entitled to use. These can be edited by selecting the icons.
Note: Grey refers to not being displayed on the toolbar and full colour means that the icon will be
present.
It is recommended that the “Setup Wizard” is added to the OptaAdmin Toolbar. Right clicking on
the icon will bring up the advanced Toolbar settings, allowing the user to disable the button and
restrict the number of windows allowed. This can be seen in (Figure 17).

Figure 17: Toolbar Selection

5.1.2 Threats / OPS Filtering

In the ‘Threat / OPS Filtering’ category the operator has the ability to deselect the alert types which
they do not want to be displayed (Figure 18). This is specific to the CU the software is being installed
on and enables the operator to display only the alerts required and alert level to be visible on the CU.

Proprietary
© OptaSense Ltd 2021 14 OptaSense® OS5.11 - Module 5
 Proprietary OptaSense/ISM/968 – Issue 2

Figure 18: Threats / OPS Filtering

5.1.3 General System Configuration

The ‘General System Configuration’ category enables the operator to modify the user login
parameters. The Login Type section allows the operator to select whether the user authorisation
when logging on is completed either online or offline. All user login types must be Offline, as illustrated
in (Figure 19).

Note: Online logins have been retained for legacy systems.

Figure 19: Offline Login

Proprietary
© OptaSense Ltd 2021 15 OptaSense® OS5.11 - Module 5
 Proprietary OptaSense/ISM/968 – Issue 2

5.1.4 Login
With all the settings saved, the user can then proceed to logging into the OptaSense software (Figure
20).

Figure 20: OptaSense Login Screen

Proprietary
© OptaSense Ltd 2021 16 OptaSense® OS5.11 - Module 5