KapLogic Aegis2.2x Installation Manual

Aegis2.2x™ Installation Manual

Version 1.2.0 –01/05/10

PO Box 3159
Littleton, Colorado 80161

Sales: 720.283.7501
[e-mail]

Support: 417.485.2203
[e-mail]

Developing the Next Generation of Security Integration Products

About This Document

This manual covers both the decisions that should be made prior to installing Aegis2 and the process of installing
the Aegis2 software.

Who Should Read This Document

This document should be read by all parties involved in the Aegis2 install prior to the actual install occurring.
Information in this manual may need to be shared with the IT department of the company where the install is
being done and the particular permissions, settings, and sharing rights need to be verified or obtained before the
install occurs.

Symbol Key

All symbols will appear on the left side of the page next to their notification.

Information you should know to avoid potential problems.

Information you MUST know before continuing in order to avoid problems of a serious or catastrophic
nature.

Additional information provided, either in another part of this document, or from external sources
(other documents, web sites, etc.).

Aegis2.2x Installation Manual

It is highly recommended that you read this entire document before installing any of Aegis2’s
components. Important choices will need to be made regarding how and where the installation is to
occur. Some of these decisions may require assistance from other departments in your
organization, as well as being extremely difficult to change once installation has occurred. If you
have any additional questions regarding installation, please contact KapLogic at [phone] or
[e-mail] for assistance.

1.0 Considerations Prior to Installing

1.1 SQL: Version and Location

Aegis2 uses a Microsoft SQL database for storage of data. SQL 2005 Express is included with the Aegis2
installation CD and is free to use. If SQL 2005 Express is installed as part of the Aegis2 installation, then
the defaults for the Aegis2 database will be installed automatically. No further configuration of the
database is required.

If you are already running SQL on a separate server, then the Aegis2 database can be installed by
using SQL to restore the Aegis2 database into that existing SQL installation. Microsoft SQL 2000 and
2005 are both currently supported, and the database file Aegis220Model.bak from the db folder on the
install CD is provided for both versions (SQL2000 – db\Content\SQL2000\aegis220Model.bak, and SQL
2005 – db\Content\SQL2005\Aegis220Model.bak).

If this file is being installed onto an existing SQL server, then it is recommended that a member of your
IT staff be present and have the appropriate permissions to restore the database. Additionally,
permissions will need to be given to the User Group so that they can access the Aegis2 database, or a
user needs to be created that has ownership to the Aegis2 database and the Aegis2 stored procedures.

1.2 Aegis2 Database Location

The location of the Aegis2 database is an important decision that needs to be made prior to installation.
While the database can be installed on most any computer on a network, exactly where it resides brings
up issues regarding availability and back-ups.

Aegis2.2x Installation Manual

1

The supported installation model providing the most reliability is the one pictured below, where the
database is installed on a separate server (this can be a shared server) with all workstations pointed to it
for access. In this installation model, if any individual workstation is offline, it will not affect the remaining
workstations.

Considerations for this type of installation are that the workstations will need to have network access to
the database server, as well as be provided with any permissions needed to access the server and the
database.

Aegis2.2x Installation Manual

2

As a second option, the Aegis2 database can be installed on a workstation with any additional
workstations pointed to the database, as shown below.

The primary issue in this installation model is that if the workstation where the database resides reboots
or is offline for any reason, the other workstations have no access to the database. Aegis2 cannot
function without access to the database, so the entire system would be offline until the workstation with
the database is brought back online.

1.3 Aegis License Server: Install Models and Location

If you are planning to run your installation of Aegis2 in License Server Mode, it is essential
that you set this up in the Management Console BEFORE you start registering drivers,
setting up connections, and placing icons. If you switch from Local HASP Mode to License

Server Mode after you have taken those steps, you will need to repeat them. The steps

involved in setting this up are covered in Section 3, Steps B-F.

In License Server Mode only one HASP key is needed, as it authorizes however many concurrent
connections of Aegis2 were purchased for the system. No matter how many workstations have the
Aegis2 software installed, only the authorized number of workstations will be able to run the Aegis2
software at any one time. Any workstations beyond that number will not be able to run the program until
another one logs off.

The Aegis License Service and the Management Console will both need to be installed on whatever
computer will be acting as the License Server. The Management Console is used to configure the
settings for License Server Mode, and is therefore a necessary component.

There are two different models of how License Server Mode can be set up on your network. Much like
the models for the database covered previously, how this is installed can raise issues of availability.

Aegis2.2x Installation Manual

3

The supported model for running License Server Mode, as shown below, is to use a separate server
(this can be a shared server) for the location of the Aegis License Service, Management Console, and

HASP key. All workstations in this installation would then be configured to receive authorization for the

program and approval for access to any external equipment working with Aegis2 from the server running
the Aegis License Service.

In such an installation, the server will need to have an accessible USB port for the HASP key. Virtual
ports can be used, but it is the responsibility of the client to configure the software and have the virtual
port working prior to the installation of the Aegis License Service.

Additionally, all workstations need to be configured and have network access to the Aegis License

Service on the server, as well as have any necessary permissions that may be needed to access the

server.

Aegis2.2x Installation Manual

4

In the second installation model, the Aegis License Service, Management Console, and HASP key
are all installed on one of the workstations, as shown below. This workstation will act as the authorizing
agent for any other workstations running Aegis2 on the network, as well as providing approval for access
to any external devices.

All the other workstations will need to have access to this one in order to work. If the workstation
running Aegis License Service is restarted or otherwise taken off-line, then none of the other
workstations on the network will function until it is brought back online. Lacking authorization from the

Aegis License Service, Aegis2 will not allow users to log into the program.

If you are not running the Aegis2 programs in License Server Mode, then the other option is Local

HASP Mode. In this mode each workstation will have its own HASP key, and will be pointed to any

additional servers or equipment via the network. This model is represented below:

Aegis2.2x Installation Manual

5

With its own HASP key, each workstation is authorized to run Aegis2, and a workstation that is
restarted or taken offline will not affect the others on the system.

1.4 Installing Services on a Server

Occasionally a driver used by the Aegis2 software will have an independent service that aids in
communicating with external hardware. These can be installed on either a workstation or a server (this
can be a shared server). Much like the database, consideration needs to be given to the availability of the
service if it is installed on a workstation. If it is to be installed on a server, all workstations will need to be
configured to have network access, as well as the necessary permissions to access that server.
Additionally, a member of the IT staff will need to be present and have appropriate permissions to install
and configure the service, if necessary, on the server.

1.5 Data Execution Prevention (DEP)

It has been found that Windows Server OS’s often have Data Execution Prevention (DEP) defaulted to

Enabled, which can cause problems with Aegis2 and it’s components. Disabling DEP will prevent these

issues, if the client does not have a problem with this option. You will need to disable DEP and restart the
server for this to take effect. If disabling DEP is not an acceptable option, then any .exe files in the Aegis2
folder will need to be added to the Exceptions list for DEP. Aegis2 should run without incident once
these exceptions have been added.

1.6 Running Aegis2 on Redundant Servers

If redundant servers with failover software (EMC, Marathon, etc.) are being utilized, it is the responsibility
of the integrator to know how Aegis2 works and how the failover software needs to be configured to work
with it. Aegis2 does not have any redundancy built into it and can only connect to and update one SQL
database at a time. The database needs to be mirrored for a true failover that avoids any down time.

If the License Service is installed in a redundant server environment, it needs to be done with the
awareness that the HASP key necessary for Network License mode can only be connected to one
server at a time. In order to failover to the second server, the HASP key will need to be physically moved
to it. We are not able to provide a duplicate HASP key for this purpose. Having the License Service
installed in a third location can avoid this issue.

KapLogic does not support any Aegis2 software that is being installed and configured in this
environment.

1.7 Use of a Virtual Port Replicator with Aegis2

KapLogic supports connections from the server or workstation to hardware via a serial cable. If a virtual
port replicator, such as Lantronix, is being used, it is the responsibility of the integrator to know how this
feature is installed, configured, and interacts with Aegis2. KapLogic will provide in their driver manuals
what computer or software settings are needed for the driver to connect to the hardware.

Aegis2.2x Installation Manual

6

7

1.8 Aegis2 Installation in Non-Default Locations

Aegis2 and all components except the database default to the install location of C:\Program
Files\KapLogic\Aegis2. If you wish to install these in another location, you will need to specify this during

the install process (see Section 2, Step M). Once this is specified, the new default install location will be
stored for the installation of any future Aegis2 components or updates.

The exception at this time are the PreReqs files, as these can only install to the default location of
C:\Program Files\KapLogic\Aegis2. These will need to be moved manually from that folder to any other
location.

Microsoft SQL Express 2005 and the database both default to the install location of C:\Program
Files\Microsoft SQL Server. If you wish to install these files in another location, you will need to skip
choosing the Database in the Aegis2 installer and use Microsoft’s own installer. This is SQLEXPR.EXE,
located on the install disc at db\Content\SQLExpress. Once this is completed, install the SQL Server
Management Studio Express tool (SQPServer2005_SSMEE_64.msi or

SQLServer2005_SSMSEE_x86.msi), also located at db\Content\SQLExpress. You will use this tool to

restore the Aegis2 database backup, Aegis220Model.bak, located on the install disc at
db\Content\SQL2005.

1.9 Maps

When deciding on the maps to be used in Aegis2, please consider the following:

1.9.1 Map Type

It is recommended that maps used be in AutoCAD format (DWG). This format will see the
maximum performance from the Aegis2 program. Many other graphical formats are supported
(BMP, GIF, JPEG, and PNG), but the available options in using these formats are limited.

1.9.2 AutoCAD Version

Aegis2 supports files from AutoCAD versions up to AutoCAD 2008.

1.9.3 Map File Size

The smaller the size of the AutoCAD map file, the better performance you will see from Aegis2. It
is recommended that map sizes remain below 1 MB. The larger the size of the map, the slower
the program’s ability will be to redraw maps quickly, leading to lags in scrolling, zooming, and
other features. The easiest way to decrease the size of an AutoCAD map is to strip off any layers
that you do not wish to appear when it is displayed in Aegis2. Aegis2 can handle up to 30 layers,
but we encourage having as few layers as possible.

1.9.4 Map Location

If you are importing or storing your map files on a remote server, make sure that you have the
proper permissions and network access configured for all of your workstations.

Aegis2.2x Installation Manual

1.10 User Group Rights

The user group located on each Aegis2 workstation must have Full Control access to the registry key
called KapLogic. This is located at HKEY_LOCAL_MACHINE\SOFTWARE\KapLogic. It is likely a
member of your IT staff will need to be present and have the appropriate permissions to configure this
setting.

1.11 The Aegis2 Runtime and Windows Server OS’s

Windows Server 2000 SP4, Server 2003 SP2, Server 2003 R2 SP2, and Server 2008 are all acceptable
for use on the server computer for Aegis2. The Management Console, Database, and Services can all be
installed under these operating systems. The Aegis2 Runtime is not compatible with these operating
systems, however, and should not be installed.

1.12 NVR/DVR Native Software and Aegis2

All native video NVR/DVR software and utilities should be removed from any computer being used as
either a server or workstation for Aegis2, due to the possibility of SDK version conflicts. These conflicts
can prevent both Aegis2 and the NVR/DVR software from working properly.

Aegis2.2x Installation Manual

8

2.0 Installing Aegis2 Components

KapLogic does not support using Remote Desktop or similar programs to install, configure, modify, or
delete Aegis2 and its components. The supported method is to make these changes logged into the
computer directly, as doing so remotely is known to cause serious problems.

To begin installation, please take the following steps:

A. Find the HASP key (HASP HL shown to the right)

shipped to you and plug it into the USB port of the
computer that will be running the License Service (if in
Network License Mode). If you are installing in Local
HASP Mode, plug the HASP key or keys provided into
the applicable computers to be used as the server
and/or workstations.

Wait for Windows to recognize the key. If it does not recognize the HASP key and cannot
automatically download the device driver, these can be located online at

http://www.aladdin.com/support/hasp/enduser.aspx#latestDD (for HASP HL) or
http://www.aladdin.com/support/hasp/hasp4/enduser.aspx (for HASP 4).

B. Insert the Aegis2 installation CD.

C. If it does not start automatically, select the application

Aegis2InstallShell.exe from the CD menu, as shown on the

right.

Aegis2.2x Installation Manual

9

D. The Aegis2 Installer screen will appear, as

shown on the right. Click the Install Aegis

Components button to start the installation

process.

E. If the Aegis2 Installer program detects that the

necessary prerequisite files are not present on
the computer, it will prompt you for permission
to install these files, as shown on the right.
These prerequisites are necessary for Aegis2
to work correctly. Click Yes to continue and
install the prerequisites.

If you do not need to install the prerequisite files, please skip to Step K.

F. Once you have given permission for the installation of the prerequisite files, the Aegis2 Installer

will launch another installer for the prerequisite files, the PreReqs2 InstallShield Wizard. Several
windows will open and configure the necessary installation files automatically, as shown below.
These will close automatically when they are finished.

Aegis2.2x Installation Manual

10

G. Once the configuration of installer files has

completed, the welcome screen for the

PreReqs2 – InstallShield Wizard will launch,

as shown on the right. Click the Next > button
to proceed with installation.

H. The License Agreement window will appear

next, as shown on the right. If you agree to the
terms and wish to continue with installation,
select the I accept the terms of the license

agreement option button, then click the
Next > button to continue.

I. The PreReqs2 InstallShield is now ready to install the necessary files. Confirm installation by

clicking the Install button, as shown below in the window on the left. The installation of the
prerequisite files will occur automatically, as shown below in the window on the right.

Aegis2.2x Installation Manual

11

J. Once the installation has completed, click Finish to complete installation of the prerequisite files,

as shown in the widow below on the left. The Aegis2 InstallShield Wizard will launch
automatically and begin configuring files for installation, as shown in the window below on the
right.

The prerequisite files are automatically installed in the default folder C:\Program
Files\KapLogic\Aegis2. If you intend to install Aegis2 in a folder other this default one, you
will need to move the prerequisite files from the default Aegis2 folder to the location of the
new Aegis2 folder.

K. The Aegis2 InstallShield Wizard welcome

screen will appear once configuration is
finished, as shown on the right. Click Next > to
proceed with the installation.

Aegis2.2x Installation Manual

12

L. The License Agreement window will appear

next, as shown on the right. If you agree to the
terms and wish to continue with installation,
select the I accept the terms of the license

agreement option button, then click the
Next > button to continue.

M. The Aegis2 InstallShield is now ready to

install the necessary files. The program will
automatically install these in a folder located at
C:\Program Files\Kaplogic\Aegis2. If you wish
to install these files elsewhere, click the

Change… button to designate a custom install

location. Confirm your destination and click the

Next > button to continue, as shown on the

right.

Aegis2.2x Installation Manual

13

N. At this point, the Aegis2 Install Shield will display the Custom Setup window, where you can

configure which programs and drivers you wish to install, as shown below.

It is recommended that any computer that has the Aegis2 Runtime also have Management

Console installed, as there are local settings in the Aegis2 Runtime that can only be configured

from Management Console when it is installed on the same computer. Depending on your type
of configuration, you will need to decide if you wish to install the Aegis2 Agent, Database, and/or

License Server on one of your workstations or a separate server (this can be a shared server).

The issues related to this decision are discussed in more detail in Chapter 1.0 of this document.
The selections on the bottom left screen shot are more typical of a basic workstation installation.
The screenshot on the bottom right better demonstrates either a server installation or a
workstation installation that includes server components (in which case, the other workstations
will be configured to access this workstation for the database and/or additional services).

If you are not installing Aegis2 in the default install location (C:\Program
Files\KapLogic\Aegis2), do not select Database in the Custom Setup window. You will
need to install SQL 2005 Express manually and restore the database from the Aegis2
install CD.

The final component of setting up your install is the selection of Drivers from the menu. Select
only the Drivers for the equipment that will be used with your system, then click Next > to
continue. Purchase and product registration are required in order for drivers to work. For further
details of driver installation and configuration, consult the manuals for each specific driver.

Do not install drivers you are not going to use. Unused drivers only slow down the
performance of the program and can lead to conflicts. The Aegis2InstallShell program is
designed to easily guide you through the installation of additional drivers if you need them
in the future.

Aegis2.2x Installation Manual

14

O. Once the Ready to Install the Program screen appears, as shown below and to the right, click

Install to proceed with the installation of the selected Aegis2 components. The program files for

Aegis2 will install automatically, as shown below and to the right.

P. Once the installation of the program files has

finished, the completion screen will appear, as
shown to the right. Click Finish to end, and
any additional components that you have
chosen to install will begin their installer
programs automatically.

If you have chosen not to install the database on this computer, skip to Step U.

Aegis2.2x Installation Manual

15

Q. The Aegis2 Server Setup will

launch next, as shown to the
right. In the first section,

Installation Type, select the

type of database installation
you wish to make.

If you are going to install a
new SQL database on this
computer, choose the option
of New Database. If you have
an existing Aegis2 database
that is being upgraded from a
previous version choose the
option of Upgrade an

existing database.

Click Next after you have
chosen your installation type
to continue.

If you are choosing the option of Upgrade an existing database, please contact KapLogic
prior to going through with the upgrade to confirm this is the correct course of action.
Important database information can be overwritten if this process is not done correctly.

R. The Sever Connection

screen appears next in the
process. If a previous
installation of SQL is detected
by the setup program, then
the Type, Instance, and

Version will auto-populate

with that information.

You will need to set

Authentication to either
Windows Authentication or
SQL Server Authentication.

If you are using Windows

Authentication, make sure

that the Windows user is
authorized to log into SQL by
Windows Authentication as
well. If you decide to use SQL
Server Authentication instead,
you will need to have either the sa Password or a User Name and Password created
specifically for Aegis2 to log into SQL.

If you are installing SQL 2005 Express, you will be asked to create and confirm a password for
the administrator account on the new install. Aegis2 will use this account to access the SQL
database automatically.

Once you have selected your options and entered any necessary information, click Test

Connection to confirm the settings are correct. The Aegis2 Server Setup will respond with the

message “A new Aegis database will be installed” if the test has been successful. Click Next to
continue.

Aegis2.2x Installation Manual

16

17

S. The Confirmation screen will

appear next, noting that the
database will be installed.
Click Next to proceed to the
installation of the database.

T. Once you have confirmed the installation, the Aegis2 Server Setup will install the database, and,

if necessary, Microsoft SQL 2005 Express. When the process has completed, click Finish to exit
the program.

U. At this point, the installers for any drivers you have chosen will launch. Please refer to the

documentation for those particular drivers to see the steps involved in their installation.

Aegis2.2x Installation Manual

3.0 Initial Settings After Installation

Please take the following steps immediately after installation:

A. Once the installers have completed, navigate to the Management Console and launch it. The

default login for the program is Username: administrator and Password: admin.

B. If you are planning to run Aegis2 in License Server Mode,

navigate the left-side tree view to Applications\License Server
and click to open the License Server settings.

C. Once in the License Sever settings go to the Configuration tab if it does not show already.

Select the option button for License Sever, as shown below, then enter the TCP/IP Address and

TCP/IP Port for the location of the License Sever. This is the computer that is actually running

the KapLogic License Service.

Next, in the Workstation Registration box enter the Workstation License Count and the

Registration Number. If you have not yet received a Registration Number, contact KapLogic at

[phone] or [e-mail] to receive one.

Once you have finished this, click Save to record this information.

Aegis2.2x Installation Manual

18

D. If you have entered the correct Registration

Number, you will see the message shown to the

right, confirming that registration was successful.

Click OK and you will then receive a message
confirming that License Server settings were
saved and asking to restart the License Service,
as shown below. If the License Service is
installed on the local computer, click Yes. If the

License Service is installed on another computer, click No and restart the License Service on

the other computer manually. This is necessary to reload the updated settings from the database.

E. If you have clicked Yes to restart the License Service, you will see a window noting that the

License Service is stopping (below, left) then starting again (below, right).

F. Once the License Service has restarted, if you click the Status tab you should see the status

indicated for the License Service as Running, as shown below.

Aegis2.2x Installation Manual

19

G. Finally, if you are using Aegis2’s provided method

of database backup, you will want to enter those
settings. These settings must be entered on the
computer where both the Aegis Agent and the
database are installed, as these are local settings.

In the Management Console navigate the left­side tree view to Applications\Aegis and right-click
on Aegis. Choose Properties from the menu that
appears, as shown to the right.

Aegis2.2x Installation Manual

20

H. In the Aegis System Settings window that appears, select the Database tab, as shown below.

Here you can select and schedule the database backup. We recommend doing the backup doing
a known period of low activity for your network. The backup occurs in the background and will not
be noticeable by any operators of the Aegis2 Runtime.

Additionally, you have the option of scheduling transaction log backups. These backups will log

the activity in both the Aegis2 Runtime and Management Console, recording what has been done
within the system between daily database backups. These backups can be set for a set interval,
and the greater the activity on the system the shorter the recommended interval. You can also set
transaction log backups specifically during certain hours of the day, although if you wish to have
them 24 hours a day use the settings shown below.

Based on your data retention policies, you can set how many days of backups you wish to

keep. Any backups older that the number of days entered will be automatically deleted. Please
take into consideration that multiple days of backups can rapidly eat away at available storage
space.

Finally, enter the location of the backup folder. KapLogic recommends using the location of the

default folder for backups in SQL 2005 Express, as this provides the fewest problems insofar as
accessibility and permissions. Be aware that the Aegis2 software can only do backups to a local
machine, so the address entered must be done on the computer where the database is located
and cannot specify another machine on the network. Click OK when finished.

Aegis2.2x Installation Manual

21

I. Once you have completed and saved the database backup settings, exit the Management

Console and right-click on your Computer icon to select the Manage option from the drop-down

menu, as shown to the right.

This option will bring up the Computer Management window, as shown below. Navigate the
left-side tree view to Services, where you will right-click the Aegis Agent from the list of services
and select the option to Restart.

J. Once you click Restart, you

should see a window appear
tracking the Service as it
shuts down and restarts, as
shown to the right. Once this
has completed, the Aegis

Agent will have loaded the

new settings for backups.

Aegis2.2x Installation Manual

22