Default Passwords

Username: dvr

Password: 32dvr *

*) Password in Windows Server OS –systems is: 32dvrDVMS

Username: Admin

Password: 0308

The default username and password should not be used even in closed networks. Please ensure that the default username and password are not in use after the system has been installed.

Before You Start

Mirasys VMS software is a distributed Video Management System for video and audio surveillance applications.

The software can be used for monitoring real-time and recorded video, audio and text data, and to control dome cameras, I/O devices and IP cameras.

The software supports systems consisting of both analog and/or digital surveillance cameras, supporting the creation of analog (DVR), digital (NVR) or hybrid (consisting of both analog and digital) surveillance systems.

This guide gives instructions for setting up the VMS Servers and for installing audio devices, IP cameras, dome cameras, video matrices, digital inputs and outputs, and client programs (Spotter and System Manager).

Help Documentation

This help documentation, for example, is available:

  • Installation Guide: Shows how to install the VMS servers and the client programs. It also shows how to add devices to the system.
  • Administrator Guide: Shows how to use the System Manager program for configuring the system.
  • Spotter User Guide: Complete instruction how to operate all features of Mirasys Spotter program. (Not available in all languages.)
  • VCA Installation and Configuration Guide: Instructions how to install and configure Mirasys Video Content Analytics.

The PDF help documentation is on the VMS installation medium and the full setup package that can be downloaded from the Mirasys Extranet.

You can also access the Administrator’s Guide and the Spotter User’s Guide by clicking Help in the System Manager or Spotter programs.

Manuals For Third Party Devices

When installing third party devices, follow the manufacturer’s instructions.

Technical Support

For technical support and warranty issues, please contact the system supplier.

What’s New

The lists below include only select information. For a full list of new features and changes, please refer to the Release Notes included in the installation packages.

Note: Microsoft SQL Server Express 2014 or the full Microsoft SQL Server 2014 is required to be installed on the Master Server (in single server installations the only server is the Master Server) and on networked recording VMS servers (nodes or slaves) when Mirasys VCA (Video Content Analytics) is to be utilized.

New features in version 8:

  • New Mirasys TruStore storage file system.
  • IMPORTANT: The TruStore storage file system is not compatible with earlier storage, and old stored material will be removed at install. Archive or export any material you wish to retain when upgrading to Version 8.
  • Spotter can be used to simultaneously connect to multiple different Master Servers (license controlled add-on feature). Server selection has been moved from the Spotter login window to the application launcher dialog. It is also possible to directly create desktop shortcuts that connect to a certain Master Server.
  • Spotter look and feel has been modernized, and more functions are now available from the device tree and the new title menu. Hotkeys can be used to change view modes on the fly. Certain view components also have detailed configuration options for advanced users.
  • Controlled playback for user groups: Ability to restrict users to have playback access only to up to 24 hours into the past.
  • Alarms can have custom color.
  • The Workstation client application is no longer available!
  • The user can specify to show certain or all alarms on the Spotter time slider.
  • Support for multiple alarm popup monitors.
  • Ability to open camera to search and analysis plugins from device tree.
  • Fast Bookmark button.
  • Data cache for activity data.
  • I/O devices can be attached to take over a whole device tab grid cell, making them easier to operate.
  • PTZ (dome) camera control “aiming point” has been changed to be less intrusive, and the size can be adjusted from the Spotter configuration file.
  • TruStream support: for multi-streaming cameras. Spotter will automatically choose a stream that matches best the grid cell resolution that the camera is displayed in.
  • Certain product variants contain both a dark and light visual theme for Spotter.
    - The numeric keypad device number popup dialog can be positioned freely anywhere on the Spotter window.
    - The AVM operator console can be positioned in a fixed camera grid cell.

About the System

What is Mirasys Software?

Mirasys software is a distributed, digital video management system (VMS or DVMS) for video and audio surveillance applications.

The software can be used for monitoring real-time and recorded video, audio and text data, and to control PTZ cameras, I/O devices and IP cameras.

The software supports systems consisting of both analog and/or digital surveillance cameras, supporting the creation of analog, digital or hybrid (consisting of both analog and digital) surveillance systems.

A centralized surveillance system domain can consist of a network of up to 150 local or remote VMS Servers.

Mirasys software is sold both separately and as part of Mirasys video management systems consisting of both the software and the VMS Server hardware. Please contact your Mirasys supplier for information on Mirasys software or hardware.

What Does a System Contain?

The Mirasys system consists of these components:

  • 1-150 VMS Servers
    - Master Server (dedicated server – recommended -, one of the video recording VMS Servers, or the only server in a single-server, non-networked environment)
    - VMS Server (“nodes,” if the system consists of multiple servers)
  • Client programs:
    Mirasys VMS System Manager
    Mirasys VMS Spotter for Windows
    - Mirasys VMS Spotter Mobile
    - Mirasys VMS WebClient

VMS Servers

The VMS servers record video and audio from multiple cameras and audio channels and write the data on hard disks. You can access a VMS Server locally or over a network by using the System Manager and Spotter programs, and monitor server functionality through the Spotter Diagnostics plugin.

A server contains the computer with storage, the Windows operating system, and the VMS software with required drivers.

In addition, you can connect these devices to a VMS Server:

  • PTZ (dome) cameras and keyboards
  • External devices, such as sensors, to the digital inputs
  • External devices, such as doors, lights, and gates, connected to digital outputs
  • Monitors
  • Printers
  • Backup unit (NAS, SAN, or RAID, for example)

Master Server

In a networked system, one of the servers must be set as the Master Server. A Master Server is the central server of a surveillance system. All other VMS Servers connect to it, and all client applications communicate through the Master Server.

If the system contains only one server, then that server is the Master Server. If there is more than one server, the Master Server can be set freely. In a larger system it is recommended that the Master Server is a dedicated server for this purpose alone.

Note: Master Servers must have SQL Server Express 2014 or another Microsoft SQL Server 2014 installed.

The Master Server does these things:

  • It verifies the identity of all programs and users who try to log on to the system (authentication).
  • It stores all system configuration data.
  • It stores all user data.
  • It monitors the system.
  • It synchronizes the clocks on all servers.
  • It generates reports.
  • It stores watchdog event.
  • It stores alarms.
  • It stores audit trail.

Client Programs

System administrators use the System Manager program for these tasks:

  • Configuring the servers.
  • Adding user accounts and user profiles.
  • Monitoring the system.

End users use the Spotter program, for example, for these tasks:

  • Monitor real-time and recorded video and audio
  • Control digital I/O switches and PTZ cameras
  • Export video and audio clips to local media
  • Receive and handle alarm notifications
  • Create video matrixes via the optional, separately sold Agile Video Matrix (AVM) software
  • Control automatic license plate recognition systems via the optional, separately sold ANPR+ software

The Workstation client is the legacy client that is no longer supported. If you must use Workstation you need to use Mirasys VMS V7.5.10, or earlier.

Mirasys 32-bit vs. 64-bit Versions

Starting from Version 8 onwards, the Mirasys VMS software is available only as a 64-bit (“x64”) version.

Note: Mixed 32-bit and 64-bit systems need more care and expertise for the installation, upgrading and management of the system.

Analog video compression (capture) cards are not supported on the 64-bit Mirasys VMS.

Managing an Environment With 64-bit Versions of Mirasys VMS


In a networked, multi-server Mirasys VMS system, the server with the Master Server role can simultaneously connect to and manage both 32-bit and 64-bit VMS Servers (also known as “nodes”) on the network:

  • The 64-bit Master Server supports simultaneously both 32-bit as well as 64-bit VMS Servers.
  • A Version 8.x based Master Server supports simultaneously Version 8.x, Version 7.x and Version 6.x VMS Servers, but does not support servers based on Version 5.x, or earlier.

Version 8 supports clients to connect to 32bit and 64 bit server versions. It is recommended to reinstall the clients with version 8 installer to get the latest application updater (VAU).

Server upgrading considerations

When using the System Manager application's “Update servers” -feature to update the VMS Servers in the system, all or the selected VMS Servers you choose to update will update to the version you choose (which installation file you provide).

In a mixed environment with both 32-bit and 64-bit servers, be careful that you know which servers are to be upgraded to which version, 32-bit or 64-bit!

The 64-bit versions will not work at all on, so called, hybrid servers with internal analog video capture cards (also known as compression cards or grabber cards).

System manager shows the 32 bit or 64 bit version information in the “Version” table.

All new IP camera, encoder (video server) or other drivers are also available as separate 32-bit and 64-bit versions. When installing a new driver or updating an existing driver, you must use a 32-bit driver package on a 32-bit server, and a 64-bit driver package on a 64-bit server.

Note: Also that all servers with the Master Server role, as well as all VMS Servers with Mirasys VCA (Video Content Analytics) require Microsoft SQL Server Express 2014 to be installed on the server before installing Mirasys VMS.

System Requirements

The Mirasys VMS (Video Management System) software is flexible and scalable network video recording software that consists of Mirasys server software and client application software. The server and client software can be installed on any standard PC platform that fulfills the hardware and operating system (OS) requirements. Servers may also be virtualized using, e.g., Microsoft Hyper-V or VMWare.

Mirasys VMS is delivered either in pre-assembled servers, or as software-only, in which case the distributor/reseller, an integrator/installer or the end-customer installs the software on a PC.

The performance of a Mirasys VMS solution depends on several factors such as processor type and speed, available memory, and network bandwidth. The requirements below define minimum requirements for running Mirasys VMS software with IP surveillance cameras.

The examples presented in this document should only be used as a base guideline when planning to set up a system. For detailed calculation of system performance and storage capacity requirements, please refer to your Mirasys sales contact or an authorized distributor/reseller.

Please note also that the performance and functionality of a VMS system’s server or client software is guaranteed only when it runs as the sole application on the PC platform. No other software applications – with the exception of dedicated server software such as Mirasys ANPR+ (Automatic Number Plate Recognition), Mirasys Reporting+, Mirasys VCA (Video Content Analytics), or Microsoft SQL Server when required – should be installed on the computer on which the Mirasys VMS server or client applications are executed. It is also recommended that server and client software should be used on separate computers.

Minimum Server Requirements

The servers require this minimum (small) system configuration:

Hardware:

  • Intel Core i3, or better
  • 8 GB of RAM recommended
  • Min. 1 TB HDD
  • Min 100 GB C:drive space

In a basic configuration, one hard disk may be enough, but for secure multi-disk recording (modified RAID 0), at least two disk units are required (see the Mirasys VMS Network Storage Guide for further information). A separate disk for the operating system and application software is also recommended.

Use of 24/7 optimized HDDs is highly recommended.

Note: The VMS software reserves by default 90% of available disk space on other drives than the C-drive for storage use. It does not use the C-drive for storage, except when it is the only drive.

Display adapter with at least 128 MB memory (a dual-head display adapter is optional). Please note that display adapter performance can vary greatly depending on the adapter and the bus architecture used to connect the adapter to the motherboard.

Two 1 Gbps (separate network connections for the camera network and the system network, see the Mirasys VMS Networking White Paper for further information).

Minimum Client Workstation Requirements

These are the minimum requirements for Mirasys VMS client applications (such as Spotter for Windows or the System Manager).

The following hardware specification should be viewed only as the minimum requirements for a smallscale surveillance system.

  • Intel Core i3, or better (when using H.264 cameras in the system, quad-core processors are recommended).

  • The recommended processor allows simultaneous viewing of more than 10 cameras at a higher resolution than VGA (640×480).
  • Min. 8 GB RAM recommended
  • Min. 20 GB of free disk space
  • Display adapter with at least 512 MB of memory. Video adapter memory amount and performance will impact capacity to display simultaneous recorded or live camera streams. Please note that display adapter performance can vary greatly depending on the adapter and the bus architecture used to connect the adapter to the motherboard.

OS Compatibility

Mirasys VMS V8 supports the following operating systems:

Operating System

Server with analog camera support via capture cards

Server with only IP cameras or connected video servers (encoders)

Gateway server

System Manager client application

Spotter for Windows client application

Windows 2008 Server R2 Enterprise

32-bit Mirasys VMS V7 or earlier only

X

X

X

-

Windows 2008 Server R2 Foundation

-

X

X

X

-

Windows 2012 Server Standard Edition

-

X

X

X

-

Windows 2012 Server R2

-

X

X

X

X

Windows 10

-

X

X

X

X

Windows Server 2016

-

X

X

X

X

Windows Server 2019

-

X

X

X

X

Note:

  • Mirasys VMS has not supported Windows XP since Mirasys VMS version 6.4. If Windows XP support is required, do not install Mirasys VMS 6.4, or any later releases.
  • Make sure that the “Desktop Experience” feature is activated for Windows server operating systems.
  • No releases before Mirasys VMS V7.4 has support for Windows 10. Any older versions (V7.3 or older), if used with Windows 10, must be upgraded to the latest V7.4 release, or later versions.

Network Requirements

These network requirements apply to systems where users access the servers over a network.

Please see the Mirasys Networking White Paper and the Mirasys Network Storage White Paper for information on networking recommendations, limitations and rules.

General

A 1 Gbps Ethernet is required on both the client and the server side (see Bandwidth Requirements).

Data can be transmitted over the Internet, intranet, LAN, WAN, WLAN, ISDN, ADSL, or any other network using TCP/IP.

For best performance, the camera network should be closed to other network traffic and kept separate from the system network used for server-server or server-client communication.

It is heavily recommended to have at least two 1 Gbps network adapters for each server: at least one adapter for the camera feeds and one adapter for server-client and server-server communications.

In the case of large systems with multiple high resolution and high frame rate cameras, separating specific camera sets into their own networks (and adding network adapters to servers) can be recommended. However, this done case-by-case, and requires case specific calculations on network load.

PTZ (Pan-Tilt-Zoom) control requires a low latency in the network to make dome control as responsive as possible.

Network Card Settings

Network card setting requirements:

  • Interrupt Moderation Rate --> Extreme
  • Receive Buffers/Receive Descriptors --> 2048
  • Transmit Buffers/Transmit Descriptors --> 2048

If the network card cannot be adjusted to these settings, replace the card.

IP Addresses

The servers must have static IP addresses, so that the client programs can connect to them. The Agile Virtual Matrix (AVM) Display Servers should also have either static addresses or names, as the connection from AVM operator console to the display servers is done either with IP address or computer name.

You can use some NAT solutions with the system but not all:

  • Static network address translation (NAT) can be used between the servers and the client programs.
  • Dynamic NAT cannot be used because the IP addresses can change.
  • Single-address NAT works if there is only one server in the NAT system. It does not work if there is more than one server in the same system.

Ports

These ports must be open on the servers:

  • 5008 (TCP), between SMServer (System Manager service) and client programs. Port rule: open inbound
  • 5009 (TCP), between DVR Server and client programs. Port rule: open inbound
  • 5010 (TCP), between Watchdog Service and client programs. Port rule: open inbound
  • 5011 (TCP), between Streaming Service and client programs. Port rule: open inbound

Note:

  • If you are using Windows Firewall, the VMS installer can automatically create exceptions for the required ports.
  • Automatic port forwarding can configure the ports to be different than these default ones.

Bandwidth Requirements

The bandwidth requirements for the network between the servers and client programs depend on a number of factors. Here are a few aspects to think about:

  • Data transmission from the servers to the client computers (uplink) requires more bandwidth than data transmission from the client computers to the server (downlink). The connection does not have to be symmetric.
  • Real-time monitoring requires more bandwidth than transmitting recorded video or audio.
  • In addition, signaling and protocols increase the required bandwidth.

Data Security

The system uses a data protection mechanism and user authentication. However, using public networks always includes a security risk because there are no completely secure systems available on the Internet.

For this reason, dedicated networks should be used whenever possible to prevent unauthorized access to the system. Consider using a Virtual Private Network (VPN) to create a secure connection between computers on a public network.

Antivirus programs should also be used if the system units are on a public network (internet, intranet).

Server Installation

This chapter shows how to install the Mirasys VMS software on a computer that has not already a previous version installed.

To set up the server:

  • Connect the display, mouse, and keyboard to the computer.
  • Connect the network cable to the computer (for network use).
  • Connect all power cords and turn on the power.
  • If your system has analog cameras, connect the cameras to the encoder, and treat the encoder as an IP camera.
  • Install the server software. Please see the chapter Installing The Software for information on installing the required software.
  • Install IP cameras and other devices. Please see chapter Installing Devices for further information.
  • Install the client applications. Please see chapter Installing Client Programs for further information.
  • If your system will utilize WebClient or Spotter Mobile applications, you will need to install the Mirasys Gateway server. For further information, please see chapter Mirasys Gateway Server Installation.
  • For advanced users only: if your system contains VCA components, install and configure the required software.

To update recording software and client applications:

Please see the chapter Updating for information on updating server or client software.

Failover Servers - Optional

Mirasys VMS supports failover video recording servers. Failover servers are VMS Servers that are on a passive standby until the system recognizes that one of the active video recording VMS Servers has broken down; at this point a failover server takes the place of the broken server. The broken server can be repaired and replaced as a new failover server, while the failover server that took its place can continue operating as an active server.

For details, see the Mirasys MS Administrator Guide.

Installing The Software

During server software installation, the installer designates the material disks used to store the recorded data. Effectually, the server installer scans the locally available HDDs and grabs any sufficiently large drive automatically for material storage purposes. The operating system disk is omitted.

If the automatic storage configuration does not detect a disk, the storage drives can be added later using system manager.

If the automatic storage configuration is grabbing disks that are not intended for material storage, the automatic logic can be disabled from installer.

The HDD’s don’t need to be same size like in earlier Mirasys VMS releases.

After designating the material disks, the installer appropriates all except 10 GB of it for data storage.

It is highly recommended not to use USB HDDs in the server, as they will be used as data storage disks in addition to other HDDs. If, however, you need to have USB HDDs connected to the server, it is highly suggested that you disconnect them before installing Mirasys VMS server software. You can attach them after installing the software, and they will not be used as material disks unless specifically designated through System Manager. (The same applies to other HDDs added after server installation.)

If you do not disconnect the USB HDDs before software installation, the server software will automatically use them to store server media files.

Note:

  • These instructions apply only when installing software to a new server or re-installing software to a server not provided by Mirasys. When re-installing software to a server provided by Mirasys after e.g. a hard disk failure, please see Flash Memory Backup / Restore for further information.
  • Mirasys VMS will require SQL Express 2014 to be installed on the Master server. Also the “full” Microsoft SQL Server 2014 works, but then the configuration has to be customized. Mirasys l provides an installer which will install the SQL Express with correct settings as part of the VMS install. If you are planning to use for example Microsoft SQL Server Standard or Enterprise, contact Mirasys support on how to configure the SQL connection string to get the database connection working correctly.
  • Mirasys VMS is available as Full installer and Limited installer.
    - The Limited installer can be used with
     * Client application installs
     * Networked VMS Server installs or upgrades when no Mirasys VCA is required
     * Upgrade installs when SQL is already installed
    - The Full installer should be used with
     * Master Server installs
     * VMS Server installs when Mirasys VCA is required

To install the server software:

  • Copy the installer package somewhere on the machine where you want to do the install.
  • Start the VMS installer by double clicking the installer file Release_8XX_DVMS_x64_Full.exe or Release_8XX_DVMS_x64_Limited.exe
    Note: The Mirasys VMS 8.x software is not compatible with earlier Mirasys VMS licenses. If you are upgrading from Mirasys VMS 7.x or earlier, it is important to update the license key before continuing to install the software. If the software is upgraded before the license key is updated, all server specific information (including profiles and stored material) will be lost. Please see Obtain a License Key for information on updating the license key.
  • In Welcome to the VMS Installation, click Install.
  • If you are installing a new system with the Full installer and the installer detects that the system needs MS SQL server, installation of MS SQL Express 2014 will start. This takes approximately 7-8 minutes. If installer detects already a SQL installation on the PC, this step is skipped automatically
  • Installer next installs SlimDX to the system. This takes approximately 30 seconds
  • After this, the “Welcome to VMS Setup Wizard” is displayed. Click Next.
  • In the next screen, you can select various installation options
  • If you install the Recording Server service, you will need a VMS license. If you only install client applications, you will not need a VMS license.
  • By default, the setup program installs the server and the applications System Manager, Spotter, and System Monitor:

If you do not want to install the applications on the server, open the menu next to Applications and select Entire feature will be unavailable.

You can also define if Spotter or System Monitor should start automatically.

If you want firewall exceptions set automatically for Windows Firewall, open the menu next to Set firewall exceptions and select Will be installed on local hard drive. Do not select this option if you are not using Windows Firewall.

Click Next.

Select the destination folder and click Next.

Select the process startup setting. In master server where the SQL Server is installed, it is recommended to select the middle setting. In normal servers it is recommended to select the top setting.

If automatic port forwarding is needed, you can activate this in the next installer screen. For systems which don’t have external network access, the automatic port forwarding option can be disabled. This setting can be controlled later in system manager application.

In the Installation Configuration dialog box, specify the IP address or DNS name of the Master Server. The Master Server is the server where all system configuration data is stored when more than one server is used in the same system. (This dialog box is not shown if only the server is installed). If the Master Server is the local computer, use the default value 127.0.0.1. Then click Next.

Then click Install to start the installation.

When the server has been installed, the dialog box “Completed the VMS Setup Wizard” is shown.

Click Finish.

For information about setting up the server, see Server Installation.

For information about how to install the client programs, see Installing Client Programs.

Set The TCP/IP Addresses

To set the TCP/IP addresses in Windows:

  • Click Start, point to Settings and then click Control Panel.
  • Double-click Network and Internet.
  • Double-click Network and Sharing Center.
  • Click “Change adapter settings”
  • Right-click on the network adapter of your choice and choose Properties.
  • Click Internet Protocol v4 (TCP/IP) and then click Properties.
  • Select Use the following IP address and type a static IP address. Also specify the Subnet Mask, Default Gateway and DNS Server address.

Set The Master Server’s IP Address to The System Files

If the server will function as the Master Server of a system, and if it will be accessed over a network, you have to set the server’s IP address through the System Manager application.

To set the IP address through System Manager:

  • Start System Manager locally on the Master Server as instructed in the Administrator Guide.
  • In the System tab, click Change server addresses.
  • Click on Local Server.
  • Click the Change server address button .
  • Type the new IP address or DNS name of the server into the New server address field.
  • Click OK.

Note: You only need to set the local IP address for the Master Server of a system if the server can be accessed over a network. If the server is accessed locally, there is no need to set the address.

Enable Time Synchronization

When more than one server is used in the same system, the Master Server keeps the clocks of all networked VMS Servers synchronized. Master will synchronize the clocks using the computer clock as the source.

For this reason, one server should not belong to more than one system. The Master Server synchronizes the clocks once a day. However, if the time difference between the clock on the Master Server and the clock on the other server is more than 29 minutes, the clocks are not synchronized.

For the time synchronization to work correctly, the Windows time synchronization must be disabled on the other servers. However, it can be enabled on the Master Server.

To disable Windows time synchronization:

  • Click Start, point to Settings, click Control Panel, and then double-click Date and Time.
  • On the Internet Time tab, make sure that the check-box Automatically synchronize with an Internet time server is not selected.

Obtain a License Key

By default, without a VMS license, the server supports only one IP camera. To get the full functionality, get a license key from Mirasys. For the license key, you need the MAC address of the server.

To get a license key:

  • Start System Manager. The License Information dialog box is automatically shown when no license key has been specified.
  • On the System tab, under Licenses, double-click the server that you want to update.
  • In the License Information dialog box, copy the MAC address and send it to orders@mirasys.com In return, you will receive the license key as a text file.
  • Click Import license from file.
  • Click OK. The system is updated immediately.

Note:

  • The default unregistered state that allows the use of one IP camera has been time limited. The unregistered state can be active for up to 60 days, after which a valid license key is required. Unless a valid license key is not added to the system within 60 days after the installation, the system will cease to operate.
  • For information on acquiring VCA feed source licenses, please refer to Installing VCA Feed Source Licenses.

Setting Up The System

After connecting the cameras and other devices to the servers, configure the system settings and add user accounts and user profiles.

To configure the system:

  • Start System Manager locally or over a network (click the System Manager icon on the desktop).
  • Add servers to the system and configure their settings on the VMS Servers tab.
  • Add user profiles on the Profiles tab.
  • Add user accounts on the Users tab.
  • Install the client programs on the end users’ computers. See Installing Client Programs.

For more information about how to configure the system, see the Administrator Guide.

Installing Devices

Installing IP Cameras

You can connect supported IP cameras and video servers to a server over a TCP/IP network. An IP camera has a built-in component for capturing video images. The camera is connected directly to a local area network, and it has its own IP address.

You can also use video servers (encoders) to change analog cameras into IP cameras. Video servers are also connected directly to the local area network, and they have their own IP addresses.

For a list of supported cameras, see the document Supported IP Cameras on that can be accessed from Mirasys Extranet.

Please see the Administrator Guide for instructions on installing IP cameras to the system.

Setting Up DirectX PTZ Joysticks

Any DirectX joystick can be used, but you can contact your supplier for a list of devices that are proven to work best.

Connect the DirectX device to your computer and wait for the driver to be installed.

Calibrate the joystick in windows. Press “Start” and write “USB game” and then select the “Set up USB game controllers” option

Select the device from the list and click “properties”

Select “settings” and then “Calibrate” and follow instructions.

After this, start Spotter application and then configure the input device settings in spotter to get the joystick working. Please see the Spotter User Guide for further details.

Installing Client Programs

You can use the client programs locally on the server or on a computer that has a network connection to the server system.

To install the client software:

  • Unzip the installer package somewhere on the machine where you want to do the install.
    Note:
    - Clients can be installed either with the VMS installer file Release_8XX_DVMS_x64.exe OR with an available “Spotter -only” installer file.
    - SQL Server is not needed for client install, so use the “Limited” DVMS installer file for installing only the clients.
  • Start the VMS installer by double clicking the installer file Release_8XX_DVMS_x64.exe
  • In Welcome to the VMS Installation, click Install.
  • Installer next installs SlimDX to the system. This takes approximately 30 seconds
  • After this, the “Welcome to VMS Setup Wizard” is displayed. Click Next.
  • In the next screen, you can select various installation options
  • When you are installing clients, uncheck the “Recorder” option and make sure that the “Applications” option is checked.
    - If you want firewall exceptions set automatically for Windows Firewall, open the menu next to Set firewall exceptions and select Will be installed on local hard drive. Do not select this option if you are not using Windows Firewall.
  • Click Next.
  • Select the destination folder and click Next.
  • In the Installation Configuration dialog box, specify the IP address or DNS name of the Master Server. The Master Server is the server where all system configuration data is stored when more than one server is used in the same system. (This dialog box is not shown if only the server is installed). If the Master Server is the local computer, use the default value 127.0.0.1. Then click Next.
  • Click Install to start the installation.
  • When the server has been installed, the dialog box “Completed the VMS Setup Wizard” is shown.
  • Click Finish.

Compatibility

Mirasys 8.x servers are compatible with Mirasys 8.x, 7.x and 6.x networked VMS Servers. The Master Server always needs to be same or higher version than the network node VMS Servers.

Updating

Updating a Server

To update a server, first remove the current software version and then install the new software version.

Important: Backup system settings and server settings in System Manager before removing the current version and then restore the settings after the update is completed.

To remove the current server version:

  • Click Start, point to Settings, click Control Panel, and then double-click Uninstall programs.
  • Click DVMS and then click Uninstall and then review the installation instructions earlier in this guide.

Updating Client Programs

The client programs are updated automatically to the same program version as the Master Server when they are started.

To manually update the client programs, first remove the current version and then install the new version by running the VMS installer.

To remove the current version:

  • Click Start, point to Settings, click Control Panel, and then double-click Uninstall programs.
  • Click DVMS and then click uninstall and then review the installation instructions earlier in this guide.

Updating VMS Servers From Master Server

Updating VMS Servers remotely through the Master Server has been possible since Mirasys VMS 6.2.5.

To update VMS Servers remotely, first update the Master Server to the latest version. In the System Manager, update the licenses for the individual VMS Servers through the 'Licenses' list in the 'System' tree. After updating the licenses, you can update the VMS Servers remotely by using the 'Update servers' tool in System Manager.

Note:

  • This feature is available only if the VMS Servers have Mirasys VMS 6.2.5 or later. In case the VMS Servers have an earlier version, you need to install Mirasys VMS 6.2.5 or newer on them manually to enable remote server updates.
  • In some cases, the VMS Servers might need restart of PC after remote software update. Monitor the servers after a remote update, and if they do not return online in 10 – 15 minutes, restart the PC they are running on.
  • Please remember the different 32-bit and 64-bit versions when doing remote updates. If a system is partially 64-bit, do not push 64-bit update to all servers.

Updating Components

In addition to camera drivers and Spotter Plugins, it is possible to also update metadata drivers from System Manager.

Spotter Plugins are updated by removing the old version and adding a new version *.spi file to the system.

Metadata drivers offer the possibility to update the drivers to whole system or only selected servers.

Contact Mirasys for more information on available metadata drivers and updating them.

Flash Memory Backup / Restore

Mirasys VMS includes an automatic flash memory based backup and restore functionality (“ABUR”). This feature is only available on servers delivered by Mirasys Ltd.

The flash memory backup and restore functionality is intended for situations in which the operating system and hard disk have failed and the server hard disk needs to be re-formatted or replaced.

The automatic flash memory functionality can backup and restore the following:

  • Windows OS
  • Mirasys VMS software
  • Mirasys VMS license
  • Server configuration files

The automatic flash memory functionality does not include the following:

  • Windows OS updates made after server delivery
  • Any VMS software updates made after server delivery
  • Any driver updates made after server delivery

Note:

  • It is important to note that the automatic restore function restores the VMS software version that was delivered with the server. The same applies to IP camera drivers. If the server has been updated or new drivers installed, the software needs to be updated after restore, and the IP camera drivers will need to be reinstalled.
  • It should be noted that the first backup is done on the midnight of each day (unless changes are made to the configuration during the hour before midnight, in which case backup is delayed until the next day).

Flash Memory Backup

The flash memory functionality automatically backs up the server configuration and license files at installation and after that each time there are changes in them. The server automatically handles all steps of the process, and there is no need for the users to do anything to enable the functionality.

Flash Memory Restore

In case of operating system being corrupted or hard disk failure, the system administrator may need to restore the system from the automatic backup files. The process is mostly automatized, but the user needs to perform some steps.

To use the flash memory, restore functionality:

Set the computer BIOS to boot from USB devices. Ensure that there are no other USB memory devices or other boot media connected.

Once the Windows loader starts, select either:

Format the hard disk – Use this option to format a hard disk that has already been in use. This option should be used when the operating system has been corrupted and the hard disk needs to be reformatted.

Blank installation – Use this option to restore the system to a blank hard disk. This option should be used when the hard disk has been changed and a blank one has been installed on the computer.

Once the Windows installer starts, select the appropriate country, time zone, and language options.

Once the VMS software loader starts, choose either:

Don’t install VMS – Choose this option if you do not want to install Mirasys VMS software.

Drivers are installed properly. Continue to install VMS – Choose this option if want to install Mirasys VMS software.

After the server software has been installed, the configuration files and license information is automatically restored.

When rebooting the computer, remember to go to the BIOS to disable booting from USB devices.

Mirasys Gateway Server Installation

Mirasys WebClient is a browser-based application that is used for viewing video from Mirasys servers over a network. Mirasys WebClient uses the same user profiles, user names, and passwords as Mirasys System Manager and Spotter client programs.

To be able to use Mirasys WebClient, the Mirasys Gateway server must be first installed on a computer running a HTTP (web) server. Mirasys VMS recording software is not required on the server. The Gateway server needs to be able to connect to the Mirasys VMS Master Server.

Minimum System Requirements

Client:

  • Internet Explorer 6 or Mozilla Firefox 2.0 or newer
  • Java Runtime Environment (latest version recommended for security reasons)

Server:

  • Windows 7 Enterprise, or Windows 2008/2012 Server
  • HTTP server software (IIS)
  • Intel i3 processor, or better
  • 4 GB of RAM

Note: Please note also that the minimum system requirements are recommended for mostly live viewing. If multiple users access the same WebClient server simultaneously mainly for search and play back functions, a more powerful processor is required.

System Restrictions

The Mirasys VMS Gateway server can be installed on any Microsoft Windows server that meets the system requirements. Mirasys VMS software is not required on the server.

The Gateway server has a default license controlled limitation of 32 simultaneous streams for all WebClient connections. The limit is universal and user independent; if, for example, User A has 30 open video streams and User B has 2 open video streams, neither can open any more streams unless one or more of the currently open streams are closed.

Installing The Mirasys Gateway Server

To install the Mirasys Gateway server:

  • Double-click the Release_8XX_Gateway_x64.exe installation package to start the installation.
  • After the VMS Gateway Setup screen has loaded, select the destination folder and click Next.
  • Type the SMServer IP address (the IP address of the Master Server) into the SMServer IP field.
  • Click Next
  • When the software has been installed, click Finish.

Verifying The Installation

To verify that the server has been correctly installed:

Open a compatible web browser and type the following address:

http://[WEBCLIENT SERVER URL]:[PORT]/

For example, if the WebClient server is on the same computer:
http://localhost:9999/

If the server is correctly installed, the logon screen is displayed. Type a user name and password in the corresponding boxes and click Log On. The user name and password are set in the Mirasys System Manager program.

Streaming Options

The users can view the WebClient streams in JPEG format (default) or in the native format in which they are received by the servers. This does not require any action on the server side: the users can decide to view the streams in native format by adding ?video=native to the end of the WebClient URL.

For example, if the WebClient server is on the same computer:

http://localhost:9999?video=native

Installing Spotter Plugins

Spotter plugins can be added to system from System Manager.

Spotter plugins are added to System Manager as *.spi files from the system manager first tab – Add-ins – install client plugin.

Each plugin needs to be enabled in the master license. If the plugin is not in the license, it can be installed, but will not be deployed to the Spotter clients of the system.

After plugin is installed to System Manager, each Spotter client that logs in to this Master Server (SMServer), gets the updated plugin next time the client is started.

Development of custom plugins is possible. Contact Mirasys for further information.

Installing VCA Components

Mirasys provides configuration services for the VCA functionality; for further information, please contact Mirasys.

This section of the manual only covers installing basic VCA functionality. Please refer to the Mirasys VMS VCA Installation and Configuration Guide for more information on using VCA with Mirasys products.

Mirasys VMS supports both analog and IP based VCA services. The VCA functionality allows using VCA metadata for creating alarms based on metadata information. This functionality requires separate licensing (see below).

Installing VCA components to a Mirasys VMS system requires the following steps:

  • Installing a database to each Mirasys VMS server with VCA streams
  • Adding VCA channel license keys to each server with VCA streams
  • Configuring the VCA cameras
  • Configuring alarm events based on VCA messages in System Manager

These steps are further discussed below.

Important: It is important to note that the licenses and the database are server specific and need to be installed on the server(s) on which the VCA feeds are situated. If a system contains multiple servers, the licenses and database must be installed separately on each server with VCA feeds.

Note: VMS comes pre-installed with drivers for VCA metadata analysis and metadata enrichment. The drivers can be updated later from system manager application.

Database Installation

Install MS SQL Server 2014 with a separate ExpressInstaller.exe or with the built in SQL installer of the VMS installer (Full installer).

The database must be installed separately on each server with Mirasys VCA.

Adding License Keys

The VCA functionality requires VCA channel licenses for each VCA camera feed.

The VCA license keys can be acquired at the same time as the server license key (see Obtain a License Key for further information).

Installing VCA Channel Licenses

The server license must include a VCA channel licenses for each VCA camera feed. VCA channel licenses can be added during default VMS license addition or separately (see Obtain a License Key for further information).

Installing VCA Software Licenses

The system requires a VCA license for each VCA source; i.e. for IP camera based VCA feeds. These licenses can be acquired by contacting orders@mirasys.com and sending a server specific hwguid.txt file for each server for which you want to add VCA channels.

To acquire VCA licenses:

Start the VCA Configurator (in the DVMS folder)

Note: Starting VCA Configurator automatically pauses Mirasys VMS server functions. Exiting VCA Configurator automatically restarts the server functions.

On the upper side of the VCA Configurator window, select the devices for which you want to create hwguid.txt files. Each device will have its own HWGUID file.

Contact Mirasys to get the VCA licenses. Attach the device specific hwguid.txt files to the mail.

After getting the licenses, use VCA Configurator to import each license.

Camera Configuration

After importing the licenses, you can configure the cameras with VCA functionality in the Camera tab in the VCA Configurator application.

To configure VCA zones and calibration:

  • Calibrate the VCA functionality.
  • Create zones and rules.
  • Test the functionality of your rules.

As the configuration rules and parameters are extremely flexible and it is easy to do user errors, Mirasys can take no responsibility for the functionality of any user specified configurations. However, Mirasys provides configuration services for the VCA functionality.

VCA Installation

The VCA based alarms are configured through System Manager through the default alarm management functionality. The VCA events are used as alarm start and end triggers.

Please see the Mirasys VMS Administrator Guide for information on creating alarms.