Integrations
Integrating with NX Witness
welcome! this is the alarm filter's guide on how to integrate with network optix's nx witness vms follow the information below to help you get started before you begin! ensure that you have the following installers to nx witness' vms server and desktop client a download of the opengl emulator library, version 23 1 0 installing the vms server & desktop client first, run the installation from the download releases from https //meta nxvms com/download/releases/windows https //meta nxvms com/download/releases/windows run the server, localhost 7001, with client set to ui app stop the server as a powershell admin this can also be done in the server gui at localhost 7001 as well stop service name metavmsmediaserver then unzip the plugin folder with plugin dll be sure to extract all of the dependencies to where the server is installed c \program files\network optix\nx meta\mediaserver\plugins\\ after, start up the server start service name metavmsmediaserver api on the server is available on (for localhost) https //localhost 7001/#/api tool/main?type=1 https //localhost 7001/#/api tool/main?type=1 ⚠️ if the nx client is installed on a vm, it might not work without a workaround you can first try to start the desktop client without the workaround download the opengl emulation library (version 23 1 0) to decide which package you need, msvc or mingw, please check the readme md documentation extract the archive to a folder copy opengl32 dll, libglapi dll, and libgallium wgl dll files paste the copied files to the folder where the nx desktop executable is located open cmd and enter this command to create the environment variable to enable opengl software rendering setx gallium driver llvmpipe nx client setup set up rules to choose events to send to the alarm filter add event rules by right clicking a camera, and then, click on camera rules in the context menu this opens the dialog below select an event of your choice, action should be http request to “irisityalarmfilter” this will connect event and plugin action that the request is sent when event happens is not of importance the important thing is that the rule details in the server contains “irisityalarmfilter” so the plugin to know which events to search for in server while processing frames possible to add multiple rules to a camera possible to add multiple cameras to a rule to see more info add rule diagnostic event, action show desktop notification configure plugin go to menu > system administration > plugins this is the location where the api key is entered one api key identifies the account in the irisity alarm filter in which the alarms are to end up one api key for all cameras camera settings toggle plugin on or off, primary or secondary stream nx might require to “enable recording” in camera settings or view the camera for nx to send frames to plugin how the plugin works the plugin operates in the following manner the alarm filter requires 3 frames when the event happens one second before the event happens same second and one second after the event happens when the plugin starts, this process will start up on the camera the plugin starts on the plugin will also make a one time search for a string "irisityalarmfilter" within the nx server rules, which will also then find the rule id in summary, for each camera the plugin runs on, it will find the rule id if the string matches other important notes this integration is currently compatible with nx server version 6 the ids of the cameras from the nx witness' guid are generated from the camera itself, which means that it will be the same if the camera is removed from one server to another