0% found this document useful (0 votes)
1K views90 pages

9600-0427 Software Installation Manual, Issue 9.3.0v1

Uploaded by

Patrick Allan
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
1K views90 pages

9600-0427 Software Installation Manual, Issue 9.3.0v1

Uploaded by

Patrick Allan
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 90

Symmetry Software

Installation Manual
For Business, Professional and Enterprise Editions
9.3.0 v1

SECURITY MANAGEMENT SYSTEM

9600-0427
© G4S Technology Limited. 2020
All rights reserved. No part of this publication may be reproduced in any form without the
written permission of G4S Technology Limited.

Challenge House, International Drive,


Tewkesbury, Glos, GL20 8UQ, U.K.
Telephone: +44 (0) 1684 850977

Symmetry Software Installation Manual


9600-0427
Issue 9.3.0v1 (for version 9.3.0 of Symmetry) – 13th February 2020

Microsoft and Windows are registered trademarks of Microsoft corporation.


Intel, Core and XEON are trademarks or registered trademarks of Intel Corporation.
Aperio is a trademark of Assa Abloy AB.
VMware is a registered trademark of VMware, Inc.
Suprema and identifying product names are registered trademarks of Suprema, Inc
All trademarks acknowledged.
Contents
1. Preface .........................................................................................................................v
About this Manual ........................................................................................................................................ v
Related Documents ...................................................................................................................................... v
1. Chapter 1: Introduction ..............................................................................................1
Symmetry Editions ....................................................................................................................................... 1
Examples of System Architecture ................................................................................................................ 2
Example 1: Installation on a Single Computer ....................................................................................... 2
Example 2: Using a Separate Symmetry Server ..................................................................................... 2
Example 3: Using Separate Symmetry and Database Servers ................................................................ 3
Advantages of using a Separate Database Server ................................................................................... 4
Example 4: Virtualized Solutions ........................................................................................................... 5
Example 5: Global Edition ..................................................................................................................... 5
Installation Sequence ................................................................................................................................... 6
Hardware and Software Recommended Requirements ................................................................................ 7
Symmetry Business/Professional Server, Client (any Edition) or NVR ................................................. 7
Symmetry Enterprise Server ................................................................................................................... 8
Separate Database Server (Enterprise Edition only) ............................................................................... 8
Virtualization Minimum Hardware Requirements ....................................................................................... 9
Virtualization Technologies .................................................................................................................... 9
Host Machine Minimum Requirements .................................................................................................. 9
Symmetry Server (Professional or Enterprise) VM Minimum Configuration ...................................... 10
Symmetry Client VM Minimum Configuration ................................................................................... 10
Symmetry Network Video Recorder (NVR) VM Minimum Configuration ......................................... 10
Maintaining Symmetry NVR or Video Performance ................................................................................. 11
Symmetry NVR Operation ................................................................................................................... 11
Live Video Display or Playback ........................................................................................................... 11
Network Requirements for NVR Operation ......................................................................................... 11
Disk Type.............................................................................................................................................. 11
Optional Hardware/Software ..................................................................................................................... 12
Email Integration .................................................................................................................................. 12
COM Ports ............................................................................................................................................ 12
Printer ................................................................................................................................................... 12
Card Encoders ....................................................................................................................................... 12
Signature Pad ........................................................................................................................................ 12
Badge Printers ....................................................................................................................................... 12
Automatic Updates ..................................................................................................................................... 12
2. Chapter 2: Pre-Installation Tasks (for Business or Professional Edition) ...........13
Step 1 – Obtain Static IP Addresses ........................................................................................................... 13
Step 2 – Obtain Permissions to Install Symmetry ...................................................................................... 13
Step 3 – Create ACS Groups (domain only) .............................................................................................. 13
Step 4 – Choose the Symmetry Services Account ..................................................................................... 14
Permissions for a Named Services Account ......................................................................................... 14
Step 5 – Assign Users to ACSUsers........................................................................................................... 14
Step 6 – Install SQL Server ........................................................................................................................ 14
Step 7 – Configure SQL Server.................................................................................................................. 15
Step 7a – Enable the TCP/IP Protocol .................................................................................................. 15
Step 7b – Configure the Firewall for SQL Server ................................................................................ 15
Step 7c – Configure the SQL Server Browser Service ......................................................................... 15
Step 8 – Check Windows Time Service Configuration.............................................................................. 15
Step 9 – Check Printer Configuration ........................................................................................................ 15

i
Contents

Step 10 – Obtain Symmetry Licenses ........................................................................................................16


Step 11 – Disable Database Optimization Software (if used) ....................................................................16
Step 12 – Set Power Options ......................................................................................................................16
Step 13 – Configure Firewalls ....................................................................................................................16
3. Chapter 3: Quick Install Instructions (Single-Machine Installation)..................... 17
Introduction ................................................................................................................................................17
Installation ..................................................................................................................................................17
Starting Symmetry......................................................................................................................................17
4. Chapter 4: Installing Symmetry ............................................................................... 18
Introduction ................................................................................................................................................18
Overview of Installing Symmetry .........................................................................................................18
Installing the Symmetry Server Software...................................................................................................18
Installing a Language Pack ...................................................................................................................24
Installing Symmetry Client Software .........................................................................................................25
Installing a Symmetry NVR .......................................................................................................................28
Starting Symmetry......................................................................................................................................31
Default Login User Names and Passwords ...........................................................................................31
Command-Line Logons ........................................................................................................................31
Network-Locking Command-Line Switch............................................................................................31
5. Chapter 5: Post-Installation Tasks .......................................................................... 32
Installing Optional Features .......................................................................................................................32
Configuring Antivirus Software .................................................................................................................32
Displaying the Symmetry Service Monitor ................................................................................................33
Installing Encoder Files ..............................................................................................................................33
Configuring and Testing Backups ..............................................................................................................33
Configuring and Testing Archives .............................................................................................................34
Setting Up Dial-Up Local/Remote Modems ..............................................................................................34
USRobotics Sportster Modem with DIP Switches ................................................................................36
USRobotics Sportster Flash ..................................................................................................................37
Hayes Modems......................................................................................................................................37
Setting up Node Card Auditing ..................................................................................................................38
6. Chapter 6: Configuring Symmetry .......................................................................... 39
Configuration Steps ....................................................................................................................................39
Installer Tasks .......................................................................................................................................39
End-User Configuration Tasks..............................................................................................................40
7. Chapter 7: Removing, Changing and Repairing Symmetry .................................. 41
Changing, Repairing or Removing Symmetry ...........................................................................................41
Removing Symmetry..................................................................................................................................42
Removing the Symmetry Client or NVR Software...............................................................................42
Removing the Symmetry Server Software ............................................................................................42
Removing SQL Server ..........................................................................................................................42
8. Chapter 8: Upgrading Symmetry............................................................................. 43
Introduction ................................................................................................................................................43
Prerequisites ...............................................................................................................................................43
Removal of Unsupported Features ........................................................................................................43
Disk Space ............................................................................................................................................44
Minimum System Requirements ...........................................................................................................44
New Symmetry Licenses ......................................................................................................................44
Symmetry SMS Player ..........................................................................................................................44
Symmetry 75xx Cameras ......................................................................................................................44
Passwords..............................................................................................................................................44
Symmetry XML Open Integration Module...........................................................................................44
Auto-Rollback ............................................................................................................................................44
Typical (Same-Machine) Upgrade Procedure ............................................................................................45
Step 1 − Check the Prerequisites...........................................................................................................45

ii
Contents

Step 2 − Shut Down the Symmetry Clients and Services ..................................................................... 45


Step 3 − Upgrade Microsoft SQL Server .............................................................................................. 45
Step 4 − Upgrade the Symmetry Server ............................................................................................... 45
Step 5 − Log in to Symmetry and Install the Symmetry Licenses ........................................................ 46
Step 6 − Upgrade the Symmetry Clients............................................................................................... 47
Step 7 − Upgrade Symmetry API Servers ............................................................................................ 47
Step 8 − Upgrade Symmetry NVRs ...................................................................................................... 47
Advanced (New-Machine) Upgrade Procedure ......................................................................................... 48
Step 1 − Check the Prerequisites .......................................................................................................... 48
Step 2 − Understand the Upgrade Procedure ........................................................................................ 48
Step 3 − Install SQL Server and Restore the Databases (Scenarios 1, 3 and 4) ................................... 49
Step 4 − Shut Down the Symmetry Server and Clients (Scenarios 2 and 4) ........................................ 50
Step 5 − Run the Symmetry Installer (all Scenarios) ............................................................................ 50
Step 6 − Log in to Symmetry, Choose the Server and add the Licenses (all scenarios) ....................... 52
Step 7 − Update MultiMAX.ini ............................................................................................................ 52
Step 8 − Install or Upgrade the Symmetry Clients ............................................................................... 52
Step 9 − Upgrade Symmetry NVRs ...................................................................................................... 53
Step 10 − Upgrade Symmetry API Servers .......................................................................................... 53
Step 11 − Remove Symmetry from Previous Machines ....................................................................... 53
Silent Upgrades (Symmetry Clients only) ................................................................................................. 53
Batch File Format ................................................................................................................................. 53
A. Appendix A: About the .ini File Settings .................................................................55
MultiMAX.ini Settings .............................................................................................................................. 55
B. Appendix B: Windows Security Groups .................................................................66
Groups Used by Symmetry ........................................................................................................................ 66
ACSUsers ............................................................................................................................................. 66
ACSServices ......................................................................................................................................... 66
ACSReporting....................................................................................................................................... 67
C. Appendix C Badge Printer Setup .............................................................................68
Fargo HDP5000 Driver Setup .................................................................................................................... 68
Fargo DTC4250e/4500/4500e Driver Setup .............................................................................................. 69
D. Appendix D: Port Usage ...........................................................................................71
Standard Ports for General Microsoft Software.................................................................................... 71
Microsoft SQL Server ........................................................................................................................... 72
Symmetry Node/Device/Client Communications ................................................................................. 72
Emails ................................................................................................................................................... 72
RDS/Citrix Access ................................................................................................................................ 72
Symmetry NVR .................................................................................................................................... 73
Video .................................................................................................................................................... 73
Bosch Cameras ..................................................................................................................................... 73
Panasonic Cameras ............................................................................................................................... 73
Sony Cameras ....................................................................................................................................... 74
Symmetry Cameras ............................................................................................................................... 74
Microsoft Clustering ............................................................................................................................. 74
NEC Clustering..................................................................................................................................... 74
SALTO Interface .................................................................................................................................. 75
XML Open Integration ......................................................................................................................... 75
E. Appendix E: Restoring Symmetry ...........................................................................76
Restoring Symmetry and SQL Server ........................................................................................................ 76
Restoring the Symmetry Database ............................................................................................................. 76
F. Appendix F: Symmetry Performance Tuning and Maintenance ...........................78
Pre-Installation Tuning............................................................................................................................... 78
Network Speed...................................................................................................................................... 78
SQL Server ........................................................................................................................................... 78
Replicated/Mirrored Installations ......................................................................................................... 79

iii
Contents

Post-Installation Symmetry Maintenance...................................................................................................80


Symmetry Machines .............................................................................................................................80
Microsoft SQL Server ...........................................................................................................................81
Symmetry Operation .............................................................................................................................81
Cluster Operation ..................................................................................................................................81
Example Maintenance Schedule ...........................................................................................................82

iv
1. Preface

About this Manual


This manual explains how to install Symmetry Business, Professional and Enterprise editions. The
manual is intended to be used by technical staff who need to install or support Symmetry.

Related Documents
The following documents provide additional information, which you may need when installing
optional modules or utilities:
 Symmetry Security Hardening Guide
 Cluster Installation Manual
 Data Connect Manual
 Directory Sync Manager Installation & User Guide
 Guard Patrol Manager Installation & User Guide
 Intercom Management Installation & User Guide
 Intrusion Management Installation & User Guide
 M2150 Intrusion Guide
 NIC Module Configuration Guide
 SymmetryWEB Installation Guide
 Threat Level Manager Installation & User Guide
 Video Integration SDK Installation & User Guide
 RDS/Citrix Client Access Installation & User Guide
 XML Open Integration Module Installation & User Guide
 Global Edition Installation & User Guide
 Third-Party Access Devices Installation & User Guide
 M4000 Commissioning Guide
This manual should be read in conjunction with the product help, which is also available in printed
form as the Symmetry Reference Manual.

v
1. Chapter 1: Introduction

Symmetry Editions
This manual covers the installation of the following editions of Symmetry:
 Business Edition - A true client/server system suitable for use on a customer network, but limited
to a maximum configuration of 3 clients and 64 readers. Each panel can recognize up to 2000
cards. If required, all software can be installed on a single PC.
Business Edition uses databases managed by Microsoft SQL Server Express, which has been
designed and optimized for use on smaller computer systems.
By default, the Symmetry client software is installed on the server.
 Professional Edition - Professional Edition builds on the capabilities of Business Edition to
provide a maximum of 9 clients and up to 512 readers, depending on the license purchased.
Professional Edition uses SQL Server Express.
 Enterprise Edition - This provides all the features of the Professional Edition system, but utilizes
the full Microsoft SQL Server relational database management system, which meets the needs of
high performance and scalability. Enterprise Edition supports unrestricted expansion for large
systems and the use of a separate SQL database server, which could be used by Symmetry and
other third-party applications.
Enterprise Edition also supports "clustering" (see the Cluster Installation Manual), where two
independent servers are seen as a single server by Symmetry. If one server in the cluster should
fail, the other automatically steps in to continue normal operation.
 Global Edition - This provides enhanced capabilities for centralized card and alarm management
of multiple systems spread over a number of geographically separate sites. A Global Edition
system consists of a "head office" and a number of separate "regions". The head office is used to
define card holders and their access rights centrally for automatic download to the appropriate
regions. The regions upload alarms and events to the head office for centralized alarm monitoring,
as well as local access codes to facilitate the definition of card holder access rights.
An example of the architecture of Global Edition is given on page 5. For further information,
please refer to the Global Edition Installation and User Guide.

1
Chapter 1: Introduction

Examples of System Architecture


The following sections provide typical examples of system architecture.

Example 1: Installation on a Single Computer


Typically, smaller companies use Symmetry Business or Professional Edition, with all Symmetry
software installed on a single computer, as shown in Figure 1. An existing network can be used to
communicate with Symmetry hardware, such as access-control or intrusion nodes.
Although Symmetry is installed using a single install kit and appears to users as a single application,
there are actually several distinct components installed on the one computer:
a) The Symmetry client software – this provides the user interface to Symmetry and is also
responsible for managing communications to Symmetry hardware.
b) The freely-available Microsoft SQL Server Express database engine – this manages the database.
SQL Server 2017 Express can be installed during the installation of Symmetry. If required, other
supported versions of SQL Server Express (see page 7) can be used if installed before Symmetry.
c) The database – this contains the data you see in Symmetry, such as card holder records,
configuration settings and alarm information.
d) The Symmetry server software. This performs various management tasks, including management
of the communications between the Symmetry clients and database.

All Symmetry software


installed on a single
computer, including
database

Network

Symmetry nodes

Figure 1: Installation on a Single Computer


e) Optionally, the Symmetry Network Video Recorder (NVR) software and other software such as
SymmetryWEB (as described in the SymmetryWEB Installation Guide).
By default, the Symmetry services (which run in the background) use the Local System account,
although it is possible to use a pre-defined local or Active Directory account if the system
administrator has a preference.

Example 2: Using a Separate Symmetry Server


The single-computer architecture described in the previous section can be easily expanded by, for
example:
 Installing the Symmetry client software on additional computers. (The Symmetry client software is
always available on the Symmetry server.)
 Installing the Symmetry NVR software on additional or separate computer(s).
An example is shown in Figure 2. An existing Symmetry server requires no modification if additional
clients or NVRs are added at a later date.

2
Chapter 1: Introduction

Symmetry clients
Symmetry server,
including database and
client software. Optionally,
also a Symmetry NVR

Network

Symmetry NVR

Symmetry nodes

Figure 2: Client\Server Architecture


Such an architecture could be used with any edition of Symmetry, but is more often used with
Professional or Enterprise Edition in medium-to-large-sized organizations. The architecture enables,
for example:
 One client to be used by an administrator to set up card holders, manage access rights and produce
reports.
 A second client to be used by a guard to monitor alarms.
 A third client to be used for visitor management.
 Other clients to be used for tasks such as video monitoring or managing communications with
nearby hardware devices.
 Separate machines to be used for Symmetry NVR(s) or other software such as SymmetryWEB,
perhaps for performance benefits.
In larger organizations that use Symmetry Enterprise Edition, the server requires a Windows Server
operating system and a full SQL Server database engine pre-installed. Otherwise, the installation of
Symmetry on the server uses the same install kit as used when installing Symmetry on a single
computer.
Symmetry is compatible with workgroup-based and domain-based networks. When operating in a
domain, Symmetry fully supports the use of Active Directory to define the permissions necessary for
Symmetry users and services.

Example 3: Using Separate Symmetry and Database Servers


Enterprise Edition provides the option of installing the Symmetry database on a separate database
server, as shown in Figure 3 (in this example, rack-mounted PCs are used). The database server, which
requires a full version of SQL Server, may also manage other third-party databases, depending on the
requirements of the site. This architecture is commonly used in large organizations that prefer to use a
dedicated computer to run databases, often for security reasons. Further details of possible benefits are
described in the next section.
When a separate database server is used, a domain-based network must be used due to the security
requirements needed for such architecture.

3
Chapter 1: Introduction

Symmetry server, including


client software. Optionally Symmetry clients
Database server also a Symmetry NVR

Network

Symmetry NVR

Symmetry nodes

Figure 3: Enterprise Architecture Using a Separate Database Server


The permissions to run the Symmetry services and user accounts are defined in the Windows Active
Directory. Since it is unlikely that the installer of Symmetry will have full domain administrator
permissions or even local administrator privileges to the database server, some configuration will need
to be carried out by appropriate system administrator(s) before Symmetry is installed. The Symmetry
Security Hardening Guide describes all tasks that need to be carried out.

Advantages of using a Separate Database Server


In common with other database applications, using a separate database server for Symmetry (Figure 3)
can provide many benefits and may be a necessity for certain organizations.
The key concept of a separate database server is that it enables an application (in this case Symmetry)
and its database to use physically separate machines. For Symmetry, no additional executables or
services need to be installed on the database server.
Using a separate database server may be desirable for a number of different reasons. For example:
 Reduced cost and administration through a single SQL Server deployment
The need to host multiple Microsoft SQL Server databases is commonplace within organizations
due to the number of applications that use databases. Hosting multiple databases on a single
machine running SQL Server rather than on multiple machines can reduce the purchase cost of the
hardware and software, simplify deployment and ease maintenance.
The improved cost efficiency of using a single database server can enable hardware of significantly
higher performance to be purchased for the benefit of all database applications.
The Symmetry database can be installed on a default or named SQL instance, which allows it to be
used alongside other application databases. Symmetry can also share a single instance of SQL with
other databases and use custom port numbers for added security configurations.
 Simplified system administration
Updates necessary to applications or their operating systems may require no software changes at
the database server, which can simplify the process of administering the organization's IT systems.
 Greater protection against harmful software
IT departments consider it good practice to install applications and databases on different
platforms to reduce the amount of software installed on the database machine. This strategy can
reduce the possibility of information held in the databases being compromised by malware or other
harmful software, or resources being consumed by misbehaving applications.

4
Chapter 1: Introduction

 Improved security
Using a separate database server provides better security, both from external (web-based) attacks
and insider attacks/mistakes for several reasons:
‒ Personnel who are responsible for maintaining applications such as Symmetry are unlikely to
need direct access to the database server. This allows the database server to be located in a
separate room, with access provided only to authorized personnel.
‒ An internal or external attacker who manages to compromise part of the network may not be
able to access the database server due to privileges, firewalls or other security measures.
‒ A separate database server can make it easier to install a database firewall between the
applications and the databases. Such devices are capable of analyzing SQL traffic to the
databases, blocking potential attacks, logging activity and providing intelligent tools to
improve security.
 Simplified backup procedures
A database server may make it easier to back up multiple databases used by different applications.
Instead of backing up each database separately at different machines, a database server may allow
all databases on the server to be backed up using a single set of tools and procedures.
 Simplified design of high-availability architectures
Deploying multiple databases onto a single database server can make it easier to design high-
availability solutions using, for example, Microsoft clustering. Should the database server stop
functioning, a failover process causes another server to assume control to provide continuous
service for all relevant applications using the database server.
 Improved tailoring of company resources
A solution that gives the flexibility to deploy the Symmetry database, server and clients onto
separate machines allows these components to be deployed onto machines and in environments
tailored to their function.

Example 4: Virtualized Solutions


The Symmetry server, database, clients and network video recorders can be installed as virtual
machines using VMware or Hyper-V virtualization technologies. Please refer to page 9 for minimum
requirements and recommendations.

Example 5: Global Edition


Global Edition consists of a "head office" and one or more "regions". The installation type is
determined by the license serial number used during the installation of Symmetry.
The architecture of the head office and each region is the same as for Enterprise Edition, with the
exception that Global Edition does not support separate database servers. In all other respects, the
hardware and software minimum requirements at a head office or region are the same as for an
Enterprise Edition system.
Figure 4 shows one possible architecture, in which the head office includes Symmetry nodes (e.g. for
local access control). Depending on requirements, it is feasible for the head office to be used only for
centralized card administration and alarm handling.
The regions upload locally-defined access codes, alarms and events to the head office. The head office
downloads card holders and their access rights (using the access codes uploaded from the regions).
Secure https communications are used in both cases.
For further information about Global Edition, including details of how to configure it, please refer to
the Symmetry Global Edition Installation and User Guide.

5
Chapter 1: Introduction

Head Office

Symmetry Server

Network

Clients Nodes

WAN

Region 1 Region 2

Symmetry Server Symmetry Server

Network Network

Clients Nodes Clients Nodes

Figure 4: Example Global Edition Architecture

Installation Sequence
Typically, the steps you need to take to install the software are as follows:
1. Check hardware and software requirements. Refer to the following sections.
2. Perform the pre-installation tasks. See:
Chapter 2: Pre-Installation Tasks
3. Install and start Symmetry. See:
Chapter 3: Quick Install Instructions (Single-Machine Installation), or
Chapter 4: Installing Symmetry
4. Perform various post-installation tasks, such as to set power options and configure modems. See:
Chapter 5: Post-Installation Tasks.

6
Chapter 1: Introduction

Hardware and Software Recommended Requirements


This section specifies recommended hardware and software requirements for a new installation of
Symmetry. Note:
 These recommendations are based on experience with many different installations. However, it
is essential to fully plan and test the performance of the system before going "live". Please
refer to Appendix F for important information to consider before installing Symmetry or
deciding the hardware/architecture to use.
 If you are upgrading Symmetry, there is no need to upgrade your hardware if you are
satisfied with the current performance and there are no changes to the number of card holders,
clients or readers, or to the version of Windows or SQL Server used.
 Machine specifications may need to be enhanced, depending on site requirements.
 The Symmetry client software is also installed on the symmetry server (except on a cluster).
However, to ensure resource availability for task-intensive operations, it is recommended that
the Symmetry server is normally dedicated for Symmetry use, depending on the number of
readers and transactions.
 Hardware specifications are for non-virtualized systems; see page 9 for virtualization.
 Disk compression must not be used.

Symmetry Business/Professional Server, Client (any Edition) or NVR


The following applies for any non-virtual machine that is being used as a Symmetry
Business\Professional Edition server, Symmetry client (in any edition) or Symmetry NVR. Note: Also
refer to Maintaining Symmetry NVR or Video Performance (page 11) if the computer is being used as a
Symmetry NVR or to view video.
Item Recommended Requirement
Operating System 64-bit Windows 8.1 or 10, Pro or Enterprise Edition.
Note: Also supported are the Windows Server operating systems supported for
Enterprise Edition (see the next section). If a Windows Server operating system is
used, it is recommended to use the same machine hardware as for an Enterprise server.
Processor Minimum Intel i5-3570 @3.4GHz (or equivalent).
Memory Minimum 8GB RAM (or 16GB for a Symmetry Enterprise client that is used to
manage communications for more than one LAN chain).
Optical Drive The Symmetry software is supplied on a single-layer DVD.
Monitor Resolution 1280 x 1024 minimum. 1920 x 1080 maximum.
LAN Speed Minimum 100Mbit/s; 1000Mbit/s recommended, especially for video.
Database software Microsoft SQL Server 2014, 2016, 2017 and 2019 Express (with the latest released
service pack).
The database software needs to be installed on the Symmetry server only.
Note: SQL Server 2017 Express can be installed during the installation of Symmetry.
Another version of SQL Server Express is used if pre-installed.
Disk At least 450GB of free disk space is recommended for the Symmetry server. This
provides significant contingency for database growth and backup operation. When
purchasing a new computer, specify a disk size of at least 500GB.
The disk space consumed by a Symmetry client or NVR is typically less than 1GB.
For mechanical hard-disk drives, a speed of 7200RPM or greater is recommended for
optimal performance.
Symmetry NVRs should have an additional disk drive or network storage for recorded
video.
Optional Items See page 12.

7
Chapter 1: Introduction

Symmetry Enterprise Server


Note: Also refer to Maintaining Symmetry NVR or Video Performance (page 11) if the computer is
also being used as a Symmetry NVR or to view video.
Note: The specification listed here is for installations that have no more than 6000 readers. For larger
installations, a customized hardware specification will be necessary to ensure optimal performance
based on the individual installation requirements. In this case, contact the AMAG Application
Engineering team to assist in configuring a suitable server specification.
Item Recommended Requirement
Operating System 64-bit Windows Server 2012 R2, 2016 or 2019 (Standard or Datacenter Edition).
Processor Minimum Intel Xeon E3-1270v2 4C/4T @3.5GHz 8M cache (or equivalent).
Memory Minimum 32GB RAM.
Optical Drive The Symmetry software is supplied on a single-layer DVD.
Monitor Resolution 1280 x 1024 minimum. 1920 x 1080 maximum.
LAN Speed Minimum 100Mbit/s; 1000Mbit/s recommended, especially for video.
Database software A "full" version of Microsoft SQL Server must be installed on the Symmetry server or
on a separate database server before the Symmetry software is installed.
The following versions of Microsoft SQL Server are supported:
 SQL Server 2014 (32-bit or 64-bit) Standard and Enterprise Editions (with the
latest released service pack).
 SQL Server 2016, 2017 and 2019 (64-bit) Standard and Enterprise Editions (with
the latest released service pack).
Note: SQL Server must be purchased separately. Please check the Microsoft web site
for compatibility with the chosen operating system.
Disk At least 950GB of free disk space is recommended for the Symmetry server. This
provides significant contingency for database growth and backup operation. When
purchasing a new computer, specify a disk size of at least 1TB.
For mechanical hard-disk drives, a speed of 10000RPM or greater is recommended for
optimal performance.
The size of the SQL database will vary depending on the number of transactions and
the length of data retention. As an example, a dedicated 1TB drive is typically adequate
to support a system with an average of 1000 transactions per minute and two years of
data retention.
Symmetry NVR should have additional disk drive or network storage for recorded
video.
Optional Items See page 12.

Separate Database Server (Enterprise Edition only)


If a separate database server is used, Symmetry supports the same Microsoft SQL Server editions as
supported for an Enterprise server.
The operating system used can be any Windows operating system supported by the edition of
Microsoft SQL Server selected.
The machine hardware requirements are dependent on the number and type of database applications
being served by the database server, but should not be less than specified for a Symmetry Enterprise
server.

8
Chapter 1: Introduction

Virtualization Minimum Hardware Requirements


This section specifies minimum hardware specifications for virtualized systems. The operating
systems, SQL versions, and optional hardware/software supported are the same as for a non-virtualized
system.

Virtualization Technologies
Symmetry supports the following virtualization technologies:
 VMware ESXi 6.7 (type 1 hypervisor).
 Microsoft Hyper-V (type 1 or type 2 hypervisor).
A hypervisor is an application that creates and runs Virtual Machines (VMs) on a host machine. A
Type 1 hypervisor runs directly on the host "bare metal" hardware. A Type 2 hypervisor is installed on
an existing operating system.

Host Machine Minimum Requirements


A host machine is a server dedicated to storing and running VMs. The following are the minimum
requirements of a host server that runs a maximum of one Symmetry server VM and one Symmetry
client VM:
 CPU and RAM: The specification of CPU and RAM will vary depending on the number of virtual
machines being used and the virtual hardware reservations they have. Seek guidance from the
virtualization provider, and ensure they certify that the host hardware is fit for purpose.*
 At least two Gigabit network adapters (10 Gigabit recommended).
 Drive for operating system – can be local HD / RAID or in some cases an SD card (check with the
hypervisor manufacturer).
 Datastore storage* – please check the virtualization provider's recommendations. A datastore is a
dedicated storage area to host VM files and folders and can be configured on a local disk, or on a
server/network-attached storage array. It is recommended that the datastore(s) are on a completely
separate drive from the operating system.
 Ensure the following are supported by the CPU, and enabled in the BIOS:
‒ Virtualization extensions (VT)
‒ Hyperthreading
‒ Data Execution Prevention (DEP)
‒ Second Level Address Translation (SLAT)
‒ Never Execute or Execute Disable (NX/XD)
*Note: Running VMs incurs CPU and memory overheads on the host machine, which can significantly
vary depending on the number of VMs, their usage and configuration. When deploying Symmetry in a
virtualized environment, it is essential that the performance of the Symmetry system is fully proven
before the system goes "live".

Host Configuration Recommendations


Both VMWare and Microsoft Virtualization solutions can (depending on licenses and configuration)
include options for configuring one or more pools of resources at the host, and this can be used to
reserve a dedicated amount of CPU and RAM for one or more VMs. It is recommended to use this
facility (if available) to configure a resource pool for Symmetry, since Symmetry can be a resource-
intensive program (particularly if SQL is present on the same host and for larger systems). Configuring
the system in this way will help to protect the Symmetry server and leave resources available for the
host to run adequately.

9
Chapter 1: Introduction

The VMWare application used to install and manage VMs is the "vSphere Client". Microsoft uses the
Hyper-V Manager Windows application. Networking in both vSphere client and Hyper-V uses a
"virtual switch". Make sure that this is configured with sufficient ports to support the number of VMs
and physical network interface cards being used on the host machine.
The state of a Virtual Machine can be temporarily saved. In the VMWare vSphere Client, this is called
a "snapshot". In the Microsoft Hyper-V Manager, it is called a "checkpoint". The use of snapshots or
checkpoints can have a negative performance impact on VMs, so it is strongly recommended to
remove them when they are not required.

Symmetry Server (Professional or Enterprise) VM Minimum Configuration


 One virtual CPU with 4 cores.
 The minimum RAM and disk requirements are the same as for a hardware (non-virtualized)
Symmetry server. Please refer to page 7 or 8 as applicable.
 Minimum of 100GB data storage for Symmetry and Microsoft SQL Server (if SQL is local to
Symmetry), or 50GB if the Symmetry server is using a remote SQL instance. Additional storage
requirements must be assessed on an individual basis, taking into account the frequency of
transactions and number card holders in the Symmetry system.
Note: It is recommended that the number of configured virtual CPU cores for a Symmetry server VM
is consistent with projected usage. Having a large number of unutilized cores can adversely affect the
performance of a VM.

Symmetry Client VM Minimum Configuration


 One virtual CPU with 2 cores.
 The minimum RAM and disk requirements are the same as for a hardware (non-virtualized)
Symmetry client. Please refer to page 7.
For Symmetry clients that will be used for video monitoring and playback, enable "3D Video
Acceleration" (where available) and allocate a minimum of 32MB of video memory.

Symmetry Network Video Recorder (NVR) VM Minimum Configuration


 One virtual CPU with 2 cores.
 The minimum RAM and disk requirements are the same as for a hardware (non-virtualized)
Symmetry NVR. Please refer to page 7.
If multiple virtualized NVRs are required, it is recommended that a separate host machine is dedicated
for their use due to the potential high bandwidth requirement of multiple cameras streaming to the
NVRs. Including NVRs on the same host machine as the Symmetry database, server or clients may
have a significant impact on system performance.
Note: Also refer to the next section (Maintaining Symmetry NVR or Video Performance).

10
Chapter 1: Introduction

Maintaining Symmetry NVR or Video Performance


The specified NVR machine specifications are the minimum requirements for a Symmetry NVR.
However, the Symmetry Enterprise Server specification is highly recommended, since this allows for
easy future expansion and provides greater performance and hardware resilience for installations that
have extensive video requirements.

Symmetry NVR Operation


To maintain performance at a computer that uses the minimum specifications:
a) The combined simultaneous recording bit rate of an NVR should not exceed 85Mbits/s, and the
combined simultaneous playback bit rate should not exceed 97Mbits/s (182Mbits/s total).
For example, 10 cameras, each being recorded simultaneously at 8.5Mbits/s, and at the same time,
10 recordings, each being played back simultaneously at 9.7Mbits/s.
b) A more powerful hardware platform may be required if the NVR is installed on the Symmetry
server or on a client, depending on system usage.
Each NVR supports a maximum of 80 cameras (with a maximum combined simultaneous recording bit
rate of 85Mbits/s as described above).
Each NVR supports a maximum of 28 concurrent playback streams. Since each Symmetry client can
display up to 4 video recordings in the Video Playback screen, each NVR can serve up to 7 Symmetry
clients concurrently.

Live Video Display or Playback


To maintain performance at a computer that uses the minimum specifications:
a) The total maximum bit rate for combined live and playback streams at each Symmetry client
should not exceed 40Mbits/s.
b) A more powerful hardware platform may be required if live or recorded video is to be displayed at
a Symmetry server or NVR, depending on system usage.

Network Requirements for NVR Operation


Networks that suffer from high levels of latency, packet loss or other conditions can result in video
loss or corruption. It is therefore important to use only high-quality network components and to test
performance thoroughly before the system goes "live".
The NVR and all cameras should be time-synchronized to the same network time server to ensure
accurate recording times and clip search results. All cameras assigned to an NVR should be in the
same time zone as the NVR. In cases where the installation requires more than one time zone, a
separate NVR should be used for each time zone.
Ports need to be opened in firewalls to enable the NVR to record video. Ports may also need to be
opened for cameras to stream video or send events. For further information, please refer to Appendix
D or the camera manufacturer's documentation.
Local disk drives or UNC paths can be used for video repositories. It is recommended that UNC rather
than mapped drives are used. The data transfer rate of each disk drive must be able to manage the
potential amount of data being simultaneously written and read. (Typically, a 7200 RPM HDD has an
average data transfer rate of 100 Mbytes per second, which should comfortably manage all but extreme
situations).

Disk Type
Solid-state drives are recommended, particularly when continuous recording of video is required.
Select drive models that have proven performance and reliability.
For a Symmetry clustered solution, hard drive storage in RAID 5 (or 6) configuration is recommended.

11
Chapter 1: Introduction

Optional Hardware/Software
This section specifies optional hardware and software supported by Symmetry.
Note: Before installing Symmetry, please ensure that any required third-party drivers (or applications)
are compatible with the version of Windows you intend to use. This is particularly important for 64-bit
operating systems, which require drivers written specifically for those operating systems.
Further guidance for third-party integrations supported by Symmetry can be obtained from your local
technical support representative.

Email Integration
If emails are to be used for alarm reporting, workflow events, visitor arrivals or reports, a connection
to an SMTP mail server is required. Fully test operation before completing system deployment.

COM Ports
A card providing two additional ports (COM3 and COM4) may be required, depending on the number
and type of chains and other peripherals connected to the client. If such a card is used, COM3 and
COM4 must use unique interrupts and must be high-speed asynchronous ports that use the 16550AN
UART.

Printer
Any Windows-compatible printer can be used, including network printers.

Card Encoders
Symmetry supports legacy HID OMNIKEY 5421 encoders, and the newer HID OMNIKEY 5023CL
encoders. The 5023CL provides support for MIFARE Plus cards and the Classic MIFARE cards
supporting 7-bit UID.
Card encoding is also available using optional Suprema™ BioLite N2 fingerprint readers, as
documented in the Third-Party Access Devices User and Configuration Guide. This supports a range
of formats, including Symmetry 32-bit, 63-bit and 64-bit formats using MIFARE or MIFARE
DESFire.

Signature Pad
Topaz Signature GEM pad model T-S261-HSB-R (USB connection signature pad).
Note: You need to set up an ini file for a Topaz USB signature pad. Please refer to the online help for
the "Install/System/Client Ports" screen.

Badge Printers
Appendix C provides advice on how to configure badge printers for use with Symmetry.

Automatic Updates
Please be aware that in general, automatic updates to the Windows operating system or other software
result in no loss in performance or operation of Symmetry. However, to ensure complete compatibility,
please ensure that either only those versions of the software documented in this chapter are used, or
contact your local technical support representative to confirm whether newer versions have already
been approved for use.
Make sure that Windows updates are complete before installing Symmetry, and that the machine has
been restarted after the last update. Windows updates must not be installing in the background while
Symmetry is installing.

12
2. Chapter 2: Pre-Installation Tasks (for
Business or Professional
Edition)

This chapter describes the tasks that must be carried out before installing Symmetry Business or
Professional Edition. If you are installing Symmetry Enterprise or Global Edition, please refer to the
Symmetry Security Hardening Guide for details of the pre-installation tasks.

Step 1 – Obtain Static IP Addresses


You need to obtain static IP addresses for:
 The Symmetry server, if IP (network) cameras or Symmetry NVRs are used. If the static IP
address of the Symmetry server is changed after installation, the address must be updated in
the HTTP option of the "Maintenance/User & Preferences/System Preferences" screen
(Digital Video tab).
 Any Symmetry machine that communicates with a LAN chain, where the connection type for
any node on the chain node is configured as "Periodic" or "Continuous - connection
established by Controller".
Note: Computer names should not use the underscore character, as some applications may not operate
correctly if any part of the name contains an underscore character.

Step 2 – Obtain Permissions to Install Symmetry


To install Symmetry, you will require local administrator permissions to the Symmetry server and to
any separate Symmetry client PCs.
Ensure that database administrator permissions are available to your account. This can be achieved by
using SQL Server Management Studio and granting your account sysadmin privileges.
If a domain is used and the Active Directory account you are given does not have domain
administrator permissions, you will need to ask the domain administrator to carry out steps 3, 4 and 5
for you.

Step 3 – Create ACS Groups (domain only)


If Symmetry is being installed on a domain, "ACSUsers", "ACSServices" and "ACSReporting" groups
need to be created in the Active Directory prior to installing Symmetry. Different group names may be
used, if preferred.
If you are installing in a workgroup, the groups can be created automatically.
Please refer to page 66 for details of the required group privileges.

13
Chapter 2: Pre-Installation Tasks (for Business or Professional Edition)

Step 4 – Choose the Symmetry Services Account


During the installation of Symmetry on the server and on each client, you are prompted for the name of
an account that will run the Symmetry services on that machine. You are given the option to use:
 The built-in Local System account (Symmetry server only). You should use this only if you are
installing Symmetry on a single computer, since named accounts are preferred for a client/server
solution. The Local System account must not be used if you are using any of the following:
 Printers for use with scheduled or muster reports.
 The "Operation/Data/Backup" screen, when the backup is sent to a different computer (a
named account is needed to access the backup destination specified in the Backup screen).
 A named account.
If you are installing in a workgroup, you can create the account now or when you are installing
Symmetry. If you are installing in a domain, a domain administrator should create an account in
the Active Directory before you start to install Symmetry.
The account used at Symmetry clients must be the same as used at the Symmetry server. The
password and account must be set not to expire.

Permissions for a Named Services Account


If you are installing in a workgroup, the services account is automatically assigned to the local
Administrators and ACSServices groups.
If you are installing in a domain, a domain administrator must assign the services account to
ACSServices before installation. The services account is automatically assigned to the local
Administrators group.

Step 5 – Assign Users to ACSUsers


All users who need to use Symmetry must be assigned to the ACSUsers group. This can be carried out
before or after installation. If you are using a domain, a domain administrator will need to do this.

Step 6 – Install SQL Server


Symmetry Business and Professional Editions must use only the Express version of SQL Server. SQL
Server 2017 Express is installed by default during the installation of Symmetry. If you want to use
SQL Server 2014 or 2016 Express, make sure that it is installed on the Symmetry server before
installing Symmetry.
If you are installing SQL Server Express as part of the Symmetry installation, a default instance of
SQL Server Express is installed. If you want to pre-install SQL Server Express, a default or named
instance can be used. If the machine has one or more named instances, you are prompted to choose the
instance to use during Symmetry installation.
Note: Make sure any unsupported version of SQL Server Express is removed or upgraded before you
start to install Symmetry.
Note: If SQL Server Express is pre-installed, it is recommended that SQL Server Express is
configured to use windows authentication (before Symmetry is installed).
Note: SQL Server Management Tools are not automatically installed during the installation of
Symmetry. You can install the tools by starting SSMS-Setup-ENU.exe located in the
Setup\Packages\SSMS folder on the Symmetry installation media.

14
Chapter 2: Pre-Installation Tasks (for Business or Professional Edition)

Step 7 – Configure SQL Server


Note: You do not need to follow this step if you are installing SQL Server Express as part of the
Symmetry installation.

Step 7a – Enable the TCP/IP Protocol


Enable the TCP/IP protocol for the SQL Server instance using SQL Server Configuration Manager
(unless the site has other requirements).

Step 7b – Configure the Firewall for SQL Server


Symmetry uses standard SQL Server firewall configuration settings. There are several ways to
configure the firewall, depending on site security requirements and whether a named or default
instance of SQL Server is being used. If a default instance is being used, it is normal to open TCP port
1433 in the firewall. If a named instance is used, one approach is to add both of the following to the
firewall exceptions:
 sqlservr.exe (e.g. in Program Files\Microsoft SQL Server\MSSQL11.<InstanceName>\MSSQL\Binn)
Note: Each instance of SQL server has a separate sqlservr.exe.
 UDP port 1434 (for SQL Browser)
For detailed information about firewall configuration, please refer to the Microsoft web site. At the
time of writing this manual, appropriate information was available in the web page titled "Configure
the Windows Firewall to Allow SQL Server Access", available at:
http://technet.microsoft.com/en-us/library/cc646023.aspx

Step 7c – Configure the SQL Server Browser Service


If you are using a named instance of SQL Server with dynamic port assignment (the default), you need
to make sure that the SQL Server Browser service is configured to start automatically. You can do this
using the SQL Server Configuration Manager. In all other cases, leave the service disabled.

Step 8 – Check Windows Time Service Configuration


The Windows Time Service is installed by Windows. Its purpose is to allow synchronization of date
and time of computers running on a Windows network. It is a fully-compliant implementation of the
Simple Network Time Protocol (SNTP).
It is recommended that an SNTP server is used to synchronize the time at all Symmetry servers
and clients. Care should be taken to ensure that the frequency of the time changes will not disrupt
system performance.
The Windows Time Service (W32time) starts automatically on computers that are joined as part of a
domain. For computers belonging to a peer-to-peer workgroup, the Windows Time Service
synchronization settings must be manually set up in the computer's registry.
If you do not have sufficient privileges to check Time Service configuration, please refer to an
appropriate system administrator.

Step 9 – Check Printer Configuration


If Symmetry scheduled, onsite beyond limit, or muster reports are to be used at the site, any printer
used for these reports must be available to the account you have created for the Symmetry services,
and for any user who needs to set up such reports.
If more than one printer is used, each must be installed in the same order in both accounts.

15
Chapter 2: Pre-Installation Tasks (for Business or Professional Edition)

Step 10 – Obtain Symmetry Licenses


Make sure that you have a license serial number for each product you are going to install. You need a
serial number for the Symmetry server, the clients and each optional feature (such as additional readers
or the intrusion management module).
Note that you cannot use a cluster-aware license to install a non-clustered Symmetry server.

Step 11 – Disable Database Optimization Software (if used)


It is recommended that database optimization applications either exclude the Symmetry database or be
completely disabled.
Database optimization software may change the structure of the Symmetry database. If carried out on a
live system, this can cause Symmetry to fail and require a restart of the server and all clients. In
addition, when the database optimization is taking place, it acquires write access to the database and
the associated tables, which may prevent Symmetry from writing to the database.

Step 12 – Set Power Options


On the Symmetry server, switch off sleep or hibernate mode in the Power Options of the Windows
Control Panel. For example:

Select Never for Put the computer to sleep.


Also click Change the advanced power
settings and choose for the hard disk never
to switch off.

Note: Failure to set the power options may result in the following error message:

(Note: "database server" means the Symmetry server.)

Step 13 – Configure Firewalls


Ports will need to be opened in firewalls to enable Symmetry to communicate, depending on the
software used and system configuration. Appendix D provides further information.

16
3. Chapter 3: Quick Install Instructions
(Single-Machine Installation)

Introduction
If you are going to install Symmetry on a single machine using SQL Server Express, installation is
extremely straightforward and normally requires selection of the default settings. This chapter explains
the normal installation process, which covers most cases.
Chapter 4 provides full details of the installation prompts.

Installation
To install the Symmetry software on a single machine
1. Log in with Administrator privileges at the Symmetry server.
2. Insert the Symmetry installation media and wait for the installation wizard to start. If it does not
start, double-click Setup.exe, which is located in the top-level folder of the media.
3. Select the SQL Express and Symmetry checkboxes.
4. Follow the prompts, selecting the defaults in all cases where provided.

Starting Symmetry
1. Start Symmetry from the Start/Programs/Symmetry menu or from the desktop icon:

2. When prompted, log into Symmetry. The default username and password for the installer are
"installer" and "install" respectively.

17
4. Chapter 4: Installing Symmetry

Introduction
This chapter gives full details of how to install the Symmetry server and client software. Quick Install
Instructions are given in Chapter 3.
Note: Before you start, follow the pre-install instructions given in Chapter 2 (for Business or
Professional Edition), or in the Symmetry Security Hardening Guide (for Enterprise Edition).

Overview of Installing Symmetry


1. Install the main Symmetry server and client software on the server (see the next section).
2. If required, install the relevant Language Pack on the Symmetry server (page 24).
3. If required, install the Symmetry client software on any additional client PCs (page 25). The client
software is installed by default on the Symmetry server (except on a cluster).
Note: Make sure that Windows updates are complete before installing Symmetry, and that the machine
has been restarted after the last update. Windows updates must not be installing in the background
while Symmetry is installing.

Installing the Symmetry Server Software


To install Symmetry on the server:
1. Log in with administrator privileges at the Symmetry server.
2. Insert the Symmetry installation media and wait for the installation wizard to start. If it does not
start, double-click Setup.exe, which is located in the top-level folder of the media.
3. Click Next at the Welcome screen.
4. Choose the items to install: Select Microsoft SQL Express
only if you are installing
Business or Professional Edition
and SQL Server Express is not
already installed.

Select Symmetry.

18
Chapter 4: Installing Symmetry

5. Ready to install – Click Install to install the selected items:

If applicable, wait for the installation of Microsoft SQL Server Express to complete.
6. Click Next at the Welcome screen.
7. End-User License Agreement – Read the Terms of Service. Select I accept... and click Next if
you agree.
8. Licensing Information – Enter the serial number of the new version of Symmetry given to you:

(The serial number may be entered automatically if a Symmetry database is already on this
computer.)
9. Client Access Point (Microsoft Cluster only): The following is displayed if you are installing on
the active node of a Microsoft cluster:

Enter the network name configured in the Message Queuing resource. Please refer to the Cluster
Installation Manual for further details.

19
Chapter 4: Installing Symmetry

10. Specify a SQL Server – Select the SQL server:

Enter the name of the SQL Server instance you want to use, or click Browse to select it.
Note:
 For Enterprise Edition, you can choose the Symmetry server, or an instance on a separate
database server.
 If login fails, make sure that TCP/IP is enabled (see page 15).
 If you are using a fixed port for a named database instance, it is necessary to include the port
number in the format:
<SQLServerName>\<InstanceName>,<PortNumber>
For example, MySQLServer\SymmInstance,6532

Connect using specifies the authentication method used to connect to the database server while
Symmetry is being installed. It is recommended to use Windows Authentication. Note:
 The authentication method is used only during the installation of Symmetry to set up the
database; Symmetry always uses Windows authentication after installation.
 To use SQL Server Authentication, the SQL server instance must have "mixed mode"
authentication enabled (not recommended), and you will need the login ID and password for
the administrator account defined within the SQL Server instance.

11. Symmetry Backup Path (Enterprise only) – The following is displayed if you are using a separate
database server. Select the share to the SQL backup folder (set up as described in the Symmetry
Security Hardening Guide). The folder is used as a temporary store of backups before they are sent
to the network location specified in the "Operation/Data/Backup" screen.

20
Chapter 4: Installing Symmetry

12. Installation Type – Choose Typical or Custom:

If you choose Custom, you will have complete control over system configuration. Choosing
Typical will cause defaults to be used for some settings. You should choose Custom if you intend
to use data import/export using a text file.
13. Symmetry Account Groups – Choose the Windows groups to use for Symmetry:

Configuration of the above is dependent on whether you are using a workgroup or Active
Directory domain:
 Workgroup – Make sure that Group location is set to the name of the Symmetry server.
You can use the default group names displayed, or type new group names into the fields.
The groups will be created locally for you.
 Active Directory domain – Select the domain from the Group location menu, and then
enter the group names (as previously created during the pre-installation tasks). Make sure
that the spelling is exactly correct.
An alternative if you do not want to use domain-level groups is to set Group location to the
name of the Symmetry server. In this case, the specified group names will be created for
you. You will need to run the Symmetry services in a named account (as described next).
14. Symmetry Service Account – Specify the account in which to run the Symmetry services:

Local System Authentication is available only if the Symmetry database is going to be on the
Symmetry server (i.e. you are not using a separate database server). You should normally
select this option only if you are installing Symmetry on a single computer, since named

21
Chapter 4: Installing Symmetry

accounts are preferred for a client/server solution. Local System Authentication must not be
used if you plan to use any of the following:
 Printers for use with scheduled or muster reports.
 The "Operation/Data/Backup" screen, when the backup is sent to a different computer (a
named account is needed to access the backup destination specified in the Backup screen).
Use Named Account allows you to use named account to run the services.
If the Symmetry groups have been created at the domain level, specify the domain account
previously created during the pre-installation tasks. Symmetry will automatically assign the
account to the local Administrator group. You should have already assigned it to the
ACSServices group during the pre-installation tasks.
If the Symmetry groups have been created on the Symmetry server, specify a local account. If
the account does not already exist, you are prompted to confirm creation of the account
(providing the username and password meet Windows policy; "Invalid account details have
been specified" is displayed if, for example, the password does not meet policy). The account
will be automatically assigned to the ACSServices and local Administrator groups.
15. Installation Folder (Custom only) – Select the folder in which to install Symmetry on the server:

16. Customer Code (Custom only) – If you have been supplied with a facility/customer code to be
encoded on your company's cards, enter it now. If you have not been supplied with a customer
code, use the default of 999999.

17. Optional Features (Custom only) – Select optional features:

Remove access to Windows Desktop – This option is relevant only to Symmetry client
installations (page 27).
Add Default Card Block – This option is relevant only if the access cards to be used do not have
an encoded customer code. In these cases, the "Setup/Identity/Card Blocks" screen must be
used to define the ranges of cards being used. Selecting this option causes the
"Setup/Identity/Card Blocks" screen to include default card block definitions (although you
may want to review these during system configuration).
Create Common Hour Definitions – If this is selected, the "Operation/Times/Hours" screen will
include default Hours definitions. These can help access rights to be set up more quickly
during system configuration.

22
Chapter 4: Installing Symmetry

18. Data Connect (Custom only) – You can choose to use an SQL Server database or text files for
exports or imports of card data from/to Symmetry:

Note: If you are using Business or Professional


Edition, you will need to install a Data Connect
license to use Data Export/Import.

Card data can be imported into Symmetry using the "Operation/Data/Data Import" screen.
Card data can be exported using the "Operation/Data/Data Export" screen. You may want to do
this to transfer of card details from one system to another (Symmetry must be the same version on
both systems).
19. Shared Folder (Custom and Microsoft Cluster only) – The following is displayed only if you are
installing on the active node of a cluster (see the Cluster Installation Manual) and have selected
Export to a Text File or Import from Text File:

The specified folder is used as the root to store import and export files. For Microsoft clustering,
the folder must be on the shared storage device, not on the quorum.
20. Symmetry Device Integrations – Specify the devices that you wish to use with Symmetry:

Note: Make sure you


select Identity
Verification if the
"Home/Identity/
Verification" screen is
going to be used.

If a device is not selected, you can enable it later by re-running the Symmetry installer and
selecting the Change option.

23
Chapter 4: Installing Symmetry

21. Registration Information – Enter your details:

22. Ready to Install – Click Install and follow the prompts.


23. When prompted, register the software:
You need to obtain an activation code to activate
Symmetry. You can obtain the activation code in
one of the following ways:
 Automatically over the internet by clicking
Register Online. Note: A license can be
activated online up to three times before
needing to be reset by Customer Support.
 By clicking the link. You will be prompted to
log in and register your details. The login
username and password are provided on the
Software License Certificate. You will need
the Serial Number and Registration Key
displayed near the top of the dialog.
 By phone using one of the numbers displayed.
If you click Register Later, you have up to 21 days
to enter the activation code in the "Maintenance/
Licensing/System Licenses" screen.
When you have the activation code, write it down
in the space provided on the Software License
Certificate.

Installing a Language Pack


If you require Symmetry to use a language other than English (e.g. for the option names displayed in
menus, text in screens, help, etc.), you must install the appropriate Language Pack on the server
following installation of the server. It is allowable to install the Language Pack after the system has
been in use.
Please contact your AMAG support representative for a list of available language packs. Installation
instructions are provided with each language pack.
You can install more than one Language Pack, and choose which one to use as the default in the
"Maintenance/User & Preferences/System Preferences" screen of the Symmetry software.
Although there is a default language, the "Maintenance/User & Preferences/Accounts" screen allows
each user to use any one of the installed languages.
Install Language Packs only on the server - clients are updated automatically.

24
Chapter 4: Installing Symmetry

Installing Symmetry Client Software


Follow this section if you want to install only the Symmetry client software. Note the following:
 The Symmetry server must have been installed already.
 The client software is installed by default on the server, except on cluster installations.

Note: Before you start, follow the pre-install instructions given in Chapter 2 (for Business or
Professional Edition), or in the Symmetry Security Hardening Guide (for Enterprise Edition).
To install the Symmetry client software:
1. Log in with administrator privileges at the Symmetry client.
2. Insert the Symmetry installation media and wait for the installation wizard to start. If it does not
start, double-click Setup.exe, which is located in the top-level folder of the media.
3. Click Next at the Welcome screen.
4. The install options are displayed:

Do not choose to install SQL


Server Express for a client
installation.

Select Symmetry.

5. Ready to install – Click Install.


6. Click Next at the Welcome screen.
7. End-User License Agreement – Read the Terms of Service. Select I accept... and click Next if
you agree.
8. Licensing Information – Enter the serial number of the new version of Symmetry given to you:

9. Specify a SQL Server – Enter the SQL Server details:

Enter the name of the SQL Server


instance (the SQL server machine
name if the default instance is
used). Alternatively, if the SQL
Server Browser service is started
on the SQL server machine, you
can click Browse and choose the
instance.

This specifies the authentication method used by the


client to connect to the database server. Use the same
method as selected at the Symmetry server.

25
Chapter 4: Installing Symmetry

10. Installation Type – Choose Typical or Custom:

If you choose Custom, you will have complete control over system configuration. Choosing
Typical will cause defaults to be used for some settings.
11. Symmetry Account Groups – Choose the Windows groups to use for Symmetry:

Use the same settings as used at the Symmetry server (page 21), except that if you are using a
workgroup, Group location must be the name of the client you are currently using. It is essential
that you use the same group names that you used at the Symmetry server.
12. Symmetry Service Account – Specify the account in which to run the Symmetry services:

Use the same settings as used at the Symmetry server (page 21), except that if you are using a
workgroup, Account location must be the name of the client you are currently using. It is
essential that you use the same account that you used at the Symmetry server.
13. Installation Folder (Custom only) – Select the folder in which to install Symmetry on the client:

26
Chapter 4: Installing Symmetry

14. Optional Features (Custom only) – If required, select the following option:

Remove access to Windows Desktop – If this is selected, no Windows desktop will appear and
the Symmetry software will start automatically when any user logs in to Windows.
Note: To prevent a user from accessing the Windows desktop, also deselect Enable Logon
Cancel Button in the "Maintenance/User & Preferences/Client Preferences" screen.
Note: If this setting is selected, administrators can access the Windows desktop for
maintenance purposes by starting Windows in safe mode. If required, the setting can then be
changed by re-running the Symmetry installer (see page 41).
15. Ready to Install – Click Install and follow the prompts.

27
Chapter 4: Installing Symmetry

Installing a Symmetry NVR


This section explains how to install the Symmetry NVR software.
Note: Each Symmetry installation allows a single Symmetry NVR to be defined without a separate
license number having to be added to the "Maintenance/Licensing/System Licenses" screen. You will
need to add a license if you want to use more than one Symmetry NVR.
To install the NVR software:
1. Ensure that you are logged into the machine with administrator privileges.
2. Open the "Symmetry NVR" folder on the installation media, and double-click "Symmetry NVR
Setup.exe".
3. Click Next in the Welcome screen. The installation options are displayed:

4. Choose Symmetry Network Video Recorder. You may also want to select:
Symmetry Onvif Plugin – Select this if you are using cameras that use the Open Network
Interface Forum (ONVIF) interface.
Symmetry HD Plugin – Select this if you are using Symmetry HD cameras.
The above plugins are installed by default on the Symmetry server and on Symmetry clients.
5. Welcome – Click Next at the Welcome screen.
6. End-User License Agreement – Read the Terms of Service. Select I accept... and click Next if
you agree.
7. Destination Folder – Choose the folder in which to install the Symmetry NVR program files:

8. Installation Type – Keep the default selection of Standard if you are not installing in a cluster.
Otherwise, choose one of the Clustered options, as appropriate.

Please refer to the Cluster Installation Manual for further details of


installing Symmetry in a cluster.

28
Chapter 4: Installing Symmetry

9. Configuration Folder Location – When installing on a non-clustered machine, or on the active


node of a cluster, choose the folder in which to store video index files:

Note: This folder will need to be backed up regularly (see page 33).
When installing on the passive node of a cluster, specify the IP address or DNS name of the active
node, enter the credentials of a user configured in the NVR web interface, then click Query active
node:

Port must be the same as


the Web Interface Port,
as specified when the
NVR software was
installed at the active
node (see below).
Clicking Query active
node tests the connection
to the active node. If
successful, a valid file
location is displayed at
the top of the dialog, and
Next is ungrayed.

10. Repository Options – Choose a "repository" (a location in which to store video recordings), and
the amount of disk space to allocate for that repository:

Maximum quota shows


the amount of free disk
space.
You can set up
additional repositories
using the NVR web
interface after
installation.

Note: This folder will also need to be backed up regularly. Please refer to page 33 for further
details.
It is recommended that UNC paths rather than mapped drives are used.
11. Web Interface Port – Specify the http port on the NVR that you want the Symmetry server to use
to communicate with the NVR:
If you change the default, you will need to make sure you enter
the same number in the "Install/Video & Audio/Digital Video-
NVR" screen in the Symmetry software.

29
Chapter 4: Installing Symmetry

12. Service Credentials – Specify an account in which to run the Symmetry services on the NVR:
Specify a named account if a
repository is to be on a device
elsewhere on the network. In this
case, the repository will need to set
up a share. The share will require
permissions that allow the account
specified here to create files and
folders in that share.
A domain account can be used, if
appropriate.
13. Click Install and follow the prompts.

30
Chapter 4: Installing Symmetry

Starting Symmetry
To start Symmetry:
1. Log into Windows. Use the account that you specified during the client software installation.
2. Start Symmetry using the Start/Programs/Symmetry menu or the desktop icon:

4. Log in using one of the user names described next.


5. If prompted, enter the activation code or choose to activate your license via the internet. If you
click Register Later, you have up to 21 days to enter the activation code in the
"Maintenance/Licensing/System Licenses" screen. Please refer to page 24 for details of how to
obtain the activation code.

Default Login User Names and Passwords


The following default login names and passwords are provided. You should ensure that they are
changed as soon as possible. Passwords are case-sensitive.

Name Password Permissions Group


GUARD guard Guard Permissions
ADMINISTRATOR administrator Administrator Permissions
MANAGER manager System Manager Permissions
INSTALLER install Installer Permissions

Command-Line Logons
It is possible to start and automatically log on to Symmetry by specifying the username and password
in the Windows command line. This feature can be useful to allow casual users of Symmetry to log on
easily (e.g. for visitor enrollment).
To start and log in from a Windows shortcut, select Command Line Logon in the "Maintenance/User
& Preferences/System Preferences" screen and use the following command format in the Target field
of the shortcut properties:
"<Path to Symmetry.exe>" /u"<UserName>" /p"<Password>"
For example:
"C:\Program Files\Security Management System\Symmetry.exe" /u"alanc" /p"mypassword"

Network-Locking Command-Line Switch


You can use the following command-line switch when running Symmetry.exe:
/N Clears the network locking table whenever the software is started. This may be necessary if users
are prevented from using a screen because the system incorrectly believes that the screen is in use
by another user. This may happen if, for example, the system has been shut down prematurely (e.g.
by a power cut).
For example: "C:\Program Files\Security Management System\Symmetry.exe" /N
You can run Symmetry with this switch by entering the full string as shown above in the Run dialog.
Note the space before /N and the use of double-quotes.

31
5. Chapter 5: Post-Installation Tasks

This chapter describes tasks that you may need to carry out after installing Symmetry, depending on
the hardware installed and the customer's requirements.

Installing Optional Features


Many optional features are available for Symmetry, such as additional readers and cameras, and
modules including intrusion management, guard patrols and card data import/export.
In general, no additional software needs to be installed to enable these features. Instead, obtain a serial
number for the feature and enter it into the "Maintenance/Licensing/System Licenses" screen. You will
need to enter an activation code, which you can obtain by phone or online from the address in the
"Maintenance/Licensing/System Licenses" screen.

Configuring Antivirus Software


For Windows Update configuration, follow your IT department's policy, but it is recommended that
any critical security hot fixes are applied promptly.
The use of antivirus software can significantly affect the performance of Symmetry. Real-time
scanning of files as they are opened should exclude:
 SQL database files. For detailed guidance about anti-virus scanning on SQL Server database
servers, please refer to:
https://support.microsoft.com/en-gb/help/309422/how-to-choose-antivirus-software-to-run-on-
computers-that-are-running
 Message queues (Windows\System32\MSMQ) on the Symmetry server and clients.
Full anti-virus scanning of disks should take place only during quiet periods of the day. Real-time
scanning should remain permanently enabled.
Avoid using Symmetry on any PC that allows insecure (user) web browsing.
Note: Before Symmetry goes live, the administrator must confirm that the performance of the
Symmetry system is not compromised by the selected antivirus solution.
You are recommended to subscribe to the AMAG Special Service Agreement (SSA) to ensure that the
system is kept up to date with the latest Symmetry security updates and other features.

32
Chapter 5:Post-Installation Tasks

Displaying the Symmetry Service Monitor


The Symmetry Service Monitor is available on the Symmetry server and on all Symmetry client PCs.
The Service Monitor allows you to view the current status of the Symmetry services, and start or stop
services if there is a requirement to do so.
You can make the Service Monitor available by setting up a desktop shortcut to ServiceMonitor.exe
located in the Symmetry installation folder (by default, Program Files\Security Management System).
After double-clicking the shortcut, you will see one of the following icons in the System Tray:
A green icon indicates that all services have started.

A flashing red icon indicates that not all services are started.

Right-click the icon and select Open Symmetry Service Monitor to display the Service Monitor. For
example:

Installing Encoder Files


If magstripe and/or Smartmax cards are going to be encoded from within the Symmetry software,
install the supplied .ENX and .SMX files into the Symmetry data folder (default is "Program
Data\Security Management System") on the Symmetry server. The files limit encoding to specified
customer codes (for standard Symmetry systems) or specified system codes (for HSE systems).
Once you have installed the files, restart the Symmetry server (or the Symmetry services). This process
copies the files into the database.
Note: .ENC files used in previous versions of Symmetry are not compatible with the current version of
the software.

Configuring and Testing Backups


During system commissioning, you need to specify the backup interval, test the backup process and
check the ability of third-party applications to save and restore backup files.
End users can use the "Operation/Data/Backup" screen to produce a backup of the Symmetry database
(Multimax, MultimaxTxn and MultimaxTxnOps), either on demand or at scheduled intervals. The
backup takes the form of a series of SQL "bak" files that include all configuration settings, card details,
card transactions, alarms, events, tasks and user activity stored in the Symmetry database. The backup
also takes a copy of multimax.ini in the ProgramData\Security Management System folder on the
Symmetry server.

33
Chapter 5:Post-Installation Tasks

In the unlikely event of a disk failure or other major problem, a Symmetry backup enables the
Symmetry databases to be restored, as described in Appendix E. Backups are also used when
upgrading Symmetry.
Symmetry backups can be automatically transferred to an external device using any appropriate third-
party backup software.
If you are having any difficulties getting backups to run, please refer to the online help for the
"Operation/Data/Backup" screen. The Symmetry Security Hardening Guide also provides details of
how to configure backups when a separate database server is used.
Note: If you are using a Symmetry NVR (page 47), you must back up the NVR configuration folder
separately and, if required, the video repositories. There is a separate configuration folder for each
NVR, the location of which was specified during the installation of the NVR software. By default, the
folder is located in "ProgramData\Symmetry\NVR", but you can find out the path by opening the
properties of one of the "Symmetry NVR" services – the path to the configuration folder is shown as a
parameter in the command line.

Configuring and Testing Archives


During system commissioning, you need to specify the archive interval and purge period, and test the
archive process.
An archive is a copy of the historical transaction data from the Symmetry database; that is, card
transactions, alarms, events, tasks and user activity. An archive is stored in an SQL "bak" file stored in
a specified location. End users can produce an archive using the "Operation/Data/Archive" screen.
Producing archives may be necessary for historical reporting purposes, since log data that is older than
a specified number of days is deleted automatically, as specified by the Purge Daily Logs After
option in the "Maintenance/User & Preferences/System Preferences" screen. When producing a report,
such as in the "Reports/History/Activity" screen, the user can choose an archive as the reporting
source.
Normally, the interval between archives should be slightly less than the Purge Daily Logs After
value. For example, if Purge Daily Logs After is set to 90 days, archives should be taken every 89
days.
Depending on the customer's requirements, archiving may not be required at all; data older than a
specified amount may not be of any interest. It is also important to know that if an archive is used to
produce a report, the whole archive is re-inserted into the transaction database.
Archives can be saved to an external device using any appropriate third-party software.
Note: On systems managed by Microsoft SQL Server Express, databases are restricted to a maximum
size of 10GB. If the transaction database grows to within 80% of this maximum (i.e. 8GB), the
"Transaction Log Running at Capacity" alarm/event message is generated and the oldest data is deleted
automatically to keep the database size less than 8GB. If this alarm/event message is generated, Purge
Daily Logs After should be set to a lower value and archives generated more frequently.

Setting Up Dial-Up Local/Remote Modems


This section is relevant only if Symmetry is going to modems for dial-up communications to remote
nodes.
Modems are configured automatically by the initialization string specified in the "Install/Access
Control/Chains/Dial-Up" screen. Normally, the local and remote modems' default settings do not
enable auto answer. Both modems need to be configured to allow this to happen. The remote modem
needs to be configured before it is taken to the remote site. Please read the following in conjunction

34
Chapter 5:Post-Installation Tasks

with the manufacturer's documentation. The modems can be set up by a 'terminal' program, such as
HyperTerminal, which can be downloaded from http://www.hilgraeve.com/htpe/download.html.
1. Connect the modem to a serial port using a modem-type serial cable.
2. Start HyperTerminal.
3. Create a new connection:

Type a name.

4. Choose the COM port that the modem is connected to:

Choose the COM port the modem is


connected to, then click Configure
and enter the baud rate (all other
settings can be left at the defaults).

5. In the HyperTerminal screen, send the specified initialization string to the local/remote modem.
Precede the initialization string with "AT" and finish by pressing the Enter key; for example,
ATQVXS0=2&M&N6&R1&W<Enter>.
The commands used to recall the active profile and set up the initialization string vary between
modem types. The following pages give some examples. It may be necessary to modify these
commands for other manufacturers or when different types of modem are used.
Note the following points:
 <Enter> means press the Enter key on your keyboard.
 The initialization string (excluding "AT") also needs to be entered in the "Install/Access
Control/Chains/Dial-Up" screen. Note that the initialization string for a dial-in modem is sent to
the modem only when Symmetry is started. Also, the maximum length that should be entered into

35
Chapter 5:Post-Installation Tasks

the Remote initialization String field should not exceed 21 characters. The field will allow more
characters than this to be entered, which allows for easier editing. Entering more characters than
the maximums stated may cause the remote node to malfunction.
 In remote chains, the node with the lowest address (set by switches in the node) must be
closest to the modem. All nodes start from address 1.
 Some nodes can be set to a baud rate of 38K4. Analogue modems may not support this connection
speed. Therefore, 38K4 should not be used in a dial-up chain configuration.

USRobotics Sportster Modem with DIP Switches


First, set the switches as follows:

Switch Local Remote Description


No. Modem Modem
1 off/up on/down Local monitors DTR, Remote
ignores DTR
2 on/down on/down Result codes are numeric
3 on/down on/down Result codes enabled
4 on/down on/down Do not echo in command state
5 off/up off/up Auto answer on first ring
6 off/up off/up Carrier detect reflects modem
connection
7 off/up off/up Loads Y0 or Y1 from non-volatile
memory
8 on/down on/down AT command recognition enabled
With each modem recall the factory default settings and write them to the active profile,
AT&F1&W0<Enter>.
Remote modem initialization string:
QVXS0=2&M&N6&R1&W<Enter>
Local modem initialization string:
QVXS0=1&M&N6&W<Enter>
Where:
Q0 enables the modem to return result codes.
V0 displays the result codes as numbers.
S0=2 sets the modem to answer on the second ring.
X0 provides basic call progress result codes.
&M0 disables error control (having this enabled can cause significant delays between local and
remote).
&N6 sets connect speed to 9600 baud. To communicate at 1200 baud the &Nn register should be
changed to &N2.
&R1 modem ignores RTS (remote modem only).

36
Chapter 5:Post-Installation Tasks

USRobotics Sportster Flash


First, recall to the active profile the factory default settings, AT&F1<Enter>.
Remote modem initialization string (9600 baud):
VS0=2EX&D&M&N6&R1<Enter>
Send the &W0<Enter> command to store the profile. This command may be appended to the
above string.
(In order to keep the string less than or equal to 17/21 characters, any command that uses a zero,
e.g. X0, has the zero removed; the modem will assume zero.)
Local modem initialization string (9600 baud):
QVS0=1EX&D2&M&N6&W<Enter>
Where:
Q0 enables the modem to return result codes.
V0 displays the result codes as numbers.
S0=2 sets the modem to answer on the second ring.
E0 causes characters not to be echoed.
X0 provides basic call progress result codes.
&D0 ignore the DTR signal (remote modem only).
&D2 monitor the DTR signal (local modem only).
&M0 disables error control (having this enabled can cause significant delays between local and
remote).
&N6 sets connect speed to 9600 baud. To communicate at 1200 baud the &Nn register should be
changed to &N2.
&R1 modem ignores RTS (remote modem only).
The above entries can then be verified by using the ATI4 command.

Hayes Modems
 Hayes V Series / Hayes Accura Modems
First, recall to the active profile the factory default settings, AT&F<Enter>.
Remote modem initialization string:
QVXS0=2E&D&Q6&W<Enter>
(In order to keep the string less than or equal to 17/21 characters, any command that uses a
zero, e.g. X0, has the zero removed; the modem will assume zero.)
Local modem initialization string:
QVXS0=1E&D2&Q6&W<Enter>
 Hayes Smartmodem (Older Type)
Remote modem initialization string:
Q0V0X0S0=2E0<Enter>

37
Chapter 5:Post-Installation Tasks

Local modem initialization string:


Q0V0X0S0=1E0<Enter>
Where:
Q0 enables the modem to return result codes.
V0 displays the result codes as numbers.
X0 provides basic call progress result codes.
S0=2 sets the modem to answer on the second ring.
E0 causes characters not to be echoed.
&Q6 sets the modem for automatic speed buffering (optionally &Q0 - async mode). (The default
&Q5 error-correction mode can cause complications in detecting the carrier; for this reason &Q6
should be used instead.)
&D0 ignore the DTR signal (remote modem only).
&D2 monitor the DTR signal (local modem only).
&W0 causes the current configuration to be written to profile 0
The above entries can then be verified by using the AT&V command.

Setting up Node Card Auditing


The Node Card Auditing feature allows Symmetry to check that the number of cards in nodes matches
the number expected from the information in the Symmetry database. If there is a mismatch, a "Node
Requires Card Synchronization" alarm is generated.
To enable this feature, edit the Windows Registry, as follows:
1. Go to Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Group4\
Multimax\Multimax.
2. Right-click each of the registry entries shown in the following table, and:
a) Select Modify.
b) Choose Decimal.
c) Set to the required value.

Registry Entry Meaning


MinNodeCardAuditReportInterval Specifies how often it is run (in minutes).
NodeCardAuditActive Set to 1 to enable auditing, or 0 to disable.
NodeCardAuditStartHour Specify the hour to start auditing (24-hour clock).
NodeCardAuditEndHour Specify the hour to end auditing (24-hour clock).
NodeCardAuditInterval Specify the frequency of the retries if a node is
disconnected (in minutes).

38
6. Chapter 6: Configuring Symmetry

Configuration Steps
This section outlines typical steps you need to take to configure Symmetry. If necessary, refer to the
Online Help or other publications for further information.

Installer Tasks
The following screens should be used by the installer in the order shown.

Screen Name Purpose

"Maintenance/User & Preferences/Set To change the installer's password, if the customer


Password" requires this.

To add licenses for readers, cameras and additional


"Maintenance/Licensing/System Licenses"
features.

"Install/System/Clients" To specify the type of clients used.


"Install/System/Default Settings/Reader/Card
To customize card formats (if required).
Formats"

To define details of each node, including the chain


"Install/Access Control/Node"
that it is connected to.

To define details of each reader, including the node


"Install/Access Control/Reader"
that it is connected to.

To define details of each monitor point, including


"Install/Access Control/Monitor Point"
the node that it is connected to.

To define details of each auxiliary output, including


"Install/Access Control/Auxiliary Output"
the node that it is connected to.

"Setup/Configuration/Facility/Customer
To define the card customer codes.
Codes"

To specify the clients that are to receive alarms


"Operation/Alarms/Routing"
(client/server system only).

"Setup/Graphics/Add" To create any graphics that are to be used and locate


"Setup/Graphics/Setup" devices on graphics.

"Maintenance/User & Preferences" To define system and client preferences.

"Operation/Data/Backup" To set up the daily backup time.


Note: To initialize communications, restart all clients that have Symmetry equipment connected to
their ports.

39
Chapter 6: Configuring Symmetry

End-User Configuration Tasks


The following screens should be set up in the order shown. This may be the responsibility of the
installer or end user.

Screen Name Purpose


"Maintenance/User & Preferences/Roles"
To set up permissions.
"Maintenance/User & Preferences/Accounts"

"Setup/Identity/Personal Data" To set up personal data.

"Operation/Times/Holiday"
To set up access rights.
"Operation/Times/Hours"
Note: Floor groups are supported by elevator nodes
"Operation/Times/Time Codes" only. For a multi-company system, you may also
need to use the Shared Floors and Shared Readers
"Setup/Device Groups/Readers"
screens in the "Setup/Device Groups/Shared" menu.
"Setup/Device Groups/Floors"

"Setup/Identity/Badge Designer" To set up badge designs.

"Home/Identity/Card Holders"
To set up card details.
"Home/Identity/Visitors"

To print badges. Badges can also be printed


"Home/Identity/Print Badges" individually from the "Home/Identity/Card
Holders" screen.

"Operation/Commands/Scheduled"

"Operation/Commands/Trigger" To set up commands.


"Setup/Identity/Area Occupancy"

"Operation/Alarms/Instructions"
"Operation/Alarms/Comments"
To set up alarm handling
"Operation/Alarms/Definitions"

"Operation/Alarms/Commands"
"Setup/Configuration/Patrol Tours" To set up patrol tours.

"Reports/Configuration"
To set up predefined reports
"Home/Identity/Muster"

40
7. Chapter 7: Removing, Changing and
Repairing Symmetry

Changing, Repairing or Removing Symmetry


The following screen is displayed if you run the Symmetry installation software and choose to install
Symmetry on a computer that already has the same version of Symmetry installed:

You can use the options as follows:


 Change − Choose this option if you want to change the following Symmetry installation settings:
‒ Remove or enable access to Windows Desktop (relevant only to client installations).
‒ Data Export and Data Import options (for example, export or import using a text file).
‒ Symmetry device integrations (such as the digital video and intrusion system integrations).
‒ The logo used by the Symmetry Advanced Reporting Tool to include on reports. By default,
the Symmetry logo is used.
‒ Registration details.
 Repair − Choose this to repair an installation which may have been damaged (for example, if files
have been mistakenly deleted or moved), or to upgrade an older copy of the database that has been
restored from a backup. All Symmetry files are replaced as part of a repair process.
 Remove − Choose this to remove the main Symmetry application from the computer. If you
require a complete removal of all installed software, please follow the instructions in the following
section.

41
Chapter 7: Removing Symmetry

Removing Symmetry
This section describes how to remove Symmetry and its database, if it ever becomes necessary to do so
(e.g. when a computer is replaced). You must have local administrator privileges to do this.

Removing the Symmetry Client or NVR Software


To remove Symmetry from a separate Symmetry client machine or NVR machine:
1. Close down the client software and the Service Monitor (if launched).
2. Use the Windows Control Panel to remove any software that has a name containing "Symmetry".
Also remove Bosch.VideoSDK.
3. Restart the computer, then remove the "Program Files\Security Management System" folder.
4. If required, also delete face and signature images, log files and other data by removing the
"Program Data\Security Management System" folder. It may be preferable not do this if you intend
to re-install Symmetry.
5. If required, Symmetry license, registration and other installation settings can be removed by
running InstallationCleaner.exe, which is located in the Symmetry Assistance folder on the
installation media.

Removing the Symmetry Server Software


Use the following procedure if you want to remove Symmetry (not including the database) from the
server:
1. If the Symmetry client software is still installed on remote clients, go to each of these clients, close
down Symmetry and stop all Symmetry services. Services can be stopped from Administrative
Tools in the Control Panel, or from the Symmetry Service Monitor (see page 33).
2. Close the Symmetry Service Monitor on the server, if open.
3. Use the Windows Control Panel to remove any software that has a name containing "Symmetry".
Also remove Bosch.VideoSDK.
4. Restart the computer, then remove the "Program Files\Security Management System" folder.
5. If you do not intend to use Symmetry again at this machine, you may also want to delete
multimax.ini, face and signature images, log files and other data by removing the "Program
Data\Security Management System" folder.
6. If required, Symmetry license, registration and other installation settings can be removed by
running InstallationCleaner.exe, which is located in the Symmetry Assistance folder on the
installation media.

Removing SQL Server


SQL Server can be removed as follows:
1. Using the Windows Control Panel, remove all Microsoft SQL Server programs, and follow the
prompts.
If prompted, choose to remove all components/features.
2. On completion, restart the computer, and check that all Microsoft SQL Server programs have been
removed.
3. Remove the SQL Server installation folder (e.g. Program Files\Microsoft SQL Server).

42
8. Chapter 8: Upgrading Symmetry

Introduction
This chapter describes how to upgrade Symmetry to the latest version.
Note: The existing Symmetry installation must be at least version 8.1. If you have an earlier version, it
must be upgraded first to version 8.1 using the procedures given in the SMS Software Upgrade Guide.
Note: Please contact your AMAG Support Representative if you wish to upgrade a clustered system or
other Symmetry applications such as Control Desk and Advanced Reporting.
There are two methods to perform an upgrade:
 Typical (same-machine) upgrade − Use this method if you are keeping your existing Symmetry
server and (if used) database server, and are not upgrading from Symmetry Professional Edition to
Symmetry Enterprise Edition.
If you choose this method, you will need to make sure that any reused machines meet the
minimum hardware and software requirements, as given from page 7.
You can also choose to upgrade existing Symmetry clients, or upgrade onto new PCs.
 Advanced (new-machine) upgrade − Use this method for any other scenario not covered by the
typical (same-machine) method. For example, use this method if you are replacing the Symmetry
server, a separate database server, both the Symmetry server and database server, or if you need to
move the Symmetry database to a different SQL Server instance. You also need to use this
procedure if you want to upgrade a Symmetry Professional Edition system to Symmetry Enterprise
Edition.
You can also choose to upgrade existing Symmetry clients, or upgrade onto new PCs.

Prerequisites
Before you carry out an upgrade, make sure you follow all the prerequisites described below.

Removal of Unsupported Features


Certain features have been removed from Symmetry. Before you carry out the upgrade, you must
remove the following features and any dependencies from the existing version of Symmetry:
 ENVS devices
 Pelco recorders
Note: Before you remove these items, make sure that you take a backup, which should be stored on a
different machine on the network or on removable media. Take another backup after the removal.
The upgrade will not proceed if any unsupported feature is detected.

43
Chapter 8: Upgrading Symmetry

Disk Space
Make sure you have plenty of available disk space on the machine that holds the Symmetry databases.
Typically, the available space must be at least twice the disk space occupied by the current Symmetry
databases.

Minimum System Requirements


Any new machines must meet the minimum hardware and software requirements as given on page 7.

New Symmetry Licenses


New licenses are needed for the new version of Symmetry, including for any optional features.

Symmetry SMS Player


Check Programs and Features in the Control Panel to determine whether "SMSVideoPlayer" is
currently installed. If it is installed:
1. Uninstall SMSVideoPlayer before upgrading Symmetry.
2. Delete the folder named "Bosch" in the SMS Video Player installation folder. For example,
C:\Program Files (x86)\SMS Video Player\SMS Video Player\Bosch".
3. After the upgrade, re-install the player by double-clicking SMSVideoPlayerAutoRun.exe located
in the Symmetry installation folder. For example, C:\Program Files (x86)\Security Management
System.

Symmetry 75xx Cameras


If you are using Symmetry 75xx cameras (such as the EN-7510), carry out the following (failure to do
so may prevent live video from being displayed):
1. Display the camera's web interface.
2. Select System Options − RTSP/RTP.
3. Select H.264 NAL Stream, and remove the checkmark from Enable RTSP Authentication.
4. Apply the changes.

Passwords
Symmetry v 9.0 and later requires a minimum password length of five characters for all Symmetry
login accounts, and passwords are case-sensitive. Before upgrading, check Minimum Password
Length in the "Maintenance/User & Preferences/System Preferences" screen. If it is set to less than 5,
change it to be at least 5 and ask all Symmetry users to update their passwords accordingly.

Symmetry XML Open Integration Module


If the XML Open Integration Module is installed and is prior to version 9.0, it must be removed from
the Symmetry server before the upgrade, and then reinstalled after the upgrade. Due to the variety of
possible configuration scenarios, it is recommended that you contact your product support
representative for assistance with upgrading the Symmetry XML Open Integration Module.

Auto-Rollback
It is strongly recommended that you choose to create a backup when prompted during the upgrade
procedure. Doing so not only saves a backup of the current database, but also enables Symmetry to
roll-back your system to the existing version in the unlikely event of an error occurring during the
upgrade.
Note: If a rollback occurs, check that all "Symmetry NVR" services are started after the rollback.

44
Chapter 8: Upgrading Symmetry

Typical (Same-Machine) Upgrade Procedure


Follow this section to upgrade an existing Symmetry server.
If you are using separate Symmetry clients, you can choose to upgrade the same PCs, or upgrade onto
new PCs.

Step 1 − Check the Prerequisites


Check the prerequisites given on page 43. You must remove unsupported items before you continue.

Step 2 − Shut Down the Symmetry Clients and Services


If any separate Symmetry client PCs are being used, shut down Symmetry at those clients, and stop the
service named Symmetry (or SMS) Client Services at each client.
If the Symmetry API is being used for SymmetryWEB, go to each Symmetry API server, and shut
down the service named "Symmetry API Service".

Step 3 − Upgrade Microsoft SQL Server


Download the latest service pack for SQL Server from the Microsoft web site and install it on the
Symmetry server (or database server, if a separate database server is being used).
Note: Make sure you download the 32-bit (x86) or 64-bit (x64) version of the service pack, depending
on the version currently being used. SQL Server 2016 and 2017 are always 64-bit. Use the Select
Features page displayed when you run the service pack to check that you have downloaded the correct
version of the service pack, as shown next.

Make sure that


Database Engine
Services is listed. If it
is not listed, you are
not running the
correct upgrade exe.

This area shows the


current edition and
service pack
installed.

Step 4 − Upgrade the Symmetry Server


Note: The upgrade does not change multimax.ini, so any changes previously made to multimax.ini are
kept.

Upgrade the Symmetry server as follows:


1. Log in with administrator privileges at the Symmetry server.

45
Chapter 8: Upgrading Symmetry

2. Insert the new Symmetry installation media and wait for the installation wizard to start. If it does
not start, double-click Setup.exe, which is located in the top-level folder of the media.
3. Click Next at the Welcome screen.
4. The following is displayed:

DO NOT select Microsoft


SQL Express.

Select Symmetry.

5. Follow the remaining prompts – These are the same as for a standard new installation (if
necessary, refer to Installing the Symmetry Server Software on page 18 for assistance), with the
exception of the following:
 Before the update takes place, Symmetry checks the current database and informs you of
any patches or other items that will prevent an upgrade from taking place. In this event, an
option is displayed for you to save a log file to share with your AMAG Support
Representative.
 You cannot change the SQL Server instance name used by Symmetry. This is grayed out.
 You are not prompted for the customer code.
 About half way through the procedure, you are prompted to create a backup:

This area shows


the version of the
current database
and the date and
time of the last
backup.

Note: Make sure the Backup checkbox is


selected to enable auto-rollback (page 44).
Note: If applicable, also install any updated language packs (page 24).

Step 5 − Log in to Symmetry and Install the Symmetry Licenses


Log in to Symmetry. If you have any Symmetry licenses for optional features, add them using the
"Maintenance/Licensing/System Licenses" screen in Symmetry. The license serial numbers must be
for the new version of Symmetry, not for the previous version.

46
Chapter 8: Upgrading Symmetry

Step 6 − Upgrade the Symmetry Clients


Follow this step if you are using any separate Symmetry client PCs.

To upgrade an existing Symmetry client PC (keeping the existing machine):


1. Log in with administrator privileges at the Symmetry client.
2. Insert the new Symmetry installation media and wait for the installation wizard to start. If it does
not start, double-click Setup.exe, which is located in the top-level folder of the media.
3. Install a standard Symmetry client in the normal way. If you do not know how to do this, please
refer to Installing Symmetry Client Software on page 25.
Note: You can upgrade a Symmetry version 9.0 or later client using a batch file, rather than the
Symmetry installation software. This is known as a "silent upgrade" and is described on page 53.
To install an additional Symmetry client, or replace an existing Symmetry client:
 Install a standard Symmetry client in the normal way. If you do not know how to do this, please
refer to Installing Symmetry Client Software on page 25.
If you are replacing an existing Symmetry client, make sure that you choose Existing Client and
the Client Name in the "Defining your Client Name" page of the Symmetry Installation Wizard.

Step 7 − Upgrade Symmetry API Servers


If you are using Symmetry API Servers (for SymmetryWEB), overinstall the existing version with the
version that is compatible with the new version of Symmetry being used. Please refer to the Technical
Bulletin that accompanies the API release.

Step 8 − Upgrade Symmetry NVRs


This step applies only if separate Symmetry NVRs are being used.
Note: When upgrading from Symmetry v8.1 to Symmetry to v9.0 or later, it is essential to upgrade all
Symmetry NVRs.
1. Remove the NVR software:
a) Using Program and Features in the Windows Control Panel, remove "Symmetry Network
Video Recorder" from each NVR. The Symmetry NVR database and any index files are
retained.
b) If installed, also remove Symmetry ONVIF and Symmetry 7500(HD). These will be
replaced with updated versions as part of the new NVR installation.
2. Follow the standard procedure for installing a new Symmetry NVR (refer to Installing a Symmetry
NVR on page 28 if you need assistance), but note the following:
 Choose to install the Symmetry ONVIF and 7500(HD) plugins, if applicable.
 When you see the "Configuration Folder Location" screen, make sure you select the same
location as used previously (default is "ProgramData\Symmetry\NVR").
 Do not make changes to the Repository Options.
The new NVR software is now installed and ready to use. Any cameras with a recording mode of
Always or with a recording schedule set at the NVR will begin recording again. You can validate this
via the NVR's web interface.

47
Chapter 8: Upgrading Symmetry

Advanced (New-Machine) Upgrade Procedure


Follow this section if you want to upgrade Symmetry and use a new machine for either the Symmetry
server, a separate database server (if used), or both.
If you are using separate Symmetry clients, you can choose to upgrade the same client machines, or
upgrade onto new machines.

Step 1 − Check the Prerequisites


Check the prerequisites given on page 43. You must remove unsupported items before you continue.

Step 2 − Understand the Upgrade Procedure


Before you begin, take time to understand the overall upgrade procedure, which is dependent on the
machine(s) you want to upgrade. The following gives an overview of the various upgrade scenarios.

Scenario 1 - Use a NEW Symmetry server, which will also host the Symmetry databases
If you are using a single machine for both the Symmetry server and Symmetry databases, you can use
a new machine for that purpose. You will need to:
1. Install SQL Server on the new machine.
2. Restore the old multiMax and multiMaxTxn Symmetry databases.
3. Install the new Symmetry server software. During installation, select the Symmetry database
instance on the Symmetry server. The Symmetry databases are upgraded automatically.
4. Upgrade any separate Symmetry clients, NVRs and Symmetry API servers (for SymmetryWEB).

Scenario 2 - Use a NEW Symmetry server, and KEEP an existing database server
If you are using a separate database server, you may want to use a new machine for the Symmetry
server, but keep the existing database server. You will need to:
1. Shut down the existing Symmetry server and clients.
2. At the new Symmetry server, install the new Symmetry server software. During installation, select
the existing Symmetry database instance. The Symmetry databases are upgraded automatically.
3. Upgrade any separate Symmetry clients, NVRs and Symmetry API servers (for SymmetryWEB).

Scenario 3 - Use a NEW Symmetry server, and a NEW database server


If you want to replace both the Symmetry server and a separate database server, you will need to:
1. Install SQL Server on the new database server.
2. Restore the old multiMax and multiMaxTxn Symmetry databases onto the new database server.
3. At the new Symmetry server, install the new Symmetry server software. During installation, select
the Symmetry database instance on the new database server. The Symmetry databases are
upgraded automatically.
4. Upgrade any separate Symmetry clients, NVRs and Symmetry API servers (for SymmetryWEB).

Scenario 4 - KEEP the existing Symmetry server, but use a NEW database server
If you want to keep the existing Symmetry server, but want to replace the separate database server (or
use a new database instance), you will need to:
1. Install SQL Server on the new database server.
2. Restore the old multiMax and multiMaxTxn Symmetry databases onto the new database server.

48
Chapter 8: Upgrading Symmetry

3. Shut down the existing Symmetry server and clients.


4. Uninstall Symmetry at the Symmetry server.
5. Install the new Symmetry server software. During installation, select the Symmetry database
instance on the new database server. The Symmetry databases are upgraded automatically.
6. Upgrade any separate Symmetry clients, NVRs and Symmetry API servers (for SymmetryWEB).

Step 3 − Install SQL Server and Restore the Databases (Scenarios 1, 3 and 4)
If you are using a new Symmetry server that will also host the databases (scenario 1), or a new
database server (scenarios 3 and 4):
1. Install the required version of SQL Server on that machine (Express or full version, as applicable).
You can install SQL Server Express by running Setup.exe on the new Symmetry installation media
and selecting only Microsoft SQL Express. Do not also select Symmetry, otherwise you will
need to follow a different upgrade procedure (not documented here).
See Hardware and Software Recommended Requirements on page 7 for details of the versions of
SQL Server supported by Symmetry.
If you need guidance about full SQL Server installation and configuration, please refer to the
Symmetry Security Hardening Guide.
Note: During the installation of the new version of SQL Server, make sure you use the same
Collation setting that the previous version used (e.g. "Latin1_General_100_CL_AS"). For full
SQL Server, this is specified in the Collation tab of the Server Configuration page. Different
language types (e.g. European and Asian) normally use different collations.
2. Make sure that the latest backup of the Symmetry database is available to the machine that runs
SQL Server. To avoid issues with disk space, it is recommended that the backup is available
through a mapped drive or removable media − if you copy it to the hard disk, you will need
sufficient disk space for this backup, the backup created at the start of the upgrade procedure, and
the upgraded database.
3. Restore only the multiMax and multiMaxTxn databases, as follows:
a) Log in as an Administrator to the machine that is running SQL server.
b) Make sure that the SQL Server service is running, start SQL Server Management Studio (if not
already installed, available from the Microsoft web site), then open the server.
c) Right-click on Databases, select Restore, Database. Select Device, then click the browse (...)
button. In the dialog displayed, click Add, then select the backup file. Click OK twice to
return to the Restore Database dialog. Select the backup.
d) In the Files page, check the paths displayed. These must match the path to the Data folder used
by SQL Server (by default, Program Files\Microsoft SQL Server\<...InstanceName>\Data). If
these paths are not correct, click and edit the paths. Make sure that the drive letter is correct.
e) Click OK in the Restore Database dialog to begin the restore process. If the restore fails, make
sure that the Symmetry services are stopped and try again.
f) Repeat the above steps for the multiMAXTxn database.
g) Close SQL Server Management Studio.

49
Chapter 8: Upgrading Symmetry

Step 4 − Shut Down the Symmetry Server and Clients (Scenarios 2 and 4)
If you are keeping the existing Symmetry server machine or an existing database server:
1. At the Symmetry server and at all clients (including machines used to run the Symmetry API
Service for SymmetryWEB):
a) Log in as an Administrator.
b) Close down Symmetry and stop all services prefixed by "Symmetry" (or "SMS"). Services can
be stopped from Administrative Tools in the Control Panel, or from the Symmetry Service
Monitor (page 33).
There is no need to stop services at separate Symmetry NVRs. Separate Symmetry NVRs can
continue to operate during an upgrade.
2. If you are keeping only the existing Symmetry server (scenario 4 only), remove Symmetry at the
Symmetry server. Please refer to Removing the Symmetry Server Software on page 42 if you do not
know how to do this.

Step 5 − Run the Symmetry Installer (all Scenarios)

At the Symmetry server (for the new version of Symmetry):


1. Insert the new Symmetry installation media and wait for the installation wizard to start. If it does
not start, double-click Setup.exe, which is located in the top-level folder of the media.
2. Click Next at the Welcome screen.
3. The following is displayed.

DO NOT select Microsoft


SQL Express.

Select Symmetry.

5. Follow the remaining prompts – These are the same as for a standard new installation (if
necessary, refer to Installing the Symmetry Server Software on page 18 for assistance), with the
exception of the following:
 Before the update takes place, Symmetry checks the current database and informs you of any
patches or other items that will prevent an upgrade from taking place. In this event, an option is
displayed for you to save a log file to share with your AMAG Support Representative.
 Make sure you select the Symmetry database instance to upgrade.
 You are not prompted for the customer code.
 If you are using a new machine for the Symmetry server, you will see the following prompt.

50
Chapter 8: Upgrading Symmetry

Select the checkbox,


then click Next.

About half way through the procedure, you will see one of the following two screens:

This is displayed if you


are using a different
machine for the database
(scenarios 1, 3 and 4).
Select I confirm that...,
then click Next.
In this case, no auto-
rollback to the saved
backup will be available
if, in the unlikely event,
there is a problem during
the upgrade.

This is displayed if you


have not changed the
machine used to host the
Symmetry databases
(scenario 2).

This area shows the


version of the current
database and the date
and time of the last
backup.

Note: Make sure the Backup checkbox is


selected to enable auto-rollback (page 44).

51
Chapter 8: Upgrading Symmetry

Note: If applicable, also install any updated language packs (page 24).

Step 6 − Log in to Symmetry, Choose the Server and add the Licenses (all scenarios)
Log in to Symmetry at the updated Symmetry server, and carry out the following:
1. In the Installation Wizard (which is displayed automatically after you log in), make sure that you
choose the correct server name:

Select Existing
Server, choose the
name of the previous
server from Client
Name, then click
Next. Click Yes at the
confirmation prompt.

2. Finish the remaining steps in the Installation Wizard.


3. If you have any Symmetry licenses for optional features, add them using the
"Maintenance/Licensing/System Licenses" screen. The license serial numbers must be for the new
version of Symmetry, not for the previous version.

Step 7 − Update MultiMAX.ini


If you have kept the previous Symmetry server (scenarios 4), multiMAX.ini will remain and you need
to make no changes.
If you are using a new Symmetry server (scenarios 1, 2 and 3) and changes were made manually to the
previous version of multiMAX.ini, the same changes need to be made to the new version. If you are
unsure, perform a comparison between the old and new versions, and make the necessary changes.
Please refer to Appendix A for details of multiMAX.ini.

Step 8 − Install or Upgrade the Symmetry Clients


Follow this step if you are using any separate Symmetry client PCs.

To upgrade an existing Symmetry client PC (keeping the existing machine):


1. Remove the Symmetry client software from each Symmetry client. If you do not know how to do
this, please refer to Removing the Symmetry Client or NVR Software on page 42.
2. Install the new Symmetry client software in the normal way. If you do not know how to do this,
please refer to Installing Symmetry Client Software on page 25.

To install an additional Symmetry client, or replace an existing Symmetry client:


 Install a standard Symmetry client in the normal way. If you do not know how to do this, please
refer to Installing Symmetry Client Software on page 25.
If you are replacing an existing Symmetry client, make sure that you choose Existing Server and
the Client Name in the "Defining your Client Name" page of the Symmetry Installation Wizard.

52
Chapter 8: Upgrading Symmetry

Step 9 − Upgrade Symmetry NVRs


This step applies only if separate Symmetry NVRs are being used.
Note: When upgrading from Symmetry v8.1 to Symmetry to v9.0 or later, it is essential to upgrade all
Symmetry NVRs.
1. Remove the NVR software:
a) Using Program and Features in the Windows Control Panel, remove "Symmetry Network
Video Recorder" from each NVR. The Symmetry NVR database and any index files are
retained.
b) If installed, also remove Symmetry ONVIF and Symmetry 7500(HD). These will be
replaced with updated versions as part of the new NVR installation.
2. Follow the standard procedure for installing a new Symmetry NVR (page 28), but note the
following:
 Choose to install the Symmetry ONVIF and 7500(HD) plugins, if applicable.
 When you see the "Configuration Folder Location" screen, make sure you select the same
location as used previously (default is "ProgramData\Symmetry\NVR").
 Do not make changes to the Repository Options.
The new NVR software is now installed and ready to use. Any cameras with a recording mode of
Always or with a recording schedule set at the NVR will begin recording again. You can validate this
via the NVR's web interface.

Step 10 − Upgrade Symmetry API Servers


If you are using Symmetry API Servers (for SymmetryWEB), overinstall the existing version with the
version that is compatible with the new version of Symmetry being used. Please refer to the Technical
Bulletin that accompanies the API release.

Step 11 − Remove Symmetry from Previous Machines


You can now remove Symmetry from any unused machines. If you do not know how to do this, please
refer to page 41.

Silent Upgrades (Symmetry Clients only)


You can use a batch file to upgrade a Symmetry version 9 or later client, which can simplify the
process of upgrading a Symmetry client, since there is no need to launch the Symmetry installation
software, or respond to any prompts. All settings remain unchanged from the previous version.
When you want to run the batch file, right-click and choose Run as Administrator.
Note: You cannot use a batch file to upgrade a Symmetry server, Symmetry NVR or a Symmetry
client that is earlier than version 9.0.

Batch File Format


The format of the batch file is as follows:
@echo off
msiexec /q /i "<Path to Symmetry Installer>\SymmetryInstaller.msi" /l*v "<Path to Log
Folder>\SymmetryInstallerLog.txt" SERVICESACCOUNT="<Machine or Domain
Name>\<Symmetry Services Account Name>" SERVICESPASSWORD="<Symmetry Services Password>"
SQLSERVERACCOUNT="<SQL Server Connection>" SQLSERVERPASSWORD="<SQL Server Login
Password>"

53
Chapter 8: Upgrading Symmetry

Where:
<Path to Symmetry Installer> is the path to SymmetryInstaller.msi (by default, SymmetryInstaller.msi
is located in the "Setup" folder on the Symmetry installation media).
<Path to Log Folder> is the path to a folder that will store the log created by the upgrade procedure.
<Machine or Domain Name> is the name of the machine or domain where the Windows account used
to run the Symmetry services is registered.
<Symmetry Services Account Name> is the name of the Windows account used to run the Symmetry
services.
<Symmetry Services Password> is the password of the Windows account used to run the Symmetry
services.
<SQL Server Connection> is one of the following:
 WindowsAuthentication − If Windows authentication is used to connect to the database.
 The login name of an SQL Server account that gives administrator access to the database − if
SQL Server Authentication is used to connect to the database (not recommended).
<SQL Server Login Password> is the password of the SQL Server login name. If Windows
authentication is used, remove SQLSERVERPASSWORD="<SQL Server Login Password>".

54
A. Appendix A: About the .ini File Settings

MultiMAX.ini Settings
This appendix describes the meaning of each entry in the multiMAX.ini configuration file found in the
ProgramData\Security Management System folder on each computer. To avoid harming system
operation, please change settings with caution and only if you fully understand the effects.
Note: After modifying multimax.ini, restart all Symmetry services and the Symmetry software on the
PC where multimax.ini is located.
[multiMAX]
EnrollAppActive=1 Set to 1 if you want the "Home/Identity/Card Holders" and
"Home/Identity/Visitors" screens to include a Capture button that
starts a third-party application to enrol fingerprint, iris, facial or other
biometric data. Additional settings are required in the [EnrollApp]
section of multimax.ini. A value of 0 prevents the Capture button from
being included.
Note: Using the [BioEnrolment] section instead of this setting gives
alternative functionality for the Capture button and also provides the
ability to import card data automatically into a new card holder
record. Please refer to the description of the [BioEnrolment] section.
ActivityAndSystemReverseOrder=0 This optional (client) parameter determines the order of items
displayed in the "Reports/History/Activity" and
"Reports/History/System" screens. Set to 1 to reverse normal order (0
is default).
ActivityByCompanyGroup=1 Set to 1 and set the View Menu By Company system preference to
enable the Activity screen to display only information from companies
in the user's company group. Setting to 0 (the default) and unsetting
View Menu By Company enables the Activity screen to display
information from any company belonging to any company group,
irrespective of the user's own company group.
ActivityHistoryScreenMaxTransactions=xxxxxx This optional parameter specifies the maximum number of
transactions to display in the "Reports/History/Activity" screen
(default is 200,000).
ActivityReportTxnFontSize=4 This optional parameter determines the font size of text in reports
printed from the "Reports/History/Activity" screen. The value must be
in the range 1 to 8 (8 gives the largest font size).
AIQ=1 Alarms Input Queue. This server-only parameter must be set to 1.
AllowForceInitialisation=1 This optional parameter enables a Factory Reset button in the
"Install/Access Control/Node" screen, which allows a user with System
Admin privileges to re-initialize all the databases in the controller to
factory default state.
BadgePrinter1= Specifies the default badge printer for a badge design.
BlockRandomSearch=1 Specifies to block a card belonging to a card holder who is undergoing
a random search. Blocking can be removed by using a Re-enable
Stopped Cards command from Symmetry. Omit this setting to disable
automatic blocking.
CheckGrantedAccessCondCommand=1 When this is set to 1 (the default), Symmetry checks whether each grant
access transaction received is used in the "when" part of a trigger

55
Appendix A: About the .ini File Settings

command. If grant access is not required to activate trigger


commands, performance benefits are achieved by disabling this feature
(i.e. setting to 0).
CommsReceiverDateTimeSentPeriodMins= This determines the period between date and time updates at a
communications receiver. The receiver's date and time are
synchronized with the date and time at the Symmetry database server.
Set to 0 to disable date and time updating (default is 60).
CTQ=1 Comms Transmission Queue. Set to 1 to enable communications from
this PC.
CustomAlarmEmailsEnabled=1 Set this option parameter to 1 to make the "Operation/Alarms/Custom
Alarm Emails" screen available in Symmetry. The screen allows
imported alarms to be automatically emailed to different email
addresses based on the alarm details. Set to 0, or exclude the
parameter, to prevent the screen from being available.
DatabaseInstance= Specifies the instance name of SQL Server used for the Symmetry
database.
datacardprinter= The default is "datacard". If a Datacard badge printer is used, the
name specified here must appear in the Windows name of the printer
to ensure that Symmetry uses the correct encoder files.
DataExportAfterImport=1 This optional parameter enables the exporting of card holder data
following an import. Set to 1 to enable, or 0 (default) to disable.
DataExportEnabled=0 This server-only parameter specifies how to export data: 0 = Data
Export disabled; 1 = Data Export uses SQL Server database; 3 = Data
Export uses text (2 is not used).
DataImportEnabled=0 This server-only parameter specifies how to import data: 0 = Data
Import disabled; 1 = Data Import uses SQL Server database; 2 = Data
Import uses text.
DCOMRouter=0 For engineering use only; do not change.
DefaultAgencyCode=9999 Specifies the default Agency Code displayed in the Card Holders or
Visitors screen for Homeland systems.
DefaultCardSearchIndex= Records the option selected in the Filter By pull-down list in the
"Home/Identity/Card Holders" screen. This enables Symmetry to
automatically select the option the next time the screen is opened.
DefaultCardStatusIndex= Records the option selected in the Select by Status pull-down list in the
"Home/Identity/Card Holders" screen. This enables Symmetry to
automatically select the option the next time the screen is opened. 0 =
All.
DefaultConditionalCommandSearchIndex=0 Used to store the Select By Status setting in the Trigger
Commands Selection screen.
DefaultShowAllAccessRights= Records the last selected state of the Show All button in the Card
Holder screen (1=Show All).
DefaultSystemCode=9999 Specifies the default System Code displayed in the Card Holders or
Visitors screen for Homeland systems.
DefaultTimedCommandSearchIndex=0 Used to store the Select By Status setting in the Scheduled Commands
Selection screen.
DefaultUnitIDCode=9999 Specifies the default Unit Code displayed in the Card Holders or
Visitors screen for Homeland systems.
DefaultVisitorSearchIndex= Records the option selected in the Filter By pull-down list in the
"Home/Identity/Visitors" screen. This enables Symmetry to
automatically select the option the next time the screen is opened.
DefaultVisitorStatusIndex= Records the option selected in the Select by Status pull-down list in the
"Home/Identity/Visitors" screen. This enables Symmetry to
automatically select the option the next time the screen is opened. 0 =
All.

56
Appendix A: About the .ini File Settings

DeleteMSMQs=0 This is an engineering tool that deletes and recreates the Symmetry
message queue (you may want to use this if alarms or other messages
are not reaching their destination). With all of the Symmetry services
running:
1. Set to 1 at a client to delete the message queue at the client, or
set to 1 at the server to delete the message queue at the server.
2. Stop then restart the Symmetry services. The message queue is
recreated and DeleteMSMQs is set to 0.
DisableScreenSaver=0 Set to 0 to allow the operating system screen saver to function. Set to 1
to disable the screen saver.
DisableChainName=1 Set to 0 to allow the chain and node address of an existing node to be
changed in the "Install/Access Control/Node" screen. Set to 1 to use
the default behavior of not being able to change these settings.
DuplicateCardWhenCopied=1 If set to 1, this optional parameter causes Symmetry to retain the card
holder's image, signature, facility/customer code and PIN when a card
is copied, such as using the Copy option in the Card Holder's screen..
DuplicateImportedTransactions=1 If set to 1, this optional parameter causes Symmetry to log imported
transactions when importing alarms/events that are associated with
specific readers, monitor points or card holders. Please refer to the
Data Connect Manual for further information.
DVMTimeout=30 Specifies the maximum period of time (in seconds) that Symmetry will
wait for a video recording to be retrieved from a digital video
recorder. A recording that takes longer than this period to retrieve is
seen as a timeout error.
fargoprinter= The default is "fargo". Do not change this setting.
ForceCaFor21002150DBU= Set to 1 to enable card holders with PIN codes of more than 4 digits to
be downloaded to Multinode2100/2150 nodes. Add the setting to the
ini file at the Symmetry server, restart the Symmetry Support Service,
and the Symmetry Client Service at all clients hosting communications
to the nodes.
FRCustCode= This is the customer code to be programmed into a Bioscrypt
fingerprint reader from the "Install/System/Client Ports" screen.
HorizontalFaceRatio=100 Specifies the horizontal aspect ratio setting used when selecting the
area of a face image to use in the Card Holders or Visitors screen. For
example, if HorizontalFaceRatio is 300 and VerticalFaceRatio is 400,
the aspect ratio used is 3:4.
ImportExportAllPersonalData=1 This server-only parameter determines whether 50 or 20 personal data
titles are imported by "Operation/Data//Data Import". The default of 1
allows 50 titles to be imported. Setting the parameter to 0 allows 20
titles to be imported, which can reduce import time.
LegacyFargoPrinter=0 Specifies the type of magstripe encoding for Fargo badge printers. Set
to 1 for ISO encoding, or 0 for RAW binary encoding. The DTC4xxx
and HDP5000 can use either encoding method. Ensure printer
properties are configured (page 68).
LocalPath=C:\Program Files\ Specifies the destination folder of reports that are sent to a
Security Management System\ file. The reports are stored in the reports folder below this
path. Do not change the drive letter.
magicardprinter= The setting determines the encoding format when printing and
encoding cards.
MainPath=\\SERVER\RootOnServer\ Path to the Symmetry files on the server.
Program Files\Access
Control System\
MaxMultipleCards=10 Specifies the maximum number of cards per card holder (default 10).
MicronodeSupport=0 This server-only parameter must remain at the default value of 0, as
micronodes are no longer supported.

57
Appendix A: About the .ini File Settings

NCCT=600 This setting causes an automatic restart of the Symmetry client PC if


the Symmetry client service has not been able to communicate with the
Symmetry server within the specified time period (in seconds). The
restart of the client PC is aimed at re-establishing communications.
The setting is optional; if it is not specified, the default of 600 seconds
is used.
NoLeadingZerosOnBadge=0 When set to 0 (the default), this optional server-only parameter causes
the card number printed on badges to be prefixed with zeros to extend
the number of digits used to the maximum. For example, card 24 may
be printed as 00000024. A value of 1 specifies that no leading zeros
are to be printed.
OpenDesfireFileEncoding=x This parameter allows various DESFire information to be encoded in
the open section of the card. The information can be read without key
authentication. The parameter can be set on the Symmetry server to
provide the default setting, and on any Symmetry client to override the
setting locally. "x" can be any of the following, or a sum of two or
more of the following (for example, a value of 3 will produce 040406
and 040407, and a value of 15 will produce all four application
areas):
1 - If set, an application area at address 040406 will be created that
contains an unpacked BCD (Binary-Coded Decimal) representation of
the card holder's card number.
2 - If set, an application area at address 040407 will be created that
contains a packed BCD representation of the card holder's card
number.
4 - If set, an application area at address 040408 will be created that
contains the card holder's employee reference.
8 - If set, an application area at address 040409 will be created that
contains a packed BCD representation of the card holder's card
number, followed by a packed representation of the card issue level.
OnSiteBeyondLimitMaxDays=10 This affects the behavior of the "Reports/Configuration/Predefined
Reports/Onsite Beyond Limit" screen. By default, the report excludes
card holders who have made no granted-access transaction for more
than 30 days. You can use this setting to change the period.
ReportIntegralMotionAlarms=0 Set to 0 to disable reporting of Pelco Integral motion alarms (default
1). (Pelco devices no longer supported.)
RDSLocalBrowsing=0 This is available only for multimax.ini on an RDS web server machine.
Set to 1 to allow browsing on user's local browser machine. Set to 0
(the default) to prevent browsing on local machine and instead to
constrain browsing to the RDS web server machine. For further
information, please refer to the RDS-Citrix Client Access Installation
and User Guide.
ScreenSaverPeriod=0 This parameter instructs the Symmetry screen saver to operate after
the defined period. The default is 0 seconds, indicating the screen
saver is disabled.
ServerName=SymmetryServer This is the name of the computer on which the Symmetry databases are
installed.
ShowTimeZoneCode=0 Setting this parameter to 1 will cause:
a) Alarms and events displayed at the local machine to be displayed,
by default, with the 3-letter time zone code of the local machine (e.g.
"10:13 BST").
b) The Time Zone field to appear in the Dial-Up Chain and LAN
Chain Definition screens. If you enter a time zone code in this field, it
overrides the default (the time zone code of the local machine) and is
displayed against any alarms and events associated with the dial-up or
LAN chain.
The default of 0 prevents the time zone code from being displayed.

58
Appendix A: About the .ini File Settings

StateChangeAllowed=1 If set to 1 (default), the Alarms screen is maximized when an alarm is


received. Set to 0 to disable.
StorageServerName= Specifies the name of the default Symmetry NVR, as shown in the
"Install/Video & Audio/NVR Settings" screen.
TimeZoneCardActivation= Set to 1 to allow the time offset of nodes to be taken into account when
Symmetry determines whether cards are active/inactive.
TimeZoneCode= This parameter specifies the 3-letter time zone code for the computer.
You can set TimeZoneCode to any 3-letter code. If TimeZoneCode is
blank (the default), the PC's own setting is used (e.g. "GMT"). Any
alarms and other transactions generated from hardwired chains
connected to this computer are appended with the specified time zone
code. Dial-Up and LAN chains use this setting as the default value for
the Time Zone field, which can be changed as required.
TransactionsAlwaysShowCommaInName=1 Set to 1 to add an additional ‘,’ (comma) character after the ‘Last
Name’ description displayed for card holder transactions.
TransActionUsesCardholderCompany=1 Set to 1 to filter card transactions by the card holder’s company
(instead of the company that owns the reader).
UniqueOfficial=0 When set to 1, this parameter enables an approving official with the
same last name, middle initial and first name as an existing entry to be
added in the "Setup/Identity/Approving Official" screen (default = 0).
UnlimitedFacilityCodes=1 When set to 1, this optional parameter removes any restriction on the
number of customer/facility codes (the default). A value of 0 imposes a
limit of eight customer/facility codes. Apply/change this setting only
under guidance from Product Support.
UseDirectBadgePrinting=0 This optional parameter can be used at a Symmetry client to override
the Legacy Direct Badge Printing System Preference. When set to 1,
the printer driver will be used at the client to print transparent images
on badges ("direct" printing). When set to 0, the indirect method is
used, which is independent of the printer driver.
UseOldStatusScreen=0 If set to 1, the "Home/Monitoring/Command Center" screen is non-
graphical. When set to 0 (default), the "Home/Monitoring/Command
Center" screen is the graphical version.
UseValCam=1 Set to 1 to enable the ValCam flash camera to save live images in the
Card Holder and Visitor screens.
VerticalFaceRatio=100 Specifies the vertical aspect ratio setting used when selecting the area
of a face image to use in the Card Holders or Visitors screen.
Video=DX No longer used. Leave at the default setting of "DX".

[AppSize] This section saves the window settings of Symmetry.

[BadgeDesign]
CustomColours= Records any custom colors defined when applying colors in the
"Setup/Identity/Badge Designer" screen.

59
Appendix A: About the .ini File Settings

[BioEnrolment] Include the [BioEnrolment] parameters if you want either or both of


the following:
a) A Capture button in the "Home/Identity/Card Holders" and
"Home/Identity/Visitors" screens that starts a third-party application
to enrol fingerprint, iris, facial or other biometric data. Symmetry
passes the current card number to the application.
b) The ability to import card data automatically from a text file or a
Symmetry CardTransfer database table into a card holder or visitor
record.
Note: If you want to use the CardTransfer table to import card details,
please refer to your product support representative for guidance.
Note: Using EnrollAppActive in the [multiMAX] section instead of
these settings gives alternative functionality for the Capture button.
Please refer to the description of the EnrollAppActive. Do not include
both EnrollAppActive=1 and the [BioEnrolment] section - use only
one or the other.
BioEnrolmentActive=1 Set to 1 to enable the above features.
Application= If you want to use the Capture button, specify the exe file name for the
biometric enrolment application.
Directory= Specifies the full path to the folder where the biometric enrolment
application exe file and/or import text file are located.
FileName= If you want Symmetry to automatically import card details from a text
file into a card holder or visitor record, use this parameter to specify
the name of the file. The Directory parameter specifies its location.
To use the feature:
1. Create a new card holder or visitor in Symmetry, or open an
existing card holder or visitor, and keep the record open.
2. Make sure that the text file contains the required data (see below).
3. When the file is saved, Symmetry imports the card details into the
Card Holders or Visitors screen. Symmetry uses only the top line in the
file.
4. Symmetry deletes the file.
The text file must use one of the following two formats, depending on
the card type.
a) For non-HSE or HSE legacy cards:
1,CardNumber,CustomerCodeorCredentialNumber,FirstName,
MiddleName,LastName,ExpiryDate,
For example:
1,200,999999,James,Peter,Smith,03-03-2019,
a) For HSE PIV cards:
0,AgencyCode,SystemCode,CardNumber,CredentialSeriesCode,
CredentialIssueLevel,PersonalIdentifier,OrganizationCategory,
OrganizationIdentifier,Person/OrgAssociation,FirstName,
MiddleName,LastName,ExpiryDate,
For example:
0,555,666,777,8,1,9,3,444,6,James,Peter,Smith,03-03-2019,
CommandLine=cardnumber Specifies the type of data that Symmetry passes to the biometric
enrolment application when the Capture button is clicked. Do not
change from "cardnumber" without consulting your product support
representative.

60
Appendix A: About the .ini File Settings

[BiometricReader] This section is used for the Suprema BioLite N2 biometric reader
integration (as described in the Third-Party Access Devices
Configuration and User Guide), and for Symmetry Blue mobile
devices. Apply the following setting at each Symmetry client used for
encoding.
DefaultFormat=0 This specifies the card format for encoding or card reading. Set to 0
for 62-bit, 1 for 32-bit or 2 for 63-bit format.

[Comms]
DoNotLogClocks=1 If this is set to 1, it filters out the logging of PC-to-node clock
messages in the Comms Status window. These messages are sent out
every half an hour. This parameter filters only those messages sent
from the PC on which this parameter is set.
DoNotLogEmptyAlarms=1 If this is set to 1, it filters out the logging of "no alarm" messages from
nodes attached to the PC, i.e. alarm messages will be logged to the
Comms Status window only if an alarm has been generated. This
parameter filters only those messages at the PC on which this
parameter is set.
DoNotLogEmptyEvents=1 If this is set to 1, it filters out the logging of "no event" messages from
nodes attached to the PC, i.e. event messages will be logged to the
Comms Status window only if an event has been generated. This
parameter filters only those messages at the PC on which this
parameter is set.
DoNotLogMicronodeZZs=1 This optional parameter is no longer supported.
DTRControlMode=1 This parameter specifies the DTR control mode that is being used by
the modem, which affects the string used to disconnect a call (see
"Modem Commands", next). The number used must be the same as the
number used in HostModemDTRControl (e.g. if
HostModemDTRControl is 1, DTRControlMode must be 1). Supported
values are 0, 1, 2 and 3.
FactoryInitialiseModem=&F0 This parameter specifies the string that Symmetry uses to reset the
modem to the factory default settings. The string is used when
Symmetry starts the modem (see "Modem Commands", next). Hayes
usually use &F0, and US Robotics use &F1.
FilterToFile=1 Setting this optional parameter causes any messages shown in the
Status Comms window to be logged to a text file.
HostModemDTRControl=&D1 This parameter specifies the string the modem recognizes to mean
"DTR toggle causes online command mode". If DTRControlMode is
not 0, the string is used when Symmetry starts the modem (see "Modem
Commands", next).
IssueInstrHostinit=1 This parameter specifies whether or not the modem initialization string
should be used in the command to start up the modem (see "Modem
Commands", next). The initialization string itself is specified in the
Symmetry screens (e.g. Dial-Up Chain Definitions screen) . A value of
1 causes the string to be used. A value of 0 prevents the string from
being used.
ModemSoftwareResetString=ATZ0 This parameter specifies the string used at the very end of the
command to disconnect a call (see "Modem Commands", next). The
string is used only if DTRControlMode is not set to 3.
StoreModemSettings=&W0&Y0 This specifies the string that is used to store and recall the modem's
configuration settings. The string is used when Symmetry starts the
modem (see "Modem Commands", next).

61
Appendix A: About the .ini File Settings

Modem Commands

Command issued by Symmetry to start the modem (command issued when Symmetry starts):
+++ATH AT{FactoryInitialiseModem} AT{Initialization String in Symmetry screen}{HostModemDTRControl} AT{StoreModemSettings}

Command issued by Symmetry to connect a call:


+++ATS0=0S7={"Wait for Answer" Setting in Symmetry screen}DT{phone number} If DTRControlMode = 0
ATS0=0S7={"Wait for Answer" Setting in Symmetry screen}DT{phone number} If DTRControlMode = 1, 2 or 3

Command issued by Symmetry to disconnect a call:


+++ATH {ModemSoftwareResetString} If DTRControlMode = 0
ATH {ModemSoftwareResetString} If DTRControlMode = 1 or 2
ATH If DTRControlMode = 3

ViewAllLANAlarms=1 This optional parameter is read if the ini file is on a PC that has a
LAN chain port (i.e. the PC is used for communications with LAN
chains). It can be used to filter "LAN..." alarm/event messages that are
generated when connecting to the LAN chains (e.g. LAN Retry). 0 =
Discard all LAN messages; 1 (default) = Discard all LAN messages
except "LAN Error" and "LAN Failed Connection"; 2 = Discard all
LAN messages except "LAN Error", "LAN Failed Connection" and
"LAN Retry"; 3 = Discard no LAN messages.

[Control] The [Control] section is required by the Controls options. ControlID


must be set to 1 if a Commend 416 system is used, or 3 if a Commend
200/700 system is used.
[Transaction Service]
TimeZoneCode= Specifies the time zone code of the transaction service. This parameter
should be set to the same value as the parameter with the same name
in the [SupportService] section.

[Cropping]
FaceCropping=0 If set to 1 a cropping rectangle is displayed after freezing a live face
image in the Card Holders screen. The coordinates of the rectangle
are given next.
FaceLeft=67 These specify the coordinates of the face cropping rectangle.
FaceRight=228
FaceTop=104
FaceBottom=318
SigCropping=0 If set to 1 a cropping rectangle is displayed after freezing a live
signature image in the Card Holders screen. The coordinates of the
rectangle are given next.
SigLeft=61 These specify the coordinates of the signature cropping rectangle.
SigRight=379
SigTop=121
SigBottom=280

[Custom]
PhoneNumberFormat=99999999999999999999 Do not change; engineering use only.
RemoteIPAddressFormat=999-999-999-999 Do not change; engineering use only.

62
Appendix A: About the .ini File Settings

[EnrollApp] The [EnrollApp] parameters are relevant only if EnrollAppActive is set


to 1 in the [multiMAX] section.
Application= This specifies the exe file name for the biometric enrolment
application. When the Capture button is clicked, the application starts
with the following parameters:
-enrollf FirstName LastName CardNumber
Where FirstName LastName CardNumber are the details from the
card holder currently being displayed.
Directory= Specifies the full path to the folder where the biometric enrolment
application exe file is located.

[G4TDigitalVideo] This section saves the Video Management settings.

Bosch.IPCameraMotionAlarmInterval=15 This controls the time between motion events from a Bosch IP
camera. If, for example, it is set to 15 (the default), continual
motion in front of the camera creates a "Motion Alarm" every
15 seconds, and 15 seconds after the final motion is detected, a
"Motion Normal" alarm is generated.
Matrix.DisableLoadLastView=0 When set to 1, this optional parameter prevents the Virtual Matrix
screen from loading the last-used view when the screen is opened.
matrix.DisableMatrixBalloonWarnings=1 Set to 1 to enable pop-up balloons in the Virtual Matrix screen.
NVRCameraLimit=128 Specifies the maximum number of cameras that can be assigned to an
NVR in the "Install/Video & Audio/NVR Cameras Assignment" screen
(default 128).
Panasonic.NTEventLogging=0 When set to 1, this enables Windows application event logging for
offline Panasonic IP cameras.
Panasonic.Alarm.Notification.Port=1818 Specifies the default alarm port used by Panasonic IP cameras
(Symmetry server).
Panasonic.IPCameraMotionAlarmInterval=30 This controls the time between motion events from a Panasonic
IP camera (see the equivalent Bosch setting above).
PopupWindowCount=72 Specifies the maximum number of separate windows that can be
displayed when Live Video is selected from camera icons in the
"Home/Monitoring/Graphics" screen. Live video is displayed in
separate windows (rather than the Virtual Matrix) only if enabled in
the client preferences.
StreamingRecordingMaxRetryCount=1 Specifies the number of times that Symmetry attempts to reconnect to a
camera after it has been disconnected.

[global] Use at a region on a Global Edition system.

TransferGlobalCardActivityToHO=1 By default (set to 1), the region uploads to the head office all card
events associated with card holders who have global access rights. Set
to 0 to block uploading of these messages to the head office.
TransferLocalCardActivityToHO=1 By default (set to 1), the region uploads to the head office all card
events not associated with card holders who have global access rights.
Set to 0 to block uploading of these messages to the head office.

[Graphics]
GraphicNameEqualsFileName=0 When set to 1, this optional parameter causes the Filename field in the
"Setup/Graphics/Add" screen to be automatically set to the graphic
filename.

63
Appendix A: About the .ini File Settings

[GraphicsAlarmView]
Treewidth=180 For engineering use only; do not change.

[Intrusion]
PanelLanguage=0 Set to 0 if a Norwegian DSC4030 intrusion panel is used, or to 1 if a
Swedish panel is used. This ensures the correct characters in area and
zone names.
PollClearAlarmListTimer=0 Include this parameter and set to 0 only if HISEC ThorGuard panels
are being used and operators need to perform bulk clearing of alarms.
RoundTripMessageEnabled=1 Set to 1 if you are using ThorGuard GPIs with a firmware level of
v0102.006 or above. Otherwise, set the parameter to 0 or do not
include it. If set, the parameter improves upload performance when the
ThorGuard CU has a large number of devices, and corrects the
operation of the zone icon in graphics.
StatusPollTimeout=xx Specifies the poll time (in seconds) for ThorGuard devices when Full
Status Updates is selected in the "Install/Intrusion/Intrusion/System
Configuration" screen. This setting helps performance on sites with
many panels.
TGMSV354+=1 Set to 1 if ThorGuard Management System (TGMS) Version 3.5.4 or
above is used.
V6ThorguardCU=1 Set to 1 to enable upload from a ThorGuard V6 (Firmware) system.
Set on the client that has the connection to the ThorGuard panel.

[Recent File List] Added by Windows; ignore.


File1=COM2
File2=COM1

[Salto]
ShowSaltoMessages=1 By default (set to 1), a "Salto system is offline" message is displayed
when opening a card holder or visitor if the SALTO system is not
reachable (e.g. the SALTO system has been removed or has not been
started before Symmetry). Set to 0 to disable the message.
[Scheduler]
DHMP=1 Days/Hours/Minutes Processor. This is the scheduler for activity that
occurs on a timed basis, e.g. scheduled commands at the server and
timed reports at each client. Setting it to 0 disables such processing.
Setting to 1 enables processing.
DLP=1 Download Processor. This server-only parameter should normally be
set to 1. If set to zero, nothing is downloaded to nodes. This could be
useful to prevent downloading until the system is configured.
DTA=1 Server-only setting for engineering use only; do not change.
NSP=1 Node Status Processor. If set to 1, the PC will automatically download
data to a node if the node reports that its database is broken. This is
normally set to 1 on all PCs having comms.
RSSPUP=0 This is a server-only parameter. It is set to 1 if Run System Timed
Commands on Power Up was selected during installation.

64
Appendix A: About the .ini File Settings

[Shell]
ClearNetworkTable=0 Must be set to 0 for a standalone system. Set to 1 if you wish to clear
the network locking table (actioned when Symmetry is started). This
must be set at the server only when the application has been shut down
at all clients. Set back to zero when the operation is complete.

[SmartCard]
EncoderType=5 This specifies the smart card encoder type and must not be changed
from the default value of 5 (HID encoder).
DESFireEncoding=0 Reflects the last state of the DES Fire Encoding option in the Encode
a Smart Card screen; 1=set; 0=unset
UserPINEncoding=0 Reflects the last state of the User PIN Active option in the Encode a
Smart Card screen; 1=set; 0=unset.
CustomCards=Hisec This parameter makes available the Hisec format in the Encode a
Smart Card screen. The parameter must be set on each Symmetry
client that is going to be used to encode cards using the Hisec format
(on a DTC4xxx printer).
DefaultSector=1 This should be set to 1 at the Symmetry server when encoding Hisec
format cards on a DTC4xxx printer. For further information, please
refer to your product support representative.
DefaultFormat=6 This should be set to 6 at the Symmetry server when encoding Hisec
format cards on a DTC4xxx printer. For further information, please
refer to your product support representative.

[SupportService]
TimeZoneCode= Specifies the time zone code of the support service. This parameter
should be set to the same value as the parameter with the same name
in the [TransactionService] section.

65
B. Appendix B: Windows Security Groups

Groups Used by Symmetry


Symmetry uses "ACSUsers", "ACSServices" and "ACSReporting" groups, as described in the
following sections. For a domain, the groups must be in the Active Directory.
Note: If you are using a domain, you can create equivalent groups named as you wish, and during the
installation of Symmetry, choose the groups to use for ACSUsers, ACSServices and ACSReporting.
Note: The groups are automatically added as logins to the SQL database. This enables Symmetry users
or services to access the database with the correct permissions.

ACSUsers
This is used to provide the privileges necessary for a user to use the Symmetry client software. The
group requires the following privileges:
Access this computer from the network
Bypass traverse checking
Allow log on locally
Shut down the system
Workgroup Installations
If you install Symmetry in a workgroup, the installation process automatically creates ACSUsers
on the Symmetry server. Any user who needs to use the Symmetry client software must be
assigned to the ACSUsers group.
Domain Installations
If you install Symmetry in a domain, a domain administrator will need to create ACSUsers before
you install Symmetry.
Any user who needs to use the Symmetry client software must be assigned to the ACSUsers group;
this can only be carried out by a domain administrator.

ACSServices
This is used by the Symmetry services on the Symmetry server and uses the following privileges:
Log on as a service
Access this computer from the network
Deny Log on locally.
Workgroup Installations
If you install Symmetry in a workgroup, the installation process can automatically create an
ACSServices group on the Symmetry server. The account you select for the Symmetry services
(page 21) is automatically assigned to the ACSServices and the local Administrators groups.
Domain Installations
If you install Symmetry in a domain, a domain administrator will need to create ACSServices and
assign the Symmetry services account (page 21) to ACSServices before you install Symmetry. The
account is automatically assigned to the local Administrators group.

66
Symmetry Software Installation Manual

ACSReporting
This gives read-only access to SQL Symmetry reporting views, which may be of use to reporting
applications such as the Symmetry Advanced Reporting Tool. It provides no direct access to data
through the database tables and requires no specific privileges to be set up. Configure with minimal
privileges.

Appendix B: Windows Security Groups 67


C. Appendix C Badge Printer Setup

This appendix describes how to set up the printer drivers for badge printers.

Fargo HDP5000 Driver Setup


To install the printer:
1. If the printer has a MIFARE USB Encoder,
unpack the 5x2x encoder driver by double-
clicking the appropriate exe file located in the
Symmetry\Extras\Cardman 5x21 Drivers folder
on the Symmetry installation media.
2. Install the printer driver using the media supplied
with the printer. Follow the on-screen
instructions. If you are given the opportunity,
select the driver unpacked in step 1. Otherwise,
update the driver as documented in the readme
file in the driver folder.

Once installed, right-click on the printer in the


Windows Control Panel and select Printing
Preferences. The settings shown opposite are
recommended.

Check the other tabs to make sure the settings are as


required.

For smart-card encoding, set up a Smart Card


Encoder port using the "Install/System/Client Ports"
screen in the Symmetry software. Choose the USB
port type.

The Encoding Mode in the Magnetic Encoding tab


can be left at the default of ISO Encoding or set to
RAW Binary Encoding. If the ISO Encoding is
used, LegacyFargoPrinter must be set to 1 in
multimax.ini. If RAW Binary Encoding is used,
uncheck Reverse Bit Order for Track 1 and 2 in the
Encoding tab and set LegacyFargoPrinter to 0 (the
default).

Note: Make sure that the windows name of the


printer includes the name "Fargo" (the same default
name specified in the fargoprinter= multimax.ini
setting). Also set EncoderType=5 for this printer
type.

68
Appendix B: Badge Printer Setup

Fargo DTC4250e/4500/4500e Driver Setup

To install the printer:


1. If the printer has a MIFARE USB Encoder,
unpack the 5x2x encoder driver by double-
clicking the appropriate exe file located in the
Symmetry\Extras\Cardman 5x21 Drivers
folder on the Symmetry installation media.
2. Install the printer driver using the media
supplied with the printer. Follow the on-
screen instructions. If you are given the
opportunity, select the driver unpacked in step
1. Otherwise, update the driver as
documented in the readme file in the driver
folder.

Once installed, right-click on the printer in the


Windows Control Panel and select Printing
Preferences. The settings shown here are
recommended.

Check the other tabs to make sure the settings are


as required.

For smart-card encoding, set up a Smart Card


Encoder port using the "Install/System/Client
Ports" screen in the Symmetry software. Choose
the USB port type.

See the next page for magnetic encoding options.

Note: Make sure that the windows name of the


printer includes the name "Fargo" (the same
default name specified in the fargoprinter=
multimax.ini setting). Also set EncoderType=5 for
this printer type.

69
Appendix B: Badge Printer Setup

In the Magnetic Encoding tab, select RAW


Binary Encoding and uncheck Reverse Bit Order
for Track 1 and 2. LegacyFargoPrinter must be
set to 0 (the default) in multimax.ini.

70
D. Appendix D: Port Usage

This appendix lists the standard ports used by Symmetry. This information may be needed to configure
routers, firewalls or port forwarding.

Standard Ports for General Microsoft Software

The following general Windows ports are used by all Symmetry computers.

Purpose Port Type Communications Direction


139 TCP IN and OUT
445 TCP IN and OUT
Microsoft file/printer sharing (if used)
137 UDP IN and OUT
138 UDP IN and OUT
DNS, Domain Name System (required if a TCP &
53 OUT
domain is used) UDP
NETBIOS (Name Resolution) 137 UDP IN and OUT
Windows Time Service (for time
123 UDP OUT
synchronization)
MSMQ (MS Messages Queue service).
TCP &
These ports are needed for Symmetry 1801 IN and OUT
UDP
machines to host MSMQs
MSMQ (MS Messages Queue service). This
port is used for the internal "ping"
mechanism for Message Queuing.
Note: For Message Queuing 4.0 and later,
3527 UDP IN and OUT
UDP port 3527 is no longer used by default.
For more information, visit:
http://technet.microsoft.com/en-
us/library/cc731882(WS.10).aspx
RPC (needed by DCOM, DTC, MSMQ,
Cluster). Dynamic RPC port typically
assigned by RPC for handshaking with an
135 TCP IN and OUT
independent client or with an RPC server for
the Message Queuing server to determine
the fixed ports.

71
Appendix D: Port Usage

Microsoft SQL Server


Note: The following specifies the default ports; SQL Server may be set up to use different ports than
those specified below.

Purpose Port Type Communications Direction


Microsoft SQL Server - Port on computer
1433 TCP IN
that runs Microsoft SQL Server
Microsoft SQL Server Browser - Port on
computer that runs Microsoft SQL Server, 1434 UDP IN
for SQL Server Browser
Microsoft SQL Server - Port on Symmetry
client or NVR, or on the Symmetry server if 1433 TCP OUT
a separate database server is used
Microsoft SQL Server Browser - Port on
Symmetry client or NVR, or on the
1434 UDP OUT
Symmetry server if a separate database
server is used

Symmetry Node/Device/Client Communications

Purpose Port Type Communications Direction


Port on Symmetry server for Symmetry
12090 TCP IN and OUT
client messaging
Port on any Symmetry computer that uses OUT; also IN if node
3001 TCP
network communications to nodes instigates communications
Port on any Symmetry computer that
IN (used only when nodes are
receives network communication initiated
3002 TCP configured to instigate
by a node (commonly referred to as "Node
communications)
Punch-Out")
Port on any Symmetry computer from which
TCP &
the G4S Flashnet utility or device discovery 49107 IN and OUT
UDP
(Discover button) is used

Emails
The following default ports are used by Symmetry for any option that send information via email (such
as email alarms and workflow emails).

Purpose Port Type Communications Direction


Port on Symmetry server or client for SMTP
25/587 TCP &
emails (configurable in the "Setup/ OUT
/465 UDP
Configuration/Email Profiles" screen)

RDS/Citrix Access
(See the RDS/Citrix Client Access Installation and User Guide.)

Purpose Port Type Communications Direction


Port on web server used for Remote Desktop
3389 TCP IN
Services

72
Appendix D: Port Usage

Port on web server used for non-encrypted


80 TCP IN
(HTTP) communications from clients
Port on web server used for encrypted
443 TCP IN
(HTTPS) communications from clients

Symmetry NVR

Purpose Port Type Communications Direction


NetBIOS 137 UDP IN and OUT
6456-
RTP video traffic UDP IN
7456
Real-Time Streaming Protocol traffic 554 TCP IN
HTTP traffic 8080 TCP IN

Video

Purpose Port Type Communications Direction


Port on Symmetry server used for
1433/
communications from Integral DSXpress TCP IN
1434
and DSRealvue Xpress DVRs
Port on any Symmetry client used to play 6456-
UDP IN
back video (RTP traffic) 8457
Microsoft Universal Plug and Play; 2869 TCP IN and OUT
primarily used for the discovery of ONVIF
video cameras 1900 UDP IN and OUT

Bosch Cameras
The following ports are used at a Bosch camera. The integration uses the RCPP.DLL third-party SDK
runtime file.

Purpose Port Type Communications Direction


Firmware upload and TCP tunneling via
80 TCP IN
HTTP
Encrypted communication via SSL 443 TCP IN
RCP+ communication 1756 TCP IN and OUT
Network scan target 1758 UDP IN
Network scan response 1759 UDP OUT
Multicast network scan target 1900 UDP IN

Panasonic Cameras
The following ports are used at a Panasonic camera. No third-party SDK runtime files are used.
Panasonic cameras use HTTP calls only.

Purpose Port Type Communications Direction


HTTP 80 TCP IN

73
Appendix D: Port Usage

Alarm notifications 1818 TCP IN and OUT


Device discovery response 10669 UDP OUT

Sony Cameras
The following ports are used at a Sony camera. The integration uses the SNCSTRM.DLL and
SONYNETWORKCAMERA4.DLL third-party SDK runtime file.

Purpose Port Type Communications Direction


HTTP 80 TCP IN
Device discovery response 4000 UDP OUT

Symmetry Cameras
The following ports are used at a Symmetry camera. The integration uses the IPADMINTOOL.DLL
third-party SDK runtime file.

Purpose Port Type Communications Direction


HTTP 80 TCP IN
RTSP 554 TCP IN
Alarm notifications (two consecutive ports,
3000-
one for RTP and one for RTCP are required UDP IN and OUT
32001
per camera)
Device discovery response (via
5353 UDP OUT
IPADMINTOOL.DLL)
Broadcast of events generated by the
camera (75xx HD camera and 79xx HD 2555 TCP OUT
encoder)

Microsoft Clustering
(See the Cluster Installation Manual.)

Purpose Port Type Communications Direction


Cluster Services 3343 UDP IN and OUT

NEC Clustering
(See the Cluster Installation Manual.)

Purpose Port Type Communications Direction


For Symmetry remote registry access during
install, and Symmetry registry key
synchronization. (Other ports need to be 445 TCP IN and OUT
opened for NEC clustering - please refer to
the NEC documentation.)

74
Appendix D: Port Usage

SALTO Interface
(See the Disconnected Doors Installation and User Guide).

Purpose Port Type Communications Direction


Port on Symmetry server used by the
20001 TCP IN
SALTO server to send messages.
Port on SALTO server used by Symmetry to
20000 TCP IN
send messages.

XML Open Integration


(See the XML Open Integration Module Installation and User Guide.)

Purpose Port Type Communications Direction


Port on the Symmetry server used for XML
65101 TCP IN
Open Integration

75
E. Appendix E: Restoring Symmetry

This appendix describes how to restore the Symmetry server and/or database in the unlikely event of,
for example, a disk or other fault. See page 33 for general detail of backup configuration.

Restoring Symmetry and SQL Server


The following describes how to replace the Symmetry and, if required, SQL Server software in the
extremely unlikely event that it is necessary to do so.
1. Shut down Symmetry at the Symmetry server and at all clients.
2. Log in as an Administrator at the Symmetry server.
3. Note the drive and installation folder of Symmetry (default folder is "Security Management
System" in Program Files).
4. Remove Symmetry (see page 41). If you are using SQL Server Express, choose to remove the
database and, if required, SQL Server Express during the uninstall process.
5. If you are using a full version of SQL Server and want to remove and reinstall it, do so now.
6. Re-install Symmetry using the same location as noted in step 3 (paths specified in the ini file at
clients will need to be changed if a different installation folder is used). Check that Symmetry is
functioning correctly before restoring the previous database (as described next).

Restoring the Symmetry Database


The following describes how to restore the Symmetry database from a backup. Note: It is not
necessary to replace Symmetry or SQL Server first.
1. Shut down Symmetry and all services prefixed by "Symmetry" at the Symmetry server and at all
clients.
2. Log in as an Administrator at the server that contains the database.
3. Copy the databases from the backup media to the computer that contains the Symmetry database.
4. Make sure that the SQL Server service is running, start SQL Server Management Studio (if not
already installed, available from the Microsoft web site), then open the server followed by the
Databases tree.
5. Right-click on the multiMAX database, select Tasks, Restore, Database. Select Device, then
click the browse (...) button. In the dialog displayed, click Add, then select the backup file. Click
OK twice to return to the Restore Database dialog. Select the backup.
6. Select the Options page on the left side of the dialog, then select Overwrite the existing database.
7. In the Files page, check the paths displayed. These must match the path to the Data folder used by
SQL Server (by default, Program Files\Microsoft SQL Server\<...InstanceName>\Data). If these
paths are not correct, click and edit the paths. Make sure that the drive letter is correct.

76
Appendix E: Restoring Symmetry

8. Click OK in the Restore Database dialog to begin the restore process. If the restore fails, make
sure that the Symmetry services are stopped and try again.
9. Repeat steps 5 to 8 for the multiMAXTxn database.
10. Close SQL Server Management Studio.
11. Insert the Symmetry installation media and wait for the installation wizard to start. If it does not
start, double-click Setup.exe, which is located in the top-level folder of the media.
12. Follow the prompts. Choose the Repair option when prompted.
13. Start the Symmetry services. Symmetry is ready for use.

77
F. Appendix F: Symmetry Performance
Tuning and Maintenance

This appendix describes how to improve the performance of Symmetry. It explains key factors to
consider before installing Symmetry, and gives advice on the routine tasks to implement on an
installed system to maintain system performance.

Pre-Installation Tuning
Note: It is essential to plan and test the performance of the system before going "live". Network
performance, SQL/network monitoring tools, antivirus software, operational usage, use of VMware®
and other site-specific factors can affect performance and therefore may require changes to system
requirements or infrastructure to achieve performance expectations. Large deployments must be
planned with the local AMAG support representative.
The following sections give advice about other factors to consider before installing Symmetry.

Network Speed
A minimum 1Gbit network is recommended, with good quality network hardware.

SQL Server
Sharing an SQL Server Database Machine
It is allowable for third-party SQL-Server applications to share the same database server as Symmetry.
However, before implementing this architecture, it is important to assess whether excessive resources
could be removed from Symmetry and therefore compromise Symmetry's performance.
Determine which third-party applications would use the same database server and their use of that
machine. Symmetry uses the database extensively at times when there is a very large number of card
transactions, and at times when the database is being backed up or when an operator is accessing large
amounts of data. Consider whether other applications' use of the database at these times could
adversely affect Symmetry, and if that is the case, consider alternative architectures.

Network Performance when Using a Separate Database Server


Using a separate database server for Symmetry can significantly reduce transaction throughput if there
are issues with the performance of the network. Examples such as using a Wide-Area Network
(WAN), sharing network paths with other data-intensive applications or using sub-optimal network
components can reduce the bandwidth available to Symmetry, and increase latency and packet loss.
Before installing Symmetry, assess the network components and architecture, and the times that the
network is most heavily used. If necessary, upgrade components or change the architecture to reduce
the possibility of compromising Symmetry's performance.

78
Appendix F: Symmetry Performance Tuning and Maintenance

SQL Server Memory Limit


In order to avoid SQL Server from taking too much memory away from the operating system and
services, the Maximum server memory setting should be configured in the SQL Server Properties:

The setting will depend on the amount of RAM available at the server and the requirements of the
operating system. In addition, if the Symmetry server and SQL Server use the same machine, it is
theoretically possible (but very unlikely) for each Symmetry service to consume a maximum of 2GB,
and there are 7 Symmetry services.

Database Growth Setting


If Symmetry is being upgraded from a version earlier than version 9.3.0, it is recommended that the
database growth setting for the MultimaxTxn database is set to 200Mb to avoid the possibility of SQL
Server needing to resize the database frequently. The default in earlier versions is much lower, but
cannot be adjusted during a Symmetry upgrade.

SQL Server Hardware


It is recommended to use fast storage for SQL Server machines. Preferably, this should be RAID1+0,
compromising of 10k SAS drives or server-grade solid-state drives. RAID1+0 is preferred, as it is a
combination of mirroring and striping, which offers the best performance and resiliency.

RAID Array Write Caching


Write caching should be enabled on all RAID arrays. It is recommended to purchase a RAID card that
contains a battery-backed cache, and install dual power supplies on the server, with suitable
uninterruptible power supplies and surge protection to prevent loss of data should a power outage
occur.

Replicated/Mirrored Installations
Before commissioning an SQL server used by Symmetry in a replicated/mirrored environment,
consider:
 The network link between the replicated/mirrored devices. Make sure the network components
are of high quality and that the network has sufficient bandwidth.
 The Symmetry transaction throughput. Installations that have a large number of transactions
will require superior hardware.
 The speeds of the disks, particularly with respect to the Symmetry transaction throughput and
the product used for replication/mirroring (please refer to the manufacturer's documentation).
 Whether to use asynchronous or synchronous replication/mirroring:
Asynchronous mirroring/replication − This gives faster transaction throughput, since the
replication does not wait for the previous write operation to complete prior to starting the next

79
Appendix F: Symmetry Performance Tuning and Maintenance

one. As a consequence, however, this configuration is less resilient, since loss of transactions
could occur on hardware failure.
Synchronous mirroring/replication − Depending on link speeds between the replicated
servers, slower transaction throughput can be experienced, since each write operation needs to
be completed before the next is replicated. However, this is considered a more resilient
solution.

Post-Installation Symmetry Maintenance


This section gives advice on how to maintain Symmetry to achieve best performance.

Symmetry Machines
Daily:
 Check for any build-up of messages in the Symmetry MSMQ queues on the Symmetry server.
The Number of Messages column should be zero when the queue is empty (typically at quiet
periods of the day). If a queue has a large number of messages, check that nodes are online, the
Symmetry services are running, network connections, and any other reasons why
communications may be interrupted.
Weekly:
 Review and correct any hardware errors. These include errors reported by S.M.A.R.T. (Self-
Monitoring, Analysis and Reporting Technology), or CPU, memory and other errors reported
by the server hardware.
 Check that all drives in use on the Symmetry server have at least 20% of free space.
Monthly:
 Visit the AMAG partner web site to determine whether any Windows patches are on the
approved updates list, and if so, install them.
 Using the Windows Event Viewer, review the Application and System logs on the Symmetry
server, and check for any Symmetry-related errors. If any errors are found, determine and
correct the problem.
When experiencing a large influx of transactions, the error "System Warning Message:
Insufficient resources to perform this operation" can occur if the available storage used by
message queuing reaches the default limit (typically 1048576kb). If this happens, message
processing may become slower. The limit can be increased by opening the Computer
Management window, and in the properties of a queue, increasing Limit message storage to
and Limit journal storage to).
 If there are performance issues, use the Windows Resource Monitor to view disk activity on
the Symmetry server, and on any Symmetry clients that host communication to nodes. In the
Windows Resource Monitor, click the Disk tab and view Processes with Disk Activity):

Ideally, the disks should maintain an average queue


length value of 2 or below.

Periods where the queue length is greater than 2 may


occur depending on disk activity, but an average of 2 or
below is recommended for best performance.

If the value is consistently greater than 2, investigate the


performance issues with your RAID/disks.

80
Appendix F: Symmetry Performance Tuning and Maintenance

Microsoft SQL Server


Weekly:
 Ensure that backups are being taken as configured.
 Check that sufficient free disk space is available on the device used to back up the Symmetry
databases.
Monthly:
 Review the SQL error logs for errors, and correct any found. By default, these are stored in
Program Files\Microsoft SQL Server\MSSQL.1MSSQL\LOG\ERRORLOG. If the error
message does not contain a clear correction method, search online for the error message.
 Visit the AMAG partner web site to determine whether any SQL patches are on the approved
updates list, and if so, install them.

Symmetry Operation
Daily:
 Generate a report from the "Reports/History/Activity" screen. Look for hardware alarms such
as "Offline", "Node Timed Out" and "Client/Server Offline" and correct any hardware issues
found. Also review the report for alarms such as "Door Forced", or other events considered
outside the normal company processes. This will indicate any abnormal activity.
 If applicable, check that video is being recorded.
Weekly:
 Remove any unwanted card holder or visitor records, and any access rights that are no longer
in use (e.g. time codes, access codes, reader groups, etc.). There may be other internal policies
that determine when these tasks take place.
 Generate a report from the "Reports/History/System" screen and look for abnormal events.
Other reports such as the User Audit, Activity and Predefined reports may be helpful to
identify abnormal activity.
Monthly:
 Check the Symmetry error logs in the ProgramData\Security Management System\Log Files
folder and check for any errors. If any errors are found, determine and correct the problem.
 Remove any unwanted trigger and scheduled commands.
 Review or modify any holidays defined in the "Operation/Times/Holiday" screen. Note that
holiday periods can affect access rights, trigger commands and scheduled commands.
Yearly:
 Review the feature set of the latest version of Symmetry and determine whether an upgrade is
required. The assessment should include a review of whether the operating system and SQL
server need to be upgraded.

Cluster Operation
Weekly:
 Review the NEC or Microsoft cluster logs to confirm that system replication can occur and
that there are no error messages.
Monthly:
 Fail over the system to ensure that the system is working properly.

81
Appendix F: Symmetry Performance Tuning and Maintenance

Example Maintenance Schedule


Note: The items and intervals shown in the following table are recommendations. Specific
maintenance schedules should be set up to meet system and site-specific needs.

Maintenance Item Description Daily Weekly Monthly Annually

Symmetry Machines

Monitor MSMQ queues X

Review and correct hardware errors X

Check drives for free space X

Visit the AMAG partner web site and install approved updates X

Use the Event Viewer to check the Application and System logs X

Use the Resource Monitor to check disk queue length X

Microsoft SQL Server

Ensure backups are being taken X

Check backup device has sufficient free disk space X

Review SQL error logs X

Visit the AMAG partner web site and install approved updates X

Symmetry Operation

Review a Reports/History/Activity report X

If applicable, check that video is being recorded X

Remove unwanted card holder or visitor records X

Review a Reports/History/System report X

Check the Symmetry error logs X

Remove any unwanted trigger and scheduled commands X

Review holidays X

Review Symmetry feature set X

Cluster Operation

Review the NEC or Microsoft cluster logs X

Fail over the system to check operation X

82

You might also like