Installation Guide - Australian Security Technology · copyrights or other intellectual property rights covering subject matter in this ... (e.g. Gallagher/Cardax, ... Host IP . Specify

Installation Guide

version 2.1.x

the KeyWatcher management system designed and produced by Argus Global, Australia

About the KeyPro Plus user guides

There are three KeyPro Plus user guides, each focussed on a key phase of using KeyPro Plus:

Installation Guide

covers installing KeyPro Plus, something you typically do only once per site.

Administration Guide

covers the configuration and administration activities you'll perform when you first set up your KeyPro Plus site, then occasionally as required for new KeyWatchers, key policies, and operators.

Operations Guide

covers the everyday activities you'll perform to manage your KeyWatcher inventory and its users

Copyright © Copyright 2015 Argus Global Pty Ltd. (ABN 42 138 440 230). Argus Global may have patents or pending patent applications, trademarks copyrights or other intellectual property rights covering subject matter in this document. The furnishing of this document does not give you any license to these patents, trademarks, copyrights or other intellectual property rights. All Rights Reserved

Trademarks The following (where mentioned) are trademarks: Cornerstone, True Identity and True Identity Manager are registered trademarks of Argus Global Pty Ltd KeyWatcher, SmartKey, KeyWatcher Touch, Key-Pro and Key-Pro Software are trademarks of Morse Watchmans Incorporated

Confidentiality This document is classified Commercial in Confidence. It is subject to a confidentiality agreement between Argus Global Pty Ltd and its customers and partners. Its contents must not be divulged to third parties.

KeyPro Plus — Installation Guide version 2.1.x 2

Contents

Installing KeyPro Plus .............................................................................................................................................. 4 Before installing KeyPro Plus ....................................................................................................................... 4 Install the KeyPro Plus server ....................................................................................................................... 6 Install the KeyPro Plus client ...................................................................................................................... 11 Update the KeyPro Plus administrator password ................................................................................. 14 Request KeyPro Plus licences for your site ............................................................................................. 15 Install the KeyPro Plus licence files .......................................................................................................... 16 Copy Touch LicenseFeatures.ini file ........................................................................................................ 17 Configure KeyPro Plus................................................................................................................................ 18

Upgrading KeyPro Plus ........................................................................................................................................ 19 Before upgrading KeyPro Plus .................................................................................................................. 19 Upgrade the KeyPro Plus server ............................................................................................................... 20 Upgrade the KeyPro Plus client ............................................................................................................... 22

Adding New Touch servers................................................................................................................................. 23 Before installing a new Touch server ...................................................................................................... 23 Copy Touch LicenseFeatures.ini file ...................................................................................................... 23


Installing KeyPro Plus

Before installing KeyPro Plus Every KeyPro Plus site is unique. The installation procedure detailed in this chapter includes most of the common variations, but be aware your site may require additional configuration (for user authentication, permissions, firewalls, etc.).

If you are upgrading, please see Upgrading KeyPro Plus on page 19.

To ensure your installation goes smoothly, check the following items:

Server and network Are all any accounts, permissions, firewall configurations etc. that may be required in place so that the KeyPro Plus server will be able to communicate with: SQL Server KeyPro Plus client workstation(s) networked KeyWatcher Illuminated box(es) KeyWatcher Touch server(s) integration server (if used).

SQL Server If KeyPro Plus will be using an existing instance of Microsoft SQL Server, set up an account for KeyPro Plus before installation. Have the account name, password, and the name or the server instance to hand.

Otherwise, will you be installing the free SQL Server Express Edition or have you purchased a licensed edition to install? Will SQL Server be installed on the same machine as the KeyPro Plus server?

User Authentication If you plan to authenticate KeyPro Plus operators using Windows authentication (instead of KeyPro Plus standard authentication) ensure the appropriate Windows accounts, permissions etc. are set up.

KeyWatcher Illuminated Are your KeyWatcher Illuminated boxes networked (if not they will require a serial to Ethernet converter to be installed and configured) and online?



KeyWatcher Touch Are your KeyWatcher Touch server(s) installed and online? Are All KeyWatcher Touch boxes connected to a Touch server?

Check the KeyPro Plus release notes and ensure the version of the KeyWatcher Touch server you are running is a supported version.

If necessary, upgrade the KeyWatcher Touch Server before attempting to connect to it with KeyPro Plus.

Do NOT install True Touch. True Touch can potentially interfere with the successful operation of KeyPro Plus. If True Touch is installed, uninstall it before installing KeyPro Plus.

It is essential that the Touch servers used with KeyPro Plus have not previously been used with True Touch or any other client application. If you are not sure, install a fresh instance of Touch server for use with KeyPro Plus.

Integration Server If your site is integrating KeyPro Plus with another system (e.g. Gallagher/Cardax, OnGuard, P2000), ensure the integration server is up and running before installing KeyPro Plus.

Sharing servers? The KeyPro Plus Server can share the same physical machine as the SQL Server and the Integration server.

The KeyPro Plus Server should be able to share the same physical machine as the KeyWatcher Touch Server, but always check the compatibility information to ensure your version of Microsoft Windows Server is supported by both KeyPro Plus and the KeyWatcher Touch.

Check the KeyPro Plus release notes and the Touch server documentation for up-to-date compatibility information.



Install the KeyPro Plus server The following software will be installed on your KeyPro Plus server machine:

Microsoft SQL Server (unless it is hosted elsewhere)

Microsoft .NET Framework (if not already installed)

KeyPro Plus server.

We'll assume you are logged on to the server machine.

SQL Server If you have purchased a licence for the standard edition of SQL Server,

install SQL Server first, before running the KeyPro Plus server installation.

Follow the SQL Server installation instructions supplied by Microsoft. This SQL Server installation may be on a different machine to the KeyPro Plus server.

Note the system administrator's user name and password as you will need these when installing the KeyPro Plus server.

Otherwise, the free SQL Server Express Edition can be installed as part of the KeyPro Plus server installation (see below).

KeyPro Plus Server 1. Start the installation wizard (e.g. by double-clicking it).

Argus.KeyProPlus.Server.FullSetup.2.1.xx.exe (where xx is the version number).

The installer starts by displaying a dialog. For example:

2. Select the items to install, then click the Install button.

Typically you would install all items unless you are using an existing instance of SQL Server.

The installer installs the selected prerequisites, which takes a few minutes.



After any prerequisites are installed, the installer displays the KeyPro Plus Server Setup Wizard. For example:

3. Follow the wizard steps, carefully reading the questions before answering them.

The wizard installs the KeyPro Plus server.

After a few moments, it will display an SQL Server Connection dialog. For example:

4. Select a method for KeyPro Plus server to use to connect to SQL server. If using SQL authentication, provide a user name and password (this may be the system administrator account set up when you installed SQL Server).

Before proceeding, test the server connection with the Test Connection button.

Trouble connecting? The following tips may help: Is the SQL Server is running? Are you using the correct user name and password to connect? If SQL Server is on another machine, are there firewall issues?

When you can successfully connect to SQL Server, click the Next > button.

The installer runs some SQL scripts to set up the KeyPro Plus database.

5. When the installer has completed the installation, close it as requested.



Start the KeyPro Plus Server for the first time 6. Start the KeyPro Plus server application(e.g. by double-clicking it).

C:\Program Files (x86)\Argus\KeyPro Plus Server\

Argus.KeyProPlus.Server.App.exe

KeyPro Plus displays the Server Manager window. For example:

7. Click the Start Server button.

The Argus.KeyProPlus.Server Windows service starts.

8. Click the Close button to close the Server Manger.

The Argus.KeyProPlus.Server windows service will continue to run until it is stopped or the machine is shutdown.

Configure the Argus.KeyProPlus.Server service dependency — OPTIONAL By default, the Argus.KeyProPlus.Server is installed to start automatically when Windows starts. However, the Argus.KeyProPlus.Server service will not start if SQL Server is not already running.

If you are running the Argus.KeyProPlus.Server and SQL Server on the same machine, it is recommended you configure a dependency so that Argus.KeyProPlus.Server doesn't try to start until SQL Server is up and running.

If not appropriate for your site, skip forward to the next section (Configure Microsoft Distributed Transaction Coordinator on page 9).

9. Open Windows Services

Click the Windows Start button; Select Control Panel; Select Administrative Tools; Open Services.



10. Locate the SQL server service in the list of services running and double click on it. Note the service name for the next step, then close the Properties window.

For example:

11. Open the Windows Command Prompt and enter the following command:

sc config Argus.KeyProPlus.Server depend= <SQLservicename>

where <SQLservicename> is the service name from step 10.

Windows should display a SUCCESS message. For example:

12. You can confirm the dependency is now configured using Windows Services. Double-click on Argus.KeyProPlus.Server and select the Dependencies tab.

For example:

When you're done, close Windows Services.

Configure Microsoft Distributed Transaction Coordinator Check the Microsoft Distributed Transaction Coordinator is correctly configured.

13. Open Windows Component Services

Click the Windows Start button; Select Control Panel; Select Administrative Tools; Open Component Services.



14. Expand Component Services to locate the Local DTC under Distributed Transaction Coordinator. For example:

Then right-click on Local DTC and open the Properties window.

15. Set the Local DTC Properties to match the following example:

Allow Network DTC Access for Client and Administration, inbound and outbound transaction manager communication, and Enable EX and SNA Transactions.

Apply your new settings and close Component Services.



Install the KeyPro Plus client Always install the KeyPro Plus client on the server machine as well as your client workstation. It's best to install the KeyPro Plus client on the server machine first, get it up and running, and then install it on your client workstations.

We'll assume you are logged in to the machine on which you are installing the KeyPro Plus client (e.g. the server machine).

Install the KeyPro Plus Client on your server machine 1. Start the installation wizard (e.g. by double-clicking it).

Argus.KeyProPlus.Client.FullSetup.2.1.xx.exe (where xx is the version number).



The installer installs the selected prerequisites, which takes a few minutes.

After any prerequisites are installed, the installed displays the KeyPro Plus Client Setup Wizard. For example:




The wizard installs the KeyPro Plus client.


Set KeyPro Plus Client defaults Use the Client Configuration Tool to set the default host and port that this instance of the KeyPro Plus client application should use to connect to the KeyPro Plus server.

5. Start the KeyPro Plus Client Configuration Tool (e.g. by double-clicking its icon on your desktop).

C:\Program Files (x86)\Argus\KeyPro Plus Client\

Argus.KeyProPlus.ClientConfigTool.exe

6. Configure the default host and port for this client.

Click the Add button,

then enter your host's details as follows…

Server Connection:

Field Description

Host IP Specify either a numeric IP address or a name DNS can resolve for the server on which the KeyPro Plus server service is running.

Port Enter 1601

then click the Save button.

7. Click the Close button to close the Client Configuration tool.

Test the KeyPro Plus Client 8. Start the KeyPro Plus Client (e.g. by double-clicking its icon on your desktop).

C:\Program Files (x86)\Argus\KeyPro Plus Client\

Argus.KeyProPlus.Client.exe



The KeyPro Plus Client displays the Login screen.

The host IP and Port should be those you set in step 6.

9. Enter the default Administrator details as follows…

Login

Field Description

Login Name Administrator

Password password

Use Windows Authentication

(leave unchecked)

then click the Login button.

KeyPro Plus displays the Summary screen.

10. Click the Logout button in the bottom right corner of the Summary screen.

.

11. Click the close box in the top-right-hand corner of the Login screen to close the application.

Install the KeyPro Plus Client on your client workstation Once the client application is installed on your server machine, install if on your client workstations.

For each client workstation: perform the above installation steps 1 through 11 (starting on page 11).



Update the KeyPro Plus administrator password As soon as you have finished installing the KeyPro Plus server and clients, reset your administrator password.

Never leave the administrator password set to the default!

We'll assume you're logged in to KeyPro Plus. (see Install the KeyPro Plus client, steps 8 and 9, starting on page 12).

1. Select the System Admin tab.

2. Select the Operators sub-tab.

3. Select the operator user record for Administrator, then click the Edit button.

KeyPro Plus displays the Edit Operator wizard.

4. Enter a new password… then click the Complete button, and Confirm.

KeyPro Plus updates the operator's password.

5. Logout and close the KeyPro Plus client.



Request KeyPro Plus licences for your site KeyPro Plus licences are granted for a KeyPro Plus server to run: on a particular machine for a maximum number of KeyWatchers for a maximum number KeyPro Plus clients running concurrently.

Argus support engineers can create this licence for you.

KeyPro Plus licences are specific to the machine on which they are installed and are based on a 96 character computer key generated by KeyPro Plus. A licence file is installed only on the server machine. KeyPro Plus clients do not require a separate licence file.

KeyPro Plus is installed with a five day evaluation licence. If this is not replaced with a valid licence before it expires, KeyPro Plus will stop running.

To request a KeyPro Plus licence

We'll assume you are logged on to the server machine.

1. Start the KeyPro Plus server application(e.g. by double-clicking it).




2. Click the License Status field.

3. Copy the computer key (e.g. double-click to select, then right-click and copy)

Email the computer key along with the number of KeyWatchers and concurrent clients you wish to license to your Argus support engineer, who will create the licence file and email it to you for installation.



Install the KeyPro Plus licence files The KeyPro Plus licence file (license.lic) is installed by copying it into the directory the server is run from.

1. Copy the licence file (license.lic) into the KeyPro Plus Server directory on the server machine:

C:\Program Files (x86)\Argus\KeyPro Plus Server

The exact names may vary depending on your site.

2. Start the KeyPro Plus server application(e.g. by double-clicking it).




The license status should read "This product is fully licensed".



Copy Touch LicenseFeatures.ini file KeyPro Plus uses a copy of the Touch server licence to validate which features can be configured on boxes connected to that Touch server (e.g. key release method, department access, key return method, secure return).

For each installed Touch server: We'll assume the Touch server is correctly licensed.

1. Copy the license features file (LicenseFeatures.ini) from the directory in which the Touch server was installed into the KeyPro Plus Server directory on the server machine:


2. Rename the license features file as follows:

LicenseFeatures <TouchServerName>.ini

where <TouchServerName> is the name you intend to give this Touch server when configuring it in KeyPro Plus.

3. Note the name carefully. You must enter this exact name (case matched) when you configure the Touch server or KeyPro Plus won't be able to find the LicenseFeatures file.



Configure KeyPro Plus Once you have installed the KeyPro Plus software and can start the server and client, you will need to configure your KeyPro Plus site, setting up the features and functions you intend to use.

At a minimum, configuring KeyPro Plus requires:

adding KeyWatchers to KeyPro Plus

configuring the SmartKey inventory in each KeyWatcher

creating user groups to define permissions and access to your KeyWatchers and SmartKey inventory

adding users and assigning them to a user group.

It include also include configuring:

key access times

key groups

departments

physical keys

operator groups

operators

notification recipients (email alarms)

scheduled reports (by email)

an STMP gateway (for emails from KeyPro Plus)

integration to other systems (e.g. Gallagher, OnGuard, P2000).

For detailed information on configuration of KeyPro Plus, see the Administration Guide.


Upgrading KeyPro Plus

Before upgrading KeyPro Plus

Before upgrading, back up your KeyPro Plus database.

Always carefully read the release notes supplied with the KeyPro Plus upgrade. It may contain changes to the update procedure shown here.

Upgrading from version1.0.x Licences for 2.1.x are installed only on the server machine. KeyPro Plus clients no longer require a separate licence file.

Existing installations of earlier versions of KeyPro Plus (1.0.x) will require a new licence to run version 2.1.x. Consult your Argus Support Engineer for details.

If you are using SQL Server Express edition and your database is currently over 7 gigabytes in size, be aware that upgrading to 2.1.x may result in your database exceeding Express edition's 10 gigabyte size limit. If it does, KeyPro Plus will not being able to run until you upgrade SQL Server to the standard (licensed) edition.



Upgrade the KeyPro Plus server Upgrading KeyPro Plus to a new version is simpler than installing KeyPro Plus (see Installing KeyPro Plus on page 4) as the existing configuration remains in place.

Do not re-install the database or you will lose your existing data. The installer will automatically upgrade the database if required.

We'll assume you are logged on to the server machine, and that the KeyPro Plus server is stopped.

1. Start the installation wizard (e.g. by double-clicking it).

Argus.KeyProPlus.Server.FullSetup.2.1.xx.exe (where xx is the version number).



The installer checks the prerequisites, which takes a few minutes.

The installer displays the KeyPro Plus Server Setup Wizard. For example:




The wizard installs the KeyPro Plus server.

After a few moments, the installer will ask if you want to install a new database.

4. Answer No, you do NOT want to install a new database.

The installer continues.


6. If you are upgrading from KeyPro Plus version 1.0.x, install the new licence file (license.lic) into the KeyPro Plus Server directory on the server machine:


The exact names may vary depending on your site.



Upgrade the KeyPro Plus client We'll assume you are logged in to the machine you are upgrading.

1. Start the installation wizard (e.g. by double-clicking it).

Argus.KeyProPlus.Client.FullSetup.2.1.xx.exe (where xx is the version number).



The installer checks the prerequisites, then displays the KeyPro Plus Client Setup Wizard. For example:


The wizard installs the KeyPro Plus client.


Repeat the installation for each of your client workstations.


Adding New Touch servers

Before installing a new Touch server When adding a Touch server to an existing KeyPro Plus installation:

Check the KeyPro Plus release notes and ensure the version of the KeyWatcher Touch server you are installing is a supported version.

Do NOT install True Touch. True Touch can potentially interfere with the successful operation of KeyPro Plus. When installing the Touch server, do not install True Touch.

It is essential that the Touch servers used with KeyPro Plus have not previously been used with True Touch or any other client application. If you are not sure, install a fresh instance of the Touch server for use with KeyPro Plus. If you intend installing the Touch server on the same physical machine as your KeyPro Plus server, check the KeyPro Plus release notes and the Touch server documentation for up-to-date compatibility information.

Copy Touch LicenseFeatures.ini file KeyPro Plus uses a copy of the Touch server licence to validate which features can be configured on boxes connected to that Touch server (e.g. key release method, department access, key return method, secure return).

We'll assume you have completed installing the new Touch server and that it is correctly licensed.

1. Copy the license features file (LicenseFeatures.ini) from the directory in which the Touch server was installed into the KeyPro Plus Server directory on the server machine:


2. Rename the license features file as follows:

LicenseFeatures <TouchServerName>.ini

where <TouchServerName> is the name you intend to give this Touch server when configuring it in KeyPro Plus.

3. Note the name carefully. You must enter this exact name (case matched) when you configure the Touch server or KeyPro Plus won't be able to find the LicenseFeatures file.


`

Documents

Installation Guide - Australian Security Technology · copyrights or other intellectual property rights covering subject matter in this ... (e.g. Gallagher/Cardax, ... Host IP . Specify