Prerequisites

Ocularis Media Server (OMS)

Note: Quognify recommended that the OMS is hosted on a stand alone server.
Please see https://onssi.com/hardware-recommendations/#hd_recommend06 or speak to your Quognify Representation for detail including OMS Server Memory & CPU requirements.

Your Qognify Web API user account (what you will use to login via Sureview) needs to have at least Login to Ocularis Web/Mobile Enter Browse Mode as well as having access to a Camera Privilege Group containing the active cameras you want to stream.

You must be able to load the Qognify Web Interface and stream cameras from the Sureview Device Server locations. (Default port 9090)

 

---

Qognify Sureview Network Diagram

 

---

Configuration in Qognify Ocularis

The following are the steps required to configured this system to work with the Sureview.

Before you begin

Before you configure your Qognify Ocularis system to work with Sureview make sure you have the following:

• The Qognify Ocularis Software installed with a valid licence
• At least 1 camera setup on the system
• OMS 3

Onssi Ocularis Port Configuration

The default port for the Web API is 9090, if necessary this can be changed by editing settings.ini file located in  C:\Program Files\OnSSI\Ocularis Media Server\OcularisMediaServer.

Note: Qognify do not recommend changing this port.

Configuration Options

Setting Name	Default Value	Purpose
QognifyVideoConnectionRetryCount	3	Number of times the integration will attempt to get video before throwing an error
QognifyVideoConnectionDelay	5	Time period in seconds wait before retrying the video connection
QognifyAuthenticationServicePort	80	Port to send commands to the Authentication Service
QognifyAuthenticationServiceUseHttps	false	Use https protocol or http
QognifyPaneIdUpdateInterval	60	Time period in seconds to tell the Authentication service that the integration is still connected.
QognifyVideoStreamHeartbeatInterval	30	Time period in seconds to send a request to the Qognify Ocularis server to tell it to keep the video stream active.

 

How do I add/edit users and groups?

See the Ocularis Administrator User Manual available here https://onssi.com/documentation

General Configuration

For general help on configuring Qognify Ocularis please refer to Qognify's documentation provided here.

Configuration in Sureview

The following are the steps required to configured this integration in the Sureview interface.

Before you begin

Check that the Sureview Server can access the OMS Web API, and that live video can be seen. If there are no working cameras through the Web API interface, it will not work in Sureview.

Go to the Qognify Web API Interface, via a web browser on all Sureview Device Tier Servers. This can be accessed using the server host/IP and the configured port (default is 9090). You should get the login screen.

Log in with the username and password for the Qognify Ocularis Web API (the same details you will use in Sureview)

You should then see the following screen, with live video from any cameras that are configured.

Before you configure Sureview to work with Qognify Ocularis make sure you have the following:

• Open ports on your Sureview server
• Username and password of your Qognify Ocularis Web API
• A root site must be setup so the authentication Service can use the connection details to setup an authentication token.

Authentication Service Setup

The authentication service can be installed through the Sureview installer to run on the same machine as Sureview and must be installed for each Sureview Device Tier Server. Configuration settings such as host, port, username are retrieved through Sureview. The authentication service it self is configured to run under http(s)://localhost.

The authentication service has a configuration file that allows customisation of some settings:

Setting Name	Default Value	Purpose
SessionKeepAliveOverride	false	When set to true the authentication service will use the SessionKeepAliveHeartbeat setting below to heartbeat authentication tokens instead of the value returned from time period returned from server.
SessionKeepAliveHeartbeat	60	Time period in seconds to send a request to keep the authentication token alive.
AuthenticationRequestTimeoutSeconds	60	Time period in seconds to allow retrieval of an authentication token.
ApiRequestTimeoutSeconds	30	Time period in seconds to allow for all other API commands
AuthenticationRequestRetrySeconds	60	The time period that will be waited following a failed token request before making a new request.
ExpiredPaneIdCheckInterval	60	The period at which the service will check for panes that are no longer being used by and connected integrations, so they can be cleared and reused

Device Setup

Field	Value
Host	Qognify Ocularis Host
Port	Ocularis Port (Default : 9090)
Username	Qognify Ocularis username
Password	Qognify Ocularis password
Extra Value	Any parameters you wish to include

Extra Value/ Parameters

Extra value text is used to provide a grouping option for the cameras in the Qognify Ocularis. This is to be used to group cameras to a specific site based on the camera naming convention.

There are 3 types of grouping available : 

Exact grouping	using this method cameras will be grouped based the camera name exactly matching the specified value (case insensitive).
Prefix grouping	using this method cameras will be grouped based the camera name starting with the specified value.
Wildcard grouping	using this method cameras will be grouped based the specified value appearing anywhere in the camera

 

The extra value parameters supported by Sureview are displayed in the table below.

Parameter	Extra Value Text	Example
Camera Grouping	cameragrouping=value	cameragrouping=Swansea Front Door Camera Will only match a camera with this exact name.
	cameragrouping=value*	cameragrouping=Swansea* Will match all cameras starting with Swansea. Eg. Swansea Front Door Camera, Swansea Side Door Camera, Swansea Car Park Camera
	cameragrouping=*value*	cameragrouping=*Front* Will match all cameras containing Front. Eg. Swansea Front Door Camera, Tampa Front Door Camera

*** Only 1 Camera Grouping Parameter can be used per site ***

*** Providing no grouping option with default to all cameras being imported into the site ***

 

Using Site Syncing (Feature compatible license required)

The following steps give a basic overview of syncing an Qognify Ocularis System with a site within Sureview.

 

Site Syncing 

Site Syncing will allow for Sureview to automatically get the cameras from Qognify Ocularis and add them into Sureview.

Go to Sync > Sync Systems > Add Sync System

Once the device has been added to Site Syncing you will need to Go to Sync > Sync Entries > Add Sync Entry

Sync System	Valued to be used to match and import cameras
Identifier	cameragrouping

 

Site Syncing is not returning any cameras

Do you have an Qognify Ocularis setup, with a valid licence and have working cameras through the native interface?

Have you setup a root site in Sureview with valid host, port, username and password?

Have you setup the Sync System as per instructions above?

Do you have the authentication service installed and running?

Are you running Sureview version i28

 

 

How do I force a sync?

To force a re-sync edit an applied sync system and click "Update". The sync setting will be synced immediately.

Connection to get an authentication token is timing out

Increase the timeout period in the authentication service configuration file and try again

 

There is no live video being returned in Sureview

Check the Qognify Web Interface using the same login detail that are set up in Sureview. Check to see if it is also having connection issues with the camera, if so it is likely that the device is having issues.

If the camera is working via the Web Interface, check the router service is running and possibly check the router log for any indication that there might be a connection issue.