ayonix milestone plugin v1.3 installation manual€¦ · requirements ... process face recognition...

Ayonix Milestone Plugin v1.3 Installation Manual

Ayonix Corporation

Jan. 23th, 2018

2

Table of Contents Versions of this document: ...................................................................................................................................... 3

Requirements ........................................................................................................................................................... 3

Prerequisites ....................................................................................................................................................... 3

Choosing Architecture .............................................................................................................................................. 4

Possible architectures ........................................................................................................................................ 4

Server Installation..................................................................................................................................................... 6

Server Installation Instructions.......................................................................................................................... 6

Ayonix License Request .................................................................................................................................... 12

Windows Server Settings.................................................................................................................................. 17

Database, Milestone Server and System Role Selection ............................................................................... 24

Milestone Server Settings ................................................................................................................................ 27

Camera and server setup ................................................................................................................................. 34

Client Installation.................................................................................................................................................... 48

Prerequisites ..................................................................................................................................................... 48

Client Setup Instructions .................................................................................................................................. 48

3 Versions of this document:

Date Author Description 2016-12-05 JFLR Initial version 2017-01-24 JFLR Updates for version 1.2 2017-05-04 JFLR Updates for version 1.3 2017-06-19 JFLR Client Instructions

Requirements

Prerequisites

Prerequisites for the Server Installation - Network The following components are necessary (They must be present in the same network as the computer on which we are installing milestone plugin) in order to install Ayonix Milestone Plugin V1.3:

- Milestone Corporate 2016 R3 Editions installed (Corporate version recommended)

(

To install Milestone , please refer to Milestone documentation. Download “XProtect Corporate Administrator Getting

Started Guide” on the following link:

https://www.milestonesys.com/support/help-yourself/manuals-and-guides/?prod=3&type=13&lang=27

)

- SQL Server Enterprise

Prerequisites for the Server Installation - Installation Computer The following components are necessary in the computer in order to install Ayonix Milestone Plugin V1.3:

- 64 bit windows operating System (Windows 7 or higher version)

- Ayonix Milestone Plugin installation setup file.

https://www.milestonesys.com/support/help-yourself/manuals-and-guides/?prod=3&type=13&lang=27

4

Choosing Architecture

Possible architectures

Milestone Plugin Network Architectures Milestone Plugin can be installed on multiple servers or on one one server.

Server can be configured to have one of the three roles:

1) Worker - Captures images from camera and sends results to Master

2) Master - Processes messages from Workers, process Face Recognition and dispatch Face Recognition events.

3) Master / Worker - Both Worker and Master roles on the same computer. This is the role a server must have when there is only one server with Ayonix Milestone Plugin installed.

Architecture 1 - Worker and Master on the same computer

Ideal for small networks ( generally up to 10 cameras)

Small enrollment database sizes ( under 10000 persons).

5 Architecture 2 - One Master and many Worker Computers

One Server only for Matching and events ( Master) and many Workers detecting faces from cameras and sending to Master.

Big enrollment database sizes

Ideal for many cameras scenario ( over 10 cameras).

6

Server Installation

Server Installation Instructions

Pre Install : Software Prerequisites Wizard

7 Pre Install : Software Prerequisites Wizard

Click on Next to start installing prerequisites if needed

8 Ayonix Milestone Plugin Installation Setup


Check lincense agreement conditions and proceed id agreed


Choose installation folder. It is recommended to keep default settings


Click on "Install" to start installation. Administrator privileges are needed to proceed.


Click on "Finish" to finish installation process.

Ayonix License Request

Create License Request

Access folder /Framework/lic on Ayonix Milestone Plugin Installation folder.

13 Create License Request

Run "AyonixMilestoneManager.exe" as administrator


Click on "Read License File". Select .lic file on the same folder.

14 Create License Request

License Details will appear. Click on "Generate Activation Request".


Save Activation Request ( .req file) into File System.

Send AyonixFaceID_5_3.req file to [email protected], asking for license activation file.

15 License Activation

Run AyonixLicenseManager.exe as with administrator privileges. Click on "Read Activation File" and select .act file sent by [email protected].

16 License Activation

Click on "Activate License". License file will be generated (AyonixFaceID_5_3.alc file).

License Activation

Copy AyonixFaceID_5_3.alc file to Framework/lic folder

17 Windows Server Settings

Windows Server Settings

In order to authorize Ayonix Milestone Service to run as a Service, we must access "Services" interface on Windows.

Click on "Start" button and type "services" into text bar.

18 Windows Server Settings

Right Click on "Services" menu and choose "Run as administrator"

19 Ayonix Milestone Service authentication setup

Select "Ayonix Milestone Service" into "Services" list.


Right click on it and select "Properties"


Select "Log On" tab.


1) Insert an account with administator privileges,

2) Insert Password and Password confirmation

3) Click on "Ok" button


On "Ayonix Milestone Service" , right click and select "Start".

24 Database, Milestone Server and System Role Selection

General instructions Upon first running, Interface will proceed to the basic configuration window sequence:

1) Database Setup and Creation - DB Instance

2) Server Role Selection

3) Milestone Settings ( if Role selected in step 2 was "Master" or "Master / Worker")

Database Setup and Creation - DB Instance

1 - App Path: field is automatically filled with Application path.

2 - Db Instance : type sql server IP address and installation name. For instance, if sql is on 192.168.0.10 and chosen installation name is SQLEXPRESS, type "192.168.0.10\SQLEXPRESS"

3- Type System Administrator username and password . System administrator usually is sa.

4- Click on Test. A confirmation message must be displayed.

5- Click on Setup. A sequence of confirmation messages will be displayed, finished by a "Setup Successfully" message

25 Server Role Selection

1- Server Name: System will suggest an alias for new server. You can keep suggested name or change it freely, as long as it is an unique name.

2- Server IP: Select Server IP among the available system IP addresses.

3- Service Communication Port: System will suggest automatically a port available for communication. It is recommended to keep suggested port.

4- Server Role: Choose among one of the available roles for current server:

Ayonix Master: It is the matcher server. It receives data from workers, execute matchings and dispatch events.

Ayonix Worker: Captures images from one or more cameras and send face detection events to Master

Ayonix Master / Ayonix Worker: both roles will be executed into this server.

5- Click on Save button. A success message will Appear.

26 Milestone Authentication Setup

1 - Insert Milestone server IP. Keep it with 127.0.0.1 if milestone is installed in the local computer, otherwise type Milestone Server IP Address.

2 - Type Server port corresponding to Milestone Image Server service. On Milestone Corporate versions it is usually port 80. On Milestone Express versions it is usually port 8080

3 - Select Authentication type. For default installations it is recommended to authenticate using a windows account linked to Milestone System. select "Windows Authentication".

4 - Type Milestone User username and password.

5- Click on Test. A message with basic information about Server must appear. Otherwise, an error message will be displayed.

6 - Click on Setup. A sequence of confirmation messages will be displayed, finished by a "Setup Successfully" message

27 Milestone Server Settings

Enabling Analytic Events - Step 1

Select Tool - Options Menu

Enabling Analytic Events - Step 2

Select "Analytic Events" tab

28 Enabling Analytic Events - Step 3

Check "Enabled" option and click OK button.

Creating Face Detected Analytic Event - Step 1

Click on Analytic Events.

29 Creating Face Detected Analytic Event - Step 2

Right Click on "Analytics Events" . Select "Add New"

Creating Face Detected Analytic Event - Step 3

Type "Face Detected Analytic Event" on "Name" field

30 Creating Face Detected Analytic Event - Step 4

Click outside the Properties window. A "Save Changes" confirmation message will appear. Click on "Yes" and close

Creating Face Detect Alarm - Step 1

31 Creating Face Detect Alarm - Step 2


1 - On "Name" field, write "Face Detection Alarm"

2 - On "Triggering Event" selection box, select "Analytics Events"

3 - On "Sources" control, click on "Select" button to choose from a source

32 Creating Face Detect Alarm - Step 4

1 - Click on "Servers" Tab

2 - Click on "All Cameras"


1 - Click on "Add" Button

2 - Click on "OK"

33


Click outside the Properties window and click on "Yes" on the save confirmation window

34 Camera and server setup

Adding a new Camera

Execute "Ayonix Milestone 1.3 Plugin Manager" with administrator privileges from shortcut in Desktop.

35 Adding a new Camera

Right Click on "Cameras" tab and select "New Camera"


Find Milestone Camera and click on "Select" button.


Select which worker will be assigned to this camera.


Keep recommended settings for Threshold , Tracking Quality and Minimum Frames and Click on "Save" button.

Adding a new Camera

Click on "OK" button


On Main Treeview, Camera will appear assigned to the designated server.

40 Editing Server Role

Use Filter to find desired server.


Right click on target server and select "Edit Server" menu.


Select one of the three possible roles into "Server Role" dropdown.

Editing Server Role

Click on "Save" button.


Click on "OK" button.

44 Deleting a server

Right click on "(W)Ayonix Server 5 (192.168.0.15)" tree item in "Ayonix Milestone Plugin v1.3"


Right click on target Server and select "Delete Server" Menu.


Click on "Yes" button in "Confirm Delete!"


Server will disappear from Servers treeview.

Important: Although server is removed from system, Milestone Plugin is not uninstalled on target server. While uninstalled, Ayonix Milestone Plugin services will not work on target computer.

48

Client Installation

Prerequisites • Windows Operational System • XProtect Smart Client 2016 R3

o If you don’t have Milestone XProtext Smart Client installed on your computer, please refer to It

on Milestone website. You can download “XProtect Smart Client 64-bit” on the following link:

o https://www.milestonesys.com/support/resources/download-

software/?prod=159&type=11&lang=27 • Ayonix Milestone Plugin “Milestone Plugins” folder ( these files will be copied in the next steps)

Client Setup Instructions

Before proceeding, Close All Instances of XProtect Smart Client , if they are opened.

Find client setup plugin files

On Server Installation folder, There is a Folder named "Milestone Plugins"

49 Copy client setup plugin files

Copy the three folders from this folder to the XProtect Smart Client MIPPlugins Folder ( check next illustration)

50 Paste client setup plugin files

This is the MIPPlugins folder destination file for the plugin

51 Open XProtect Smart Client as Administrator

Open XProtect Smart Client using Desktop shortcut.

IMPORTANT: In order to setup client plugin for the first time, it is mandatory to run it with Administrator privileges at the first time

Click on "Setup" button

52 Milestone Client Plugin XProtect Setup

Under "Setup" view, create a new view. Views can be created according to user needs. In our example, we create a 1+2 view

Milestone Client Plugin XProtect Setup

53 On "System Overview" left panel, look for "Ayonix" option. Click on it.


Drag And Drop"FaceId Plugin" to one of the views. An error message will appear, showing that connection string files could now be oppened.


This message Appears when trying to drag and drop Ayonix plugin into view. Click on OK.

54 Milestone Client Plugin XProtect Setup

Inside Plugin basic window (upper right panel) , double click over Ayonix Icon. A "Setup" Button will appear on the lower part.


Click on "Setup" button. Type default password for it default password is "ayonix" . It can be changed inside server interface window.

55 A Setup menu will appear.


Select "Database" into "Setup Menu". A Connection window will appear.


1 - Db Instance : type sql server IP address and installation name. For instance, if sql is on 192.168.0.10 and chosen installation name is SQLEXPRESS, type "192.168.0.10\SQLEXPRESS"

2 - Type System Administrator username and password . System administrator usually is sa.

3 - Click on Test. A confirmation message must be displayed.

4 - Click on Setup. A sequence of confirmation messages will be displayed, finished by a "Setup Successfully" message

56


Click on Ok. Close XProtect Smart Client and open it on normal mode ( without Administrator permissions).

Client Plugin Setup is completed.

ayonix milestone plugin v1.3 installation manual€¦ · requirements ... process face recognition...

Documents