NX Web Integration Guide

Introduction

This guide comprises comprehensive information about VEZHA Analytics System web integration with NX VMS. The latest versions of VEZHA plugins already contain a built-in web integration functionality for NX VMS and are ready for use through the Web Pages.

Overview

Before you start, ensure you have correctly installed the latest versions of:

  1. IncoreSoft VEZHA Analytics System (Middleware Core ver. 23.3.46 or higher)
  2. Required IncoreSoft VEZHA analytics and corresponding plugins:
    • Age & Gender Detection (plugin ver. 23.3.12 or higher)
    • Face Recognition (plugin ver. 23.3.25 or higher)
    • Gun Detection (plugin ver. 23.3.12 or higher)
    • Hard Hat Detection (plugin ver. 23.3.11 or higher)
    • LPR (plugin ver. 23.3.33 or higher)
    • Motion Detection (plugin ver. 23.3.9 or higher)
    • Object Detection (plugin ver. 23.3.21 or higher)
    • Pose Estimation (plugin ver. 23.3.12 or higher)
    • Smart Parking (plugin ver. 23.3.16 or higher)
    • Smart Tracking System (plugin ver. 23.3.12 or higher)
    • Smoke & Fire Detection (plugin ver. 23.3.10 or higher)
    • Traffic Analytics (plugin ver. 23.3.18 or higher)
    • UIC & Container (plugin ver. 23.3.15 or higher)
  • The latest version of the IncoreSoft VEZHA Analytics System installation file can be found in the Installation Files section of the Partners Portal.
  • Middleware Core version can be checked in the Updates item of the VEZHA system, and updated if necessary.
  • IncoreSoft VEZHA plugins can be updated in the Plugin Marketplace item of the VEZHA system.

NX Camera Adding

To add the NX camera to the VEZHA Analytics System, configure the required parameters while adding a video stream:

  1. Select NX from the Source drop-down list
  2. Enter the NX VMS server address in the Host field
  3. Enter NX VMS port in the Port field, 7001 by default
  4. Enter the NX user login and password
  5. Enter the required NX camera ID
  • To learn more about the configuration of other parameters while adding a video stream, refer to our Manage Cameras documentation.
  • The data for the Host, Port, Login, and Password fields can be found on the NX VMS authorization screen.
  • Please avoid using the user's password with special symbols such as: "!@#$%^&*()", as it may lead to errors. Symbols "." and "-" are allowed.
  • The NX user login must be in lowercase when entered in the VEZHA system.
  • The NX user whose credentials are used for adding the video stream must be:
    • Assigned all permissions for this video stream in NX VMS.
    • Allowed to use digest authentication in NX VMS, as digest authentication enables this user to retrieve the video stream from NX VMS securely.

To find the required NX camera ID, in the NX VMS navigate to Servers on the sidebar and proceed with the following steps:

  1. Right-click the desired camera
  2. Select the Camera Settings option from the context menu
  3. Click the Arrow icon or More Info button to reveal the required information block in the General tab of the Camera Settings pop-up window
  4. Copy the selected NX camera ID

User Digest Authentication

To allow the digest authentication for the desired user, in the NX VMS open the System Administration settings ( press Ctrl+Alt+A) and proceed with the following steps:

  1. Select the Users tab in the System Administration pop-up window
  2. Click the required user in the table to open the User Settings pop-up window
  3. Click the "⋮" icon and select Allow Digest Authentication for This User from the context menu
  4. Renew the user password
  5. Click the Apply button to save changes
  • The caption "The User Can Use Digest Authentication" in the User Settings pop-up window indicates that digest authentication has already been allowed to the selected user.
  • Please avoid using the user's password with special symbols such as: "!@#$%^&*()", as it may lead to errors. Symbols "." and "-" are allowed.

Web Plugin Connection

To connect VEZHA plugins as web integration, log in to your NX VMS, navigate to Web Pages on the sidebar, and proceed with the following steps:

  1. Right-click the Web Pages section
  2. Select the Add Web Page option in the context menu

In the Add Web Page pop-up window, proceed with the following steps:

  1. In the General tab, fill in the fields:
    • Enter the URL in the following format: "http://your_server_ip_address:port/plugin_name/default_page_name?mode=nx&login=your_vezha_login&password=your_vezha_password"
    • Enter the desired plugin name
  2. In the Advanced tab check the Allow Using Client API checkbox 
  3. Click the Ok button
  • The URL-address example: http://111.22.33.44:2001/alpr/search?mode=nx&login=login&password=password 
  • The list of available plugin's plugin_name/default_page_name parameters comprises:
    1. Age & Gender Detection: "gender_age/report"
    2. Face Recognition: "face/search"
    3. Gun Detection: "gun_detection/events"
    4. Hard Hat Detection: "hardhat/events"
    5. LPR: "alpr/search"
    6. Motion Detection: "motion/events"
    7. Object Detection: "object_in_zone/events"
    8. Pose Estimation: "fallen_people/events"
    9. Smart Parking: "parking/analytics"
    10. Smart Tracking System: "person_reid/search"
    11. Smoke & Fire Detection: "smoke_fire/events"
    12. Traffic Analytics: "traffic/events"
    13. UIC & Container: "railroad/search"
  • Checking the Allow Using Client API checkbox is mandatory, as it allows interaction with HTTP API and sending commands for opening the archive.

To edit the plugin connection settings, right-click the required plugin in the Web Pages menu and select the Web Page Settings option from the context menu.

Web Plugin Utilization

Once the required plugin is connected, it becomes available within the Web Pages section. To open the required plugin, hold and drag it to the Layout and patiently wait for the VEZHA authorization process to complete:

Once VEZHA authorization is complete, the desired plugin opens in the Layout and is ready for use.

The web plugin interface resembles the VEZHA Analytics System. All available plugin sections are positioned at the top of the page, as illustrated in the example:

To view the required event playback from the Search section, follow these steps:

  1. Select the desired record
  2. Click its frame preview on the right side of the page
  3. See the event playback in the new tab

To view the required event playback from the Events section, follow these steps:

  1. Click the View icon next to the required event
  2. See the event playback in the new tab
To view the desired event playback, the video stream must be associated with the required NX camera.

If the required video stream is not associated with the NX camera, the Event Information pop-up window will be opened, as it usually does in the VEZHA Analytics System, as NX VMS cannot get the video archive from non-associated video streams. An example of the Vehicle Information pop-up window is shown in the picture below: