topics in this document - onssi · of this document has been updated to include the motion...

Technical Notes for Ocularis 5.2

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 1

The purpose of this document is to provide technical details for various new features in the Ocularis 5.2 release. This version of this document has been updated to include the Motion Detection Filter feature introduced in the September 2016 recorder patch.

Topics in this Document Update Service......................................................................................................................................................................... 1 Record on Motion ................................................................................................................................................................... 18 Motion Detection Filter ........................................................................................................................................................... 21 Recorder Migration Tool ......................................................................................................................................................... 22 Camera Replacement Tool .................................................................................................................................................... 27 Keyword Quick View .............................................................................................................................................................. 33 Updates to NAT Configuration ............................................................................................................................................... 35

Update Service The Update Service is a service that will automatically check online for software patches to recording system components and download the update if it is available. Ocularis version 5.2 expands this service to include not only the automatic distribution of recorder patches but also recorder software application updates. If you have a valid StayCurrent plan, you can configure the system to upgrade your enterprise from version recorder version R7 (included with Ocularis v5.1) to recorder version R8 (included with Ocularis v5.2) automatically.

Recorder patches are typically made available once per month but may be scheduled more often. By default, the system will check for the update nightly at 3:00 a.m. and if found, will download and install software for the recorder components. These settings may be modified. Software upgrades are released less often, typically twice per year.

Ocularis Recorder

(Master Core)UpdateService SVR

(VMS_UPDATESVR)

Ocularis Administrator +Ocularis Recorder Manager

Update Service Agent(VMS_UPDATER)

Ocularis Base Ocularis Client

IP Video Cameras IP Video CamerasEncoder

Slave Core +Failover

Ocularis Recorder(Device Manager)

Update Service Agent(VMS_UPDATER)

DM

Base

DM

Ocularis Recorder

(Device Manager)Update Service Agent

(VMS_UPDATER)

Core

Ocularis Client

Core

Figure 1 Sample system layout

There are two components to the Update Service: the Update Service SVR (Server module) and Update Service Agent (Client module). By default, the Update Service SVR service will be installed on the Master Core (unless unchecked using the 'Custom' installation option). You may also install this service on a separate server, however there should be only one instance



of the Update Service SVR module in an ENT or ULT system. For PRO, the Update Service SVR service should be installed on each Master Core Server (it will be installed by default).

Components installed on remote/satellite PCs will have an Update Service Agent installed by default. This allows the Update Service SVR (VMS_UPDATESVR) to communicate and push any updates out to Agents (VMS_UPDATER) on the remote machines.

Therefore, if you decide to use the default and include the Update Service SVR (Server) on the Master Core server, use either the 'Manager & Server' installation option or 'Custom' option during software installation or upgrade. With the 'Custom' installation option, be sure that 'UpdateService' is among the checkboxes selected during installation.

If you choose to install the Update Service SVR (Server) on a server other than the Master Core, be sure to use the 'Custom' option and that 'UpdateService' is among the checkboxes selected when installing the Update Service.

Once the Update Service SVR option is installed, if you decide to use the 'Custom' installation option to install other components, the 'UpdateService' should be unchecked (since it is already installed on the Master Core computer).

The Update Service uses port 63000 and 63001. It is advised to keep these default values. If you need to change these port numbers, please contact OnSSI Technical Support prior to doing so.

UPDATE SERVICE CONFIGURATION TOOL This tool manages the configuration of the Update Service on the Master Core Server (or whereever the server service is installed) as well as the Update Agents installed on the other recorder components. The configuration tool is installed automatically with the Update Service server component. This configuration tool can:

Display all connected Update Agents (Clients), their hardware specifications, installed features and applied patches of each Update Agent

Display status information of all Update Agents in a group Be used to create groups of Update Agents to configure Be used to rename and delete groups and obsolete Update Agents from the configuration Import and export download packages and patch files for the Update Service Configure how to deploy recorder update patches Check for updates online

CONFIGURE THE UPDATE SERVICE 1. On the computer with the Update Service SVR (server component), which is by default the Master Core Server,

launch the Update Service tool from the Windows menu:

Start All Programs OnSSI Ocularis Recorder Ocularis Recorder UpdateServer configuration tool

2. If required, confirm the system's administration privileges. The 'Information' tab is displayed.



Figure 2 Information tab

3. On the left is a tree folder structure where you can create a hierarchy of logical groups. The 'Default' group contains all Update Agents not assigned to another group.

4. Click a group folder to display the status overview of all Update Agents (Clients) in that group. Colorful bullets indicate the status of each:

Red - an error occurred at the client or the Update Agent of the client is offline for more than 3 minutes. Yellow - the Update Agent is currently busy (patching, downloading, etc). or waiting for an event

triggered by the Update Service SVR (e.g. manual distribution of patches). Green - the Client's Update Agent is up-to-date

5. Click a client name to display the installed components, the system software, the software version , the status and the installed patches.

6. Click 'Refresh' to refresh the list to a more current status.

7. Click 'Configure group' to create, rename or delete a group and specify the group's update settings. Using groups allows you more control over the update configuration. See Configure A Group below.

8. Click 'Delete clients' to remove clients from the configuration tool.

We recommend using groups to manage the distribution of software since they provide you with more control over the update.

Manually Triggering an Action If a group is configured to be updated manually, a button 'Start patch/update at the UpdateAgents' button is displayed in the group's status pane.

Click the button 'Start patch/update at the UpdateAgents' to start the update. It will require up to 60 seconds before the update process is started.

CONFIGURE A GROUP When you click 'Configure group', a group configuration screen appears.



Figure 3 Group Configuration

We recommend taking advantage of organizing your system with groups. Create a group (based on location or network bandwidth, etc.) and then select Clients (UpdateAgents) as members of that group. You can, for instance, group all clients that have a low bandwidth connection in a specific group. Or you can put all New York clients in a 'New York' group and all New Jersey clients in a 'New Jersey' group, etc.

The advantage of groups is that you can control update parameters on a per group basis. The 'Default' group does not allow for such granular control.

The group configuration displays:

Specific Transfer time (and date) of the update patch file(s) to be downloaded. If the time is in the past, downloads and patches will start immediately.

Transfer interval between Clients (UpdateAgents) in minutes. This allows you to stagger the download of the software patch for each client. (e.g. in Figure 3, if the Transfer interval is 10, the first UpdateAgent starts the download for the patch at 4:00 AM, the second UpdateAgent starts its download ten minutes later at 4:10 AM, the third starts at 4:20 AM and so on.)

Update time: This is the date and time when software updates are applied (installed) Patch time: This is the date and time when the patch is applied (installed).

1. Specify the required settings for this group. (Transfer time, transfer interval, update time and patch time) 2. Select 'Do not distribute patches/updates to these clients' to prevent automatic distribution to the clients in this

group if there is low bandwidth. Keep in mind if this option is selected, patches must be distributed manually. 3. Select 'Don't start patching/updating automatically' to prevent automatic installation of patches. Patching must be

performed manually. 4. Select 'Automatic restart before and after the patch/update' to shut down the software and log out all users before

applying the patch. Warning: there will not be any notification beforehand. 5. If required, deselect Clients from the group's list. Only the selected clients will be a part of the group and affected by

the group settings. Note: Keep in mind that if a download on a single Client fails or is delayed, subsequent patches for other Clients in the group

will not download nor will any of the patches be applied for any Client in the group.

Default Group Since the Default group does not have the same configurable parameters as a custom group you can create manually, its behavior is different. For the UpdateClients in the Default group, the software patch will not be installed until all Clients in the group have received the patch download. Then, the UpdateServer will send out a signal for all patches to be installed/applied on the Clients at the same time.



Note: Keep in mind that if a download on a single Client fails or is delayed, none of the patches will be applied for other Clients in the Default group. Therefore, it is highly recommended to create specific groups for the Clients, rather than keep Clients in the Default group.

Creating a Group Click Create new group, enter a name for the new group and click OK. The new group will be displayed in the Group list.

Renaming a Group Click Rename group, change the name for the group and click OK. All assigned UpdateAgents will remain in the group and adhere to the group's settings.

Deleting a Group Select a group in the Groups list and click Delete group. All clients in the group will be moved into the Default group and will be exempt from the update settings. UpdateAgents in the Default group will get patches as soon as they are available.

The Default group cannot be deleted.

GLOBAL REPOSITORY The second tab of the Update Service Configuration Tool displays the available recorder update patches. If the UpdateService has been configured for manual distribution in the 'Server configuration' tab, all updates can be imported from the server and exported to a directory on the server or an attached media.

Figure 4 Global Repository tab

1. Click Import patches to download the available patches from the server which are displayed. 2. Click Refresh to check at the server for update patches not yet displayed. 3. Click Export to copy the updates to a directory that can be copied to any media such as a USB drive. The updates

have to then be installed at each client separately. 4. If certain patches are not required, select the patch(es) from the list and click Delete patches before exporting them.

Only the patches listed will be distributed.



SERVER CONFIGURATION On the 'Server configuration' tab, the basic settings for the communication between the UpdateService SVR (Server) and UpdateAgent (clients) are managed. By default, the UpdateService connects to the server providing the updates (an OnSSI server), downloads and distributes the update patches to the UpdateAgents. However, if manual distribution or a different server for downloads is preferred, the automatic setting can be modified.

Figure 5 Server configuration tab

The options for downloading update patches include:

Download and install patches/updates automatically from the internet (recommended) This is the recommended and default setting for automatic updates and distribution of patches and upgrades. This requires, however, that the server with the Update SVR Service has internet access.

Download patches/updates from the internet, but do not install them automatically Update patches and software upgrades will be automatically downloaded from the server but will not be distributed to the UpdateAgents. The update patches and software upgrades must be installed manually. See Global Repository on page 5.

Download and install patches/updates automatically from a defined remote location The update patches and software upgrades will be downloaded from an FTP server that must preconfigured (See Configuring an FTP Server below) and will be automatically installed.

Download patches/updates from a defined remote location, but do not install them automatically The update patches and software upgrades will be downloaded from an FTP server that must preconfigured (See Configuring an FTP Server below), but will not be distributed to the UpdateAgents. The update patches and software upgrades must be installed manually. See Global Repository on page 5.

Do not search for patches on the internet or any remote location (not recommended) This option is not recommended as no update patches or software upgrades will be downloaded or distributed automatically. The patches or software upgrades will have to be downloaded and exported manually. See Manually Applying Patches Only on page 14 and Manually Applying Software Upgrade Files on page 16.

The option to have the update server push software application updates when available is via the checkbox:

Also download full upgrade packages

By default, the UpdateService only downloads patches with error corrections. If activated and if you have the required permissions (new license key for the next major version), the UpdateService also downloads and distributes packages with version upgrades. All UpdateAgents will then be upgraded to the new version based on your group settings.



This checkbox is unchecked by default. The dowload of software function works in conjunction with the download options above it. So, for instance, if you've selected Download patches from the internet, but do not install them automatically, the software installation components will also be downloaded but not automatically installed.

Make a Manual Backup Prior to Software Upgrade Whenever starting a software upgrade, it is always good to have a backup - -just in case. Use these steps to perform a manual backup.

Note: this should be done for each master core. If you are using Ocularis ULT or ENT, this typically need only be done once. If you are using Ocularis PRO, this must be done for each Master Core instance. Backup can be done from the Ocularis Recorder Administration Tool or from Ocularis Recorder Manager.

1. From the Ocularis Recorder Administration Tool:

a. Select 'Management Database (MaxDB)' b. Click Backup c. Enter credentials for an administrator account on the Master Core. d. Click OK. e. A warning pop-up appears indicating that the backup may take several minutes. Click OK. f. On the backup successfully created pop-up, click OK. g. Close the Ocularis Recorder Administration Tool.

2. From the Ocularis Recorder Manager:

a. Select 'System' from the Control Bar. b. Select 'Backup'. c. Click OK adjacent to 'Perform backup'



d. Click OK when on the 'Export Successful' pop-up. e. Close Ocularis Recorder Manager.

3. Copy the backup file to a safe location. 4. Also, make a copy of the folder: c:\Program Files\OnSSI\Ocularis Recorder\conf and store in a safe location.

1.

2. These saved files may be used in the event a manual restoration becomes necessary.

Four Conditions for an Automatic Software Upgrade

For the automatic (or manual) update of software to function using the UpdateService, the following must be true:

Your OnSSI StayCURRENT plan is up-to-date

You have manually refreshed your recorder SLC. (see instructions below)

The Recorder software must be updated to the most current patch

The 'Also download full upgrade packages' checkbox must be checked

For the update of patches only, these items do not apply. StayCURRENT need not be up-to-date to get software fixes.

Once these conditions are fulfilled, the software will update itself automatically from version R7 to R8 at the next scheduled update time.

Note: We recommend scheduling the upgrade during normal business hours so that the system administrator can confirm that it completed successfully.

Note: Make sure that each server/computer contains at least 15 GB free space on the installation hard drive.

Manually Refresh the Recorder SLC - Online Method Use the following steps to refresh a recorder SLC with internet connectivity:

1. From the Ocularis Recorder Manager, select the Info > Activate license menu. 2. Click OK to clear the notice that this feature requires a connection to the Internet. 3. Click the radio button for Download license.

4. Enter your seven digit SLC and click OK.

The software license will be updated in the background and updated key installed on your computer.



Manually Refresh the Recorder SLC - Offline Method Use the following steps to refresh a recorder SLC with no internet connectivity:

1. Go to any PC that does have internet connectivity and open the webpage: http://onssi.com/ocularis-recorder-licensing/

2. Scroll to the bottom of the page and enter your recorder SLC in the field under 'License update'.

3. The system will update your license and email it to the address used when the software was initially personalized. 4. Detach the license.zip or license.key file that is sent to the email address and bring it to the computer without internet

connectivity. 5. From the Ocularis Recorder Manager, select the Info > Import license file menu.

6. Click the Select button, navigate to the file attachment you just received and click Open. 7. Then, click the Import button.

The license is now updated.

http://onssi.com/ocularis-recorder-licensing/



The Recorder software must be updated to the most current patch

If you've installed the Update Service using default values, it will automatically download and install the latest update patch at the next scheduled update (if it hasn't already done so).

Manually Check for Patches using the Update Service 1. On the master core server (or server that contains the Update SVR Service), open the Ocularis Recorder Update

Server configuration tool in the Windows > Start > All Programs > OnSSI > Ocularis Recorder folder.

2. Click the Server configuration tab.

Figure 6 Server configuration tab of the Ocularis Recorder Update Server configuration tool

3. Verify that 'Download and install patches automatically from the internet (recommended)' is selected.

4. Click 'Check for patches now...' to download any new patches.

The system will be updated with the this patch:

For clients in the Default group: immediately

For clients in a custom group: upon the next scheduled patch time as configured



The 'Also download full upgrade packages' checkbox must be checked

With the most up-to-date patch installed, the Ocularis Recorder Update Server Configuration Tool will have some new settings available.

1. On the master core server (or server that contains the Update SVR Service), open the Ocularis Recorder Update Server configuration tool in the Windows > Start > All Programs > OnSSI > Ocularis Recorder folder.

2. Click the Server configuration tab.

Figure 7 Updated Ocularis Recorder Update Server Configuration Tool

3. Now, underneath the drop-down menu, you'll see a new checkbox:

Also download full upgrade packages By default, the UpdateService only downloads patches with error corrections. If activated and if you have the required permissions (new license key for the next major version), the UpdateService also downloads and distributes packages with version upgrades. All UpdateAgents will then be upgraded to the new version based on your group settings.

This checkbox is unchecked by default. The dowload of software function works in conjunction with the download options above it. So, for instance, if you've selected Download patches from the internet, but do not install them automatically, the software installation components will also be downloaded but not automatically installed.

4. Check the Also download full upgrade packages checkbox.

5. Click Save.

The software will be upgraded to the next version at the next scheduled Update time. You can check this by clicking the Information tab, click a group and then click Configure Group. (see Figure 8 Update time).

6. If you want to check for updates now without waiting for the next schedule Update time, click the Check for patches/updates now button.

Note: It may take a few minutes after clicking Save to recognize updates so we recommend waiting a few minutes after clicking Save before you click Check for patches/updates now.



To check the Update Time A new field is available for setting the time for software upgrades with the Update time fields. In the Ocularis Recorder Update Server Configuration Tool, click the Information tab, click a group and then click Configure Group.

Figure 8 Update time

Notice how now you can have different times for recorder patches/fixes and software upgrades.

For more information on software upgrades, contact OnSSI Technical Support.

Configuring an FTP Server If you prefer to use an FTP Server to distribute update patches across the network, use these steps for configuration.

1. After selecting the option: Download and install patches automatically from a defined remote location, enter the IP address and port number of the FTP server.

Figure 9 Configure FTP Server Settings



2. Provide a username and password for the server. 3. To establish a secure connection, activate 'Use FTP via SSL' (if the server supports SFTP). Contact the network

administrator for the correct settings.

IMPORT OF PATCHES AT THE UPDATE AGENT 1. After successfully exporting patches (see Global Repository on page 5), copy the directory to a USB drive and insert

into the computer where the UpdateAgent is running. 2. Start the application 'SeeTec.UpdatePatchImport.exe' and click Yes.

The SeeTec.UpdatePatchImport.exe is created after you've clicked 'Export' on the Global Repository tab. 3. Click OK and start the update patch process. The UpdateAgent will be stopped for the update process. After

completion, the UpdateAgent (VMS_UPDATER) will be restarted automatically.

MANUALLY CONFIGURE & ACTIVATE UPDATE AGENT(S) The UpdateService Agent (VMS_UPDATER) is installed by default for all recorder components (except the Master Core). If the IP address of the Update Service Server (VMS_UPDATESVR) should change after installation, you can configure the agent manually without having to reinstall the software.

1. Open the configuration file in the installation directory on the agent pc. This file should be located in '...\conf\' and named: updateclient.conf.xml

2. Replace the existing IP address with the new IP address of the Update Server server component (VMS_UPDATESVR). For example:

192.168.11.155 63000

Replace 192.168.11.155 with the new IP address.

3. Save the changes and restart the agent update service (VMS_UPDATER).



MANUALLY APPLYING PATCHES ONLY If the system with the Update Service Server component (VMS_UPDATESVR) does not have internet connectivity, you should manually apply the recorder patches/fixes using these steps. The patches can then be automatically distributed.

Note: When manually uploading a patch file, the Automatic Update service will start the patching process for clents/agents in the Default group right away. This will cause recorder components to stop and start as they are patched. Clients/agents in a configured group will be patched based on the group's configured schedule.


1. On any PC that does have internet connectivity, go to the webpage: http://onssi.com/software-downloads/ 2. Scroll to the Recorder Patches section. 3. Click Show 5.x Recorder Patches Download links for the version you wish to update.

Figure 10 Manually Download Recorder Patches from OnSSI.com

4. Click each link and download all patches to portable media. Do NOT unzip the files. 5. Transfer the files to the server where the Update SVR Service exists. (default is the master core machine) 6. Launch the Ocularis Recorder UpdateServer configuration tool and select the 'Server configuration' tab (1).

http://onssi.com/software-downloads/



Figure 11 Manual Application of Recorder Patch/Fix-Server configuration tab

7. From the drop-down menu, select 'Do not search for patches on the internet or any remote location' (2) 8. Click Save (3).

Figure 12 Manual Application of Recorder Patch/Fix - Global repository tab

9. Select the 'Global repository' tab (4). 10. Click Import patches (5) and select the patches downloaded from step 5. You can select all and import them as a

group. Click Open to import the patch files. 11. Once imported, the patch files will appear in the 'Following patches imported' list (6).



For components in the Default group, the patches will begin to be distributed and installed. For components in configured groups, the patches will be distributed based on the configured schedule. The progress of updates can be viewed in the 'Information' tab.

MANUALLY APPLYING SOFTWARE UPGRADE FILES In addition to patches and fixes, the Update Service can also be set to automatically download software upgrades when a new version is released. If the system with the Update Server service component (VMS_UPDATESVR) does not have internet connectivity, you should manually apply the recorder software upgrade files using these steps. The upgrade can then be automatically distributed.

Note: When manually uploading software upgrade files, the Automatic Update service will start the upgrade process for clents/agents in the Default group right away. This will cause recorder components to stop and start as they are upgraded. Clients/agents in a configured group will be upgraded based on the group's configured schedule.


1. Obtain the software upgrade files from OnSSI Technical Support. 2. Transfer the files to the server where the Update SVR Service (VMS_UPDATESVR) exists. (the default is the master

core machine) 3. Launch the Ocularis Recorder UpdateServer configuration tool and select the 'Server configuration' tab (1).

Figure 13 Manual Application of Software Upgrade - Server configuration tab

4. From the drop-down menu, select 'Do not search for patches on the internet or any remote location' (2) 5. Click Save (3).

mailto:[email protected]?subject=Please%20send%20me%20links%20to%20recorder%20software%20upgrade%20files%20for%20offline%20upgrade



Figure 14 Manual Application of Software Upgrade - Global repository tab

6. Select the 'Global repository' tab (4). 7. Click Import updates (5) under 'Update for 32-bit and 64-bit applications' and select the two files to download. You

can select all and import them as a group. Click Open to import the patch files. 8. Once imported, the version will be listed for 32-bit and 64-bit (6).

For components in the Default group, the upgrade will begin to be distributed and installed. For components in configured groups, the upgrade will be distributed based on the configured schedule. The progress of updates can be viewed in the 'Information' tab.



Record on Motion In Ocularis v5.2, motion detection recording has been updated, streamlined and packaged into a feature called 'Record on Motion'.

Record on Motion differs from the previous version of Ocularis in that if enabled, video will be recorded when there is motion only. When motion stops, recording stops. In Ocularis 5.1, the only option for motion recording was where video was recorded for a set duration whether motion continued or not. While this form of motion detection recording is still available in v5.2, Record on Motion is much more efficient and makes better use of storage space. It also eliminates the need for alarm scenarios which frees up resources on the core. Video recorded using Record on Motion will be categorized as alarm recording. With Record on Motion, you can set pre and post buffers on a camera-by-camera basis. Multi-camera configuration is also supported and you can enable Record on Motion when adding cameras using the Device Finder.

Record on Motion may be used with either camera side or server side motion detection. It also supports the use of motion detection regions inside an image.

HOW TO CONFIGURE RECORD ON MOTION In order to enable Record on Motion, either camera side or server side motion detection must be enabled first. The following examples will be discussed:

Configuring Record on Motion on a Single Camera Configuring Record on Motion on a Group of Cameras Configuring Record On Motion When Adding Cameras

To Configure Record On Motion on a Single Camera

1. In Ocularis Recorder Manager, open the configuration screen for the camera you wish to configure. 2. Choose Motion Detection under either 'Server side functions' or 'Camera side functions'.

Camera side: i. Activate one or more preconfigured windows to be used for motion detection analysis. ii. The Dead time setting will be ignored by Record on Motion. iii. Click Apply.

Server side: i. Set Activate motion detection to Yes using the drop-down. ii. Set the desired Sensitivity and Threshold. iii. The Idle timer will be ignored by Record on Motion. iv. If you wish to set one or more regions in the image, use the plus and polygon tools v. Adjust Sensitivity and Threshold for each region separately. vi. Click Apply.

3. Choose Record On Motion under 'Image Storage'. 4. Enable Record on Motion by selecting Yes from the drop-down list. 5. Pre and post buffer is defaulted to 3 seconds for each. Modify these values if desired.

Notice that the system recognizes that Camera side or Server side motion detection is enabled. You must first enable it prior to saving this screen.

6. Click Save to save these settings. That's it! You are done!. Alarm scenarios need not be configured. The video that is recorded due to motion will be coded in red on the Kinetic Timeline in Ocularis Client.



To Configure Record On Motion on a Group of Cameras

Multi-camera configuration is supported with Record on Motion. Remember that either camera side or server side motion detection must be enabled first. This example is going to use server side motion detection.

1. In Ocularis Recorder Manager, select the checkbox next to each you wish to configure. 2. Click the Edit tool.

Figure 15 Edit Tool

Notice that the configuration tab is labeled 'Multiple IP cam...' to indicate that multiple cameras will be configured.

3. Choose Motion Detection under either 'Server side functions'.

Figure 16 Multi-configuration for Motion Detection

4. Check the checkbox next to the drop-down for Activate motion detection.

Figure 17 Enable drop-down menu

5. Once checked, the drop-down is enabled. Select Yes. 6. Click Apply.

Sensitivity and Threshold will need to be adjusted later for each camera individually.

7. Choose Record On Motion under 'Image Storage'. 8. Click the checkbox next to Enable Record on Motion. 9. Select Yes from the drop-down list. 10. If you want to apply the same Pre and post buffer settings to the cameras, click the corresponding checkboxes to

enable the field entry and set the desired change. Otherwise, the defaults of 3 seconds each will be applied. 11. Click Save to save these settings on all cameras.



To Configure Record On Motion During Camera Installation

When using the Device Finder Tool to add cameras, you may also enable server side motion detection and Record on Motion. recording.

1. In Ocularis Recorder Manager, launch the Device Finder. 2. Locate and select the cameras you wish to add. You may also use the Recorder Migration Tool to add cameras. 3. For each camera that you wish to enable Record on Motion, click the checkbox under Record on Motion.

Figure 18 Enable Record on Motion checkbox during Device Finder Add

4. When done, click Add. You can add with mult-config if you want. Now these cameras will have server side motion detection activated and Record on Motion enabled. You should still review and if necessary modify the Sensitivity and Threshold settings for each camera in the Server Side Motion Detection screen.

MOTION DETECTION RECORDING AND UPGRADES FROM V5.1 If you have what was considered 'Basic' motion detection recording configured on your v5.1 system (i.e. where the Record on Motion drop-down was set to 'Yes' but no alarm scenarios were created. Video was recorded for 30 seconds regardless of whether there was continued motion and with no pre or post buffer) and you upgrade to v5.2 (including upgrading the recorder), the system will convert these camera configurations and enable Record on Motion. No further action is required. Keep in mind that the default values for pre- and post- buffers of 3 seconds will be used. If you want, you may modify these settings. The settings in the server side or camera side motion detection screens remain unchanged.

If you have motion detection already configured in v5.1 using alarm scenarios and you upgrade to v5.2 (including upgrading the recorder), your alarm scenarios and motion detection recording will still continue to work as before. No action is required.

However, we recommend that you enable some or all of your cameras for Record on Motion to take advantage of its efficiencies. Remember that you can enable Record on Motion with multi-config for a group of cameras to make it easier. Also, if you do decide to enable Record on Motion, you will need to delete or deactivate the corresponding alarm scenarios. If you do not deactivate alarm scenarios that do motion detection recording, they will continue to function as before and will result in excess video. Deactivating alarm scenarios is supported with group edit to modify multiple scenarios in bulk. Reducing the number of alarm scenarios will also free up resources on the core.



Motion Detection Filter Introduced in the September 2016 recorder patch, there is a new feature called 'Motion Detection Filtering'. This feature can reduce excess false positives due to environmentally induced motion when using server side motion detection. Examples include: low light scenarios that emit excess noise, places where the light reflection causes noise, etc.

Be aware that this feature is not intended for use on cameras at long distances.

To activate the filter, in the Server side functions > Motion detection screen, set the drop-down under 'ActivateFilter' to Yes. Then, we recommend setting the Sensitivity to close to High and Threshold close to Low. As always, we recommend that you review the motion detection settings in different lighting scenarios such as during daylight and nighttime hours. We also recommend reviewing the recorded video to ensure that only actual motion is being detected and recorded.

Figure 19 Motion Detection Filter



General Information on Migration Tools Ocularis v5.2 introduces migration tools to aid in the transition of moving to Ocularis 5. The Recorder Migration Tool imports data from a legacy recorder to include: camera name, IP address, username and password. The remaining configuration of the device, such as framerate, resolution, etc. are not imported. To assist in configuration of views and maps on Ocularis Base, a Camera Migration Tool has been developed to assign one camera to replace another in all instances where the camera appears in views and maps.

Recorder Migration Tool The Recorder Migration Tool is used to import cameras in bulk into an Ocularis v5.2 recorder (recorder version R8). Supported by all models of Ocularis 5 (Professional, Enterprise and Ultimate) this feature quickly adds cameras into the recorder. Once imported, however, additional configuration is still required such as choosing the compression, resolution, framerate and other configuration parameters.

SUPPORTED CONFIGURATION FILES The following files are supported for import:

1. Ocularis PS, IS or CS Configuration File

Filename: 'configuration.xml'

Supported with v8.0 and later recorders

By default, the configuration.xml file is located in the folder:

c:\Program Data\OnSSI\RC-X

where 'x' represents the model (e.g. RC-C, RC-I, RC-P)

Reminder: Program Data is a hidden folder by default so you may need to change your Windows view settings in order to locate this folder.

Note: the camera credentials are not imported when using a configuration.xml file.

2. CSV file with the following structure:

Columns: Display Name, IP Address, User Name, Password The order of the column headers are irrelevant.

Separator: a comma (,) Example: DisplayName, IPAddress, UserName, Password

Camera A,172.16.101.153, root, pass

Camera B,172.16.117.70,admin, admin

You may use a Microsoft Excel spreadsheet provided that you do a File...Save As and save the file as a .CSV file.

Note: the camera credentials are imported when using a .CSV file import.

OCULARIS LS AND ES If you require a direct import from an RC-L or RC-E recorder and you do not have a .CSV formatted file, contact OnSSI Global Professional Services for assistance with this type of import.

HOW IT WORKS The Ocularis 5 Device Finder works with UPnP and ONVIF by using multicast via UDP. If there are Layer 3 switches on the network, multicast packages may be blocked by default. In this case, the Device Finder will not be able to find devices in other subnets. After the initial broadcast scan, the Device Finder sends a unicast message to the devices in the import file provided.



For the configuration.xml import to work properly, devices must have UPnP or ONVIF enabled. Otherwise, the device will not be recognized by the scan.

HOW TO IMPORT DATA 1. Obtain the configuration.xml or .csv file.

By default, the configuration.xml file is located in the folder:

c:\Program Data\OnSSI\RC-X

where 'x' represents the model (e.g. RC-C, RC-I, RC-P)

Reminder: Program Data is a hidden folder by default so you may need to change your Windows view settings in order to locate this folder.

2. Bring the configuration.xml file to the PC with Ocularis Recorder Manager (if not already there).

3. Launch Ocularis Recorder Manager.

4. Click 'Find Devices' to start the Device Finder. Allow it to complete its search process.

5. Click the 'Import' icon.

Figure 20 Import icon in Device Finder

6. A Windows open dialog appears. Select the file you wish to import (configuration.xml or the .CSV file) and then click

'Open'.

You'll see a message that there was an error or that the configuration was successfully loaded.

7. Then, you'll begin to see the devices as they are imported.

Figure 21 Status of Import

If the device is already in the Device Finder list, the information will be updated (i.e. the name of the device used in the legacy recorder). In most cases, the 'Name' field in the Device Finder is set to the name of the model so it is the same as the 'Type' field before the import.

If the device was not in the Device Finder list, a unicast message will be sent via UPnP and ONVIF to the device, requesting its information (i.e. manufacturer, model). o If the unicast message fails, the device will be added to the found devices list with a red background. In this

case, the name of the formerly used driver in the legacy system, the name of the camera, and the IP addresses are listed in or below the corresponding fields.



o If the unicast message succeeds, the device will be added to the devices found list and highlighted with a green background. Information, such as the name of the device, is used from the configuration. Manufacturer and type come from the device directly and are used for the regular matching process to preselect the correct driver (if possible).

In the example shown in Figure 22, the three devices shown in green were successfully contacted via UPnP. For the device highlighted in red, there was an issue with the communication. Notice though that the Manufacturer and driver name are shown in the area below the drop-down menus. You can select the corresponding fields from the drop-downs to manually set this data. Also, in all cases using a configuration.xml import, you must manually enter the device's username and password.

Figure 22 Import from configuration.xml



The example in Figure 23, shows an import using a .CSV file. Notice that it too can be unsuccessful if the devices are not configured with the UPnP protocol. You can select the Manufacturer and Type for these manually.

Figure 23 Import using a .CSV file

Notice too that you can set Record on Motion as you add cameras with the Device Finder. You can also set Record on Motion using the multi-configuration feature.

ONVIF The ONVIF standard states that when requesting device information, authentication is required. Therefore, there could be some devices that do not respond properly. The example below using the manufacturer Axis, shows where the authentication is necessary before getting the details from the camera. In order to request ONVIF information from Axis, an ONVIF user (administrator profile preferred) must be added via the cameras web-configuration page.



Figure 24 Axis web-configuration for adding an ONVIF user

UPNP The import tool also uses UPnP. This protocol must be enabled on the camera in order for the search to work during a configuration.xml import. Here's an example of another Axis camera's configuration webpage showing that UPnP is enabled.

Figure 25 Axis UPnP Settings



Camera Replacement Tool As you know, when you add a recorder to Ocularis Base, additional configuration is required. This includes (but is not limited to):

1. Assigning privileges to the cameras to the applicable user groups

2. Creating views using the newly added cameras and

3. Adding the newly added cameras to maps.

These steps are required whether you install a new recorder or if the new recorder is replacing an existing recorder such as the case when you migrate cameras from version 4 Ocularis to version 5.

Keep in mind that with Ocularis Mix and Match you may still incorporate older version OnSSI recorders with a version 5 Base. In fact, Ocularis 5 is compatible with all current and prior OnSSI recorders.

However, in the event that you do want to migrate cameras from a prior version to an Ocularis 5 recorder, we have implemented a tool to help in this process.

The Camera Replacement Tool in Ocularis Administrator allows you to easily replace one camera with another in all instances where the camera is used in Ocularis Views and Maps, saving the time and effort to reconfigure the system. You can even replace an entire recorder!

Note: this feature is available only to the admin user. Group Administrators do not have access.

HOW IT WORKS In the example shown in Figure 26, four cameras are located on an RC-C recorder labeled 'Camera A', 'Camera B', etc. They are used in a view called 'Lobby View' as shown.

Ocularis Base

Ocularis Client

RC-C

Base

RC-C

Camera A

Camera C Camera D

Camera B

Lobby View

Figure 26 Sample Cameras from an RC-C Recorder



If you want to migrate these cameras to a v5 recorder, install the same four cameras on a version 5 recorder. You can use the Recorder Import Tool or install them manually. The names of the cameras on the version 5 recorder may be the same or different names as the legacy recorder. Temporarily, both cameras will stream to two recorders.

Figure 8 shows an added Enterprise recorder. The camera names were assigned 'ENT Camera 1', etc.

Ocularis Base

Ocularis 5 Core + DM

Ocularis Client

RC-C

Base

CoreDM

RC-C

Figure 27 An ENT recorder was added

After adding the v5 recorder to Ocularis Administrator, you can map the Enterprise cameras to their RC-C counterparts.

Camera AENT Camera 1

ENT Camera 2 Camera B

Camera C

Camera D

ENT Camera 3

ENT Camera 4

is mapped to

is mapped to

is mapped to

is mapped to

When the mapping is complete, the 'Lobby View' will automatically be updated1.

1Mapping changes are not reflected in Ocularis Client until the next time the operator logs off and then back on.



ENT Camera 1

ENT Camera 3

ENT Camera 4

ENT Camera 2

Lobby View If the names of the cameras are identical from one server to another, you can save time by mapping one server to another server. The system will map all matching camera names to their corresponding counterpart.

TO USE THE CAMERA REPLACEMENT TOOL 1. After logging in to Ocularis Administrator using the admin account, from the Servers / Events tab, click the arrow

adjacent to the Delete button in the Servers pane.

Figure 28 Remap Cameras

Then click Remap Cameras.

2. In the resulting pop-up, expand the new recorder on the left side of the screen and then expand the recorder that is being

replaced on the right side of the screen.

You can use the filter entry box to filter the list by camera or server name

Check the 'Only Legacy Recorders' if you want to filter the list on the right by Ocularis v4.x and prior servers

Check the 'Only Disabled Cameras' to filter the list by disabled cameras

3. Then you can identify which camera on the right is being replaced with its corresponding camera on the left. You can:

a. Drag and drop cameras one at a time



Figure 29 Drag and drop individual cameras

As cameras are mapped, they are removed from the 'Unmapped Cameras' list to prevent duplicate mappings. Also, you may not map a camera to itself.

b. Drag and drop from one server to another.

Figure 30 Drag and drop server to server

Notice that in Figure 30, the system was unable to find a match for 'Camera ABC'. In this case, the camera can be mapped individually to its corresponding camera.

4. If you need to remove a mapping, click the red X as shown below. Also notice that the tool tip identifies the server to which

camera the camera belongs.



Figure 31 Remove a single mapping

5. To remove all mappings on a server, right-click on the server name itself and select Remove All Mappings.

Figure 32 Remove All Mappings for a Server

6. When finished, click OK.

Now, everywhere the mapped camera is used in a View or on a Map, Ocularis will now display the newly mapped camera. This saves you from having to reconfigure the newly added recorder's cameras from scratch.

Keep in mind that the mapping is temporary until you remove the old server from Ocularis Administrator. Then the mappings will become permanent.



TO MAKE TEMPORARY MAPPINGS PERMANENT To make temporary mappings permanent, delete the server from the Server / Events tab.

1. From the Servers / Events tab, right-click the server name you wish to remove.

2. Select Delete Server.

3. You will see an 'Are you sure you want to delete...' pop-up message. Click Yes.

4. You will then see the following warning:

Figure 33 Delete Server warning message

If all cameras are mapped, the second line will not display.

5. Click:

a. Yes to review the mappings in the Remap Cameras pop-up. When you are done reviewing, click OK to continue with the deletion operation. Then, you will get a second warning message. Click Yes to remove the recorder and make the mappings permanent.

b. No to skip the review , remove the server and make the mappings permanent.

c. Cancel to abort the operation.



Keyword Quick View A Keyword Quick View is used in Ocularis Client to quickly create a view for which all cameras share the same keyword or tag. For instance, you may have a camera positioned at every doorway in the office. If the keyword 'door' is assigned to these cameras, operators can quickly show all cameras that meet the keyword criteria. While this may also be done in a preconfigured view, using keyword quick view can be significantly faster than paging through dozens or hundreds of views and selecting one from the menu.

TO ASSIGN KEYWORDS TO A CAMERA

1. In the Servers / Events tab, locate and right-click the desired camera.

2. Select Properties.

3. In the Lookup Tags field enter one or more keywords that will be used to invoke the camera in a quick view.

Each keyword tag is limited to no more than ten characters.

The following characters are not allowed: []*?@/=+|\:;!#$%^()_{}'.-~&>



Results for keyword search 'OUTSIDE'

A view will appear containing up to nine cameras that meet the tag criteria. If there are more than nine cameras that meet the criteria, only the first nine cameras found will be displayed.

This view is temporary and will not automatically reload if the current session ends. However, you can use the navigation icons (Go to Previous View and Go to Next View) while you are still logged in to the same session.



Updates to NAT Configuration NAT, or Network Address Translation, is a process that allows resources outside of an organization's network to gain access to resources inside the network (and vice-versa). For instance, you may have an Ocularis Base server, Ocularis Client and one or more Ocularis recorders installed in your office network. You may have a branch location that contains one or more recorders and Ocularis Clients. In order for operators in your office to view video from the cameras in the branch location, NAT can be used. Similarly, external operators who need access to video in the office may also take advantage of NAT.

NAT configuration has been updated to allow system administrators to identify different local subnets or VLANS for accessing video from inside and outside the organization's firewall.

CONFIGURE NAT SETTINGS ON OCULARIS BASE After you've added a Master Core to Ocularis Base check the 'Enable NAT' checkbox and configure additional settings. Instructions differ slightly depending on whether the recorder is on the same internal network as the Base or is outside of the Base network.

1. In the Ocularis Administrator Servers / Events Tab, click the Add button.

2. In the Add Server pop-up (see Figure 34), check the Enable NAT checkbox (1).

Figure 34 Add Server with NAT

3. Fill in the NAT fields as follows:

External host Enter the public (outside) IP address as defined on the Base's network firewall. For Ocularis v4 and prior recorders, append the IP address with :port #. It is not necessary to add the port number for v5 recorders/Master Core in this field.

Alternate Label Optional: add a label to your server name to change how is it listed in the Servers / Events tab.

Internal Host Enter the internal IP address of the Master Core. For v4 and prior recorders include :port # after the address. It is not necessary to add the port number for v5 recorders/Master Core in this field.

Subnet Enter the local subnet(s).



Relation to Base Check the radio button for 'Same Network'. This option is used when the Master Core or v4 recorder computer is on the same network as Ocularis Base.

Login type Choose 'Basic' or 'Windows' based on the user account set up on the recorder that you will be using to add the Base. For v5 recorders, only 'Basic' users are supported at this time.

User name Enter the user name for a user account on the Master Core or recorder. In most cases, add an account with full administrative privileges.

Password Enter the password for the corresponding user account. Use OpenSight To apply OpenSight licenses to the cameras on this recorder, this box

should be checked. Refer to the Ocularis Administrator User Manual for more information about OpenSight.

*New* Configure Internal Network

Use this button to define internal VLANS. Enter the Network Address and Subnet Mask for each VLAN. Use the [TAB] key to add a new row as needed.

4. When the Add Server pop-up is completed, click Add.

5. Repeat this for any additional v5 Master Cores inside the firewall. If you also have any v4 recorders, repeat these

steps for all internal recorders.

Here is an example of a master core/v5 recorder using NAT:

Figure 35 Add an Ocularis v5 Master Core



When you click the new button Configure Internal Network, the following pop-up appears. Enter your internal local networks here. Note that these settings are set at the Base level and are shared across all added servers.

Figure 36 Internal Network Setup for VLANs

For more detailed information on NAT configuration, see the document Using NAT with Ocularis 5.

00009192016-1316-5.2.0.405

Update ServiceUpdate Service Configuration ToolConfigure the Update ServiceManually Triggering an Action

Configure A GroupDefault GroupCreating a GroupRenaming a GroupDeleting a Group

Global RepositoryServer ConfigurationMake a Manual Backup Prior to Software UpgradeFour Conditions for an Automatic Software UpgradeManually Refresh the Recorder SLC - Online MethodManually Refresh the Recorder SLC - Offline MethodThe Recorder software must be updated to the most current patchManually Check for Patches using the Update Service

The 'Also download full upgrade packages' checkbox must be checkedTo check the Update Time

Configuring an FTP Server

Import of Patches at the Update AgentManually Configure & Activate Update Agent(s)Manually Applying Patches OnlyManually Applying Software Upgrade Files

Record on MotionHow to Configure Record On MotionTo Configure Record On Motion on a Single CameraTo Configure Record On Motion on a Group of CamerasTo Configure Record On Motion During Camera Installation

Motion Detection Recording and Upgrades from v5.1

Motion Detection FilterRecorder Migration ToolSupported Configuration FilesOcularis LS and ESHow It WorksHow to Import Data

/ONVIFUPnP

Camera Replacement ToolHow It WorksTo Use the Camera Replacement ToolTo Make Temporary Mappings Permanent

Keyword Quick ViewTo Assign Keywords To A CameraUsing Keyword Quick View

Updates to NAT ConfigurationConfigure NAT Settings on Ocularis Base

topics in this document - onssi · of this document has been updated to include the motion...

Documents