video integration 1.1 installation guide and release...

of 20

Video Integration 1.1 Installation Guide and Release Notes Copyright© 2014-2015, Identiv. Last updated January 9, 2014.

Overview This document provides information about version 1.1 of the Hirsch Video Integration, which is a separately licensed software product that provides the interface between Velocity 3.5 SP2 and a digital video recorder (DVR) or network video recorder (NVR). The following plug-ins are available to support a particular manufacturer's model of DVR or NVR:

• The Aventura plug-in supports an Aventura Technologies Hybrid DVR which is controlled by version 8.5.1.14194 or later of Aventura's Video Management System, and uses version 8.5.1.14080 or later of Aventura's SDK.

• The American Dynamics plug-in supports either an Intellex DVR which is controlled by version 5.02 or later of American Dynamics's Intellex Video Management System and Network Client and uses version 9.0.597.79 or later of American Dynamics's SDK, or a VideoEdge NVR which is controlled by version 4.5.0.698 or later of American Dynamics's Victor Video Management System and uses version 9.0.597.79 or later of American Dynamics's SDK.

After you license and install this integration, it extends the Velocity user interface to include numerous features which are documented in a context-sensitive help system that is delivered in a file named VideoIntegration.chm. Be sure to read that help system for important information about how to configure and use this integration.

In this document, there is information about:

• System Requirements

• Licensing and Installing this product

• the New Features and Enhancements, the Bug Fixes, and the Known Issues in this release

System Requirements Besides this Hirsch Video Integration (and either the Aventura plug-in or the American Dynamics plug-in), your system must include the following components:

• A physical access control system with various hardware components controlled by version 3.5 SP2 of the Hirsch Velocity security management system software

• A video surveillance system with cameras connected to either:

an Aventura DVR that is controlled by version 8.5.1.14194 of Aventura’s Video Management System software (and uses version 8.5.1.14080 of Aventura’s SDK)

an Intellex DVR which is controlled by version 5.02 or later of American Dynamics's Intellex Video Management System and Network Client and uses version 9.0.597.79 or later of American Dynamics's SDK

a VideoEdge NVR which is controlled by version 4.5.0.698 or later of American Dynamics's Victor Video Management System and uses version 9.0.597.79 or later of American Dynamics's SDK

of 20

Licensing and Installing this Product Before you can install the Hirsch Video Integration (and a DVR plug-in) on your Velocity Server, you must obtain a separate license and activate it using Velocity’s License Manager. After installing the integration, you must also perform a few configuration and setup tasks.

NOTE: The Hirsch Video Integration (and a DVR plug-in) only needs to be installed on your Velocity Server. Any remote Velocity Clients will automatically try to be updated the next time they are restarted and connect to the updated Velocity Server. However, the client update will fail with an “Access Denied” message unless the Velocity operator is both a member of the Velocity Administrators group and has the Windows local Administrator privilege to install software on that computer.

Licensing the Hirsch Video Integration and DVR Plug-in

1. Contact Identiv’s Sales department to purchase a license for this video integration (and a DVR plug-in).

2. They should ask you to send them an email message containing the Server ID of your Velocity Server. (Exchanging this information via email instead of by phone ensures that it is correct, and provides us with an email address so we can send you the license key.) The Server ID is obtained from the Velocity License Manager.

A. Open the Velocity License Manager.

• If the Velocity Service Control Manager icon is displayed in the Windows taskbar, right-click on it and choose Velocity License Manager from the pop-up menu.

• If the Velocity Service Control Manager icon is not displayed in the Windows taskbar, click the upwards-pointing triangle on the left side of the taskbar to show the hidden icons for additional programs.

The Velocity License Manager displays information about the licenses for the installed components. The critical piece of information needed to obtain a license for the Hirsch Video Integration is the Server ID.

of 20

B. Click the button after the Server ID to copy that information to the Windows Clipboard, and then paste it into an email message to Identiv so we can create your license key. (If you don’t have email access on your Velocity Server, you can paste the information into a text file and transfer it between computers using a USB drive.)

C. Close the Velocity License Manager.

3. After you receive an email containing your license key, copy all the characters between the -- License Key Start -- and the -- License Key End -- lines (as shown by the yellow highlighted portion of the following screen capture).

Note that the license key is only valid on the computer with the specified Server ID; it cannot be used on a different computer.

of 20

4. If your Velocity Server is on a different computer, paste your license key into the Windows Notepad accessory, save it as a text file, and transfer it between computers using a USB drive. Make sure that the word wrap option is turned off, which is indicated by the absence of a check mark in front of the Format ▶ Word Wrap command.

5. Paste the full license key information into the Add / Renew License pane, and click the Add / Renew button.

The following dialog should be displayed.

of 20

6. Click OK to close this dialog, and then verify that the Velocity License Manager shows a new row of information about your DVR component (in this example, the Aventura Hybrid NVR).

7. Licensing of the video integration (and DVR plug-in) is now completed, so you can close the Velocity License Manager.

Installing the Hirsch Video Integration and a DVR Plug-in

1. If the Velocity Client is running on your Velocity Server, close it. (You can leave the Velocity services running, so your access control system is not interrupted.)

2. Locate and start the installer program for the Hirsch Video Integration and DVR plug-in (in this example, AventuraPlugin.exe).

The installer first verifies that your Velocity Server has a valid license for the video integration (and DVR plug-in).

3. If you forgot to close the Velocity Client, the installer displays the following dialog. If you see this dialog, close the Velocity Client, and then click the Retry button.

of 20

The installer displays various status messages while the installation proceeds.

4. When the following dialog is displayed, click the Install button.

5. When the following screen is displayed, type in the name of the Velocity services account, type in the password for that account, and click the OK button. (The name and password of the Velocity services account were specified when Velocity was installed.)

of 20

The installer displays various status messages until the installation has completed.

NOTE: If you are installing the American Dynamics plug-in, you also need to install the American Dynamics SDK. For details, see Installing the American Dynamics SDK.

6. When the following dialog is displayed, click the OK button.

7. To verify that the name and password you entered for the Velocity services account were correct, try to start the new video service by right-clicking on the Velocity Service Control Manager icon (while the other Velocity services are running) and choosing Start Velocity Video Service from the pop-up menu.

of 20

If the name and password were correct, the new service will start. If there is a problem with the name or password, the following dialog is displayed:

Installing the American Dynamics SDK If you are installing the American Dynamics plug-in, you must perform the following additional steps to install the American Dynamics SDK.

1. When the following dialog is displayed, select the desired language from the drop-down list, and click the OK button.


of 20

3. When the following dialog is displayed, click the Next button.

4. When the following dialog is displayed, select the “I accept the terms in the license agreement” option, and click the Next button.

of 20

5. When the following dialog is displayed, either click the Next button to install the SDK in the default folder, or click the Change button to open a dialog that enables you to specify a different location.

6. When the following dialog is displayed, click the Next button.

of 20


The installer displays various status messages while the installation is being performed.

of 20

8. When the following dialog is displayed, click the Finish button.

9. Return to step 7 of the main installation procedure and try to start the new video service.

Post-Installation Tasks After installing the Hirsch Video Integration (and a DVR plug-in), you will need to perform the following configuration and setup tasks.

• Add your DVR to Velocity

• Synchronize the Time for your DVR and Velocity

• Manage Role Properties

• Optional: Prevent the display of a triggered Video Explorer window (on Velocity Client computers that will never be used to view security videos)

• Define and manage trigger-action pairs (using the Trigger Action Manager)

For details about these tasks, see the context-sensitive help system that is installed with the software.

Uninstalling the Hirsch Video Integration and DVR Plug-in NOTE: The Hirsch Video Integration and DVR plug-in was designed to be installed on a Velocity Server, with any remote Velocity Clients being automatically updated the next time they are restarted and connect to the updated Velocity Server. If you ever need to uninstall the integration and plug-in, you should do it first on the server, and then on the clients.

If you ever need to uninstall the Hirsch Video Integration and DVR plug-in, perform the following steps.

1. On the Velocity Server where the Hirsch Video Integration and the DVR plug-in are installed, use the Velocity Service Control Manager to stop the Velocity Video Service, and close the Velocity Client if it is open on that computer.

2. Open the Windows Control Panel.

of 20

3. Locate the feature to uninstall a program, which varies depending on the setting of the View by: option.

• If you are viewing the Control Panel’s items as icons, then click on the Programs and Features link:

• If you are viewing the Control Panel’s items by Category, then click on the Uninstall a program link in the Programs category:

The window is updated to show all the installed programs on this computer.

of 20

4. Scroll down in the table until the Hirsch Identive Update for Aventura Plugin item is visible in the Name column, and click on it.

5. Click on the Uninstall button that now appears above the table.

If you see a message like this, then you forgot to perform Step 1 of the uninstall procedure:

In this case, perform Step 1, and then click the Retry button on this dialog.

6. In the resulting message dialog which asks if you want to remove the selected program, click on the Yes button. For example:

7. Uninstall the Hirsch Identive Velocity Video Framework program:

A. Scroll down in the table until the Hirsch Identive Velocity Video Framework item is visible in the Name column, and click on it.

B. Click on the Uninstall button above the table.

C. In the resulting message dialog, click on the Yes button.

8. Close the Windows Control Panel.

of 20

New Features and Enhancements in this Release Version 1.1 of the Hirsch Video Integration supports a new American Dynamics plug-in that works with either an Intellex DVR or a VideoEdge NVR. It also includes the following new features and enhancements.

Reference ID Summary Description

VELVID-51 An open Video Explorer window for a particular camera or view group is now reused.

When a defined trigger occurs, it performs the specified action of opening a Video Explorer window to display the live video from a particular camera or view group. Previously, a new Video Explorer window was opened for each alarm trigger, even if a Video Explorer window was already displaying the live video from the same camera or view group.

Now when a trigger occurs, if there is already an open Video Explorer window for the specified camera or view group, that window is reused and brought to the front.

VELVID-125 The Search Video window now provides a full set of playback controls.

Previously, the Search Video window provided just a Play link in the Results table, which only allowed you to play a video at normal speed from the beginning.

Now that window provides a full set of playback controls, similar to those in the Playback window (for viewing the recorded video associated with an alarm).

VELVID-128 The dialog for "Record On Camera" now includes the camera name.

Previously, the dialog that is displayed after you right-click on a camera (in the Components pane of the Velocity Administration window) and choose Record on Camera did not include the camera's name anywhere. The title bar showed only the name of the DVR, and this is a small enough dialog that there wasn't room to add the camera name in the title bar.

Now the camera name has been added to the top of the dialog's body.

VELVID-130 The Playback window (for a recorded alarm video) is now resizable and has a normal Close button.

Previously, the Playback window (which displays a recorded alarm video) was not resizable, and it did not have a normal Close button in the lower right corner (besides the small X button in the upper right corner).

Now that window is resizable and has a normal Close button. When you resize the window, it maintains its aspect ratio.

If a video is playing when the window is resized, the video continues playing at its previous size. For the video to play at its new size, you must restart the video’s playback from the beginning.

VELVID-173 The Video Explorer now shows the name of a disconnected camera.

As the Video Explorer loads the video feeds for the specified cameras in a view group into their video panes, a message in the following form is initially displayed in the video panes:

Connecting to <Camera Name> in <DVR Name>

If a camera is disconnected, the message in its video pane changes to:

<Camera Name> disconnected in <DVR Name>

of 20


VELVID-174 Add configuration option so the Record Duration field for an action can be set to 0.

Previously in the Trigger Action Manager (for the Hirsch Video Integration), the Record Duration field for an action allowed you to specify a value from 1 second to 3600 seconds. Now options have been added to the Velocity.exe.Config file, so you can specify for each type of DVR/NVR whether the Record Duration field can be set to 0 seconds, in which case the action is to perform only the specified preset camera action (without recording any video).

Here are the relevant entries in the default Velocity.exe.Config file.

For an Aventura Hybrid NVR:

 <add key="PluginAllowZeroOnRecordDuration:Aventura Hybrid NVR" value="false" />

For an American Dynamics Intellex DVR:

 <add key="PluginAllowZeroOnRecordDuration:Intellex" value="true" />

For an American Dynamics VideoEdge NVR:

 <add key="PluginAllowZeroOnRecordDuration:VideoEdgeNvr" value="true" />

Bug Fixes in this Release Version 1.1 of the Hirsch Video Integration includes the following bug fixes.


VELVID-67 Letter “n” is cut off in “Alarm Duration” last column of Hirsch Video Integration reports

In the Active Alarms with Video by Date and the Alarm Log with Video by Date reports which are provided with the Hirsch Video Integration, the “Alarm Duration” column heading was truncated so it said “Alarm Duratio”.

This issue has been fixed.

VELVID-122 Velocity crashes when the camera Preset name has the maximum length of 32 characters

Previously, while using the Trigger Action Manager, if you selected an existing trigger-action pair or a camera that included a camera Preset which had the maximum length of 32 characters, you would see an error dialog stating that “Velocity has stopped working”.

This issue was caused by a bug in the Aventura SDK, which has been fixed in version 8.5.1.14194d (and requires the same version of their Video Management System software).

VELVID-135 Aventura reports don’t have the correct results

The contents of the three new reports provided with the Hirsch Video Integration were sometimes not as expected, or the expressions shown in the Selected Criteria List pane of the Report Manager did not seem to be correct.

The reports are working as designed. Some of the unexpected results were due to the relative ASCII numeric values for uppercase versus lowercase letters.

VELVID-137 The Hirsch Video Integration Trigger Actions report lists “Camera Index” in the selection criteria, but that information does not appear in the report.

Previously, “Camera Index” was one of the choices available in the Field drop-down list on the Criteria tab of the Hirsch Video Integration Trigger Actions report, but no camera index information appeared in the report if it was included in the selection criteria.

This issue has been fixed by removing the “Camera Index” choice from the Field drop-down list, and including the camera index information within the Action column of the revised report (as explained in VELVID-230).

of 20


VELVID-181 Renaming an Aventura Hybrid NVR using its Properties dialog causes its cameras to disappear.

Previously, renaming an Aventura Hybrid NVR using its Properties dialog would cause its cameras to disappear from the System Tree pane of Velocity’s Administration window. (The cameras would reappear after you closed and reopened the Velocity client.)


VELVID-182 While viewing an existing trigger-action pair, the Preset value might be incorrect.

Previously in the Trigger Action Manager (for the Hirsch Video Integration), when you were viewing an existing trigger-action pair, the Preset value might not show the correct value. This issue happened when the set of preset camera actions defined using Aventura’s VMS did not start at 0 or skipped a number.


VELVID-226 Cameras disappear after changing the IP address of a DVR/NVR, or after disconnecting the network cable.

Previously, cameras would disappear (from the System Tree pane of Velocity’s Administration window) if the IP address of a DVR/NVR was changed, or if the network cable was disconnected. The role permissions for those cameras were also cleared after the network cable was disconnected.


VELVID-227 When a DVR/NVR was deleted, that change was not shown on other Velocity clients.

Previously, when a DVR/NVR was deleted from a Velocity client, that change was not being broadcast to the Velocity Server and the other open clients (so they could update the System Tree pane of their Administration windows).


VELVID-234 When a view group was created, that change was not shown on other Velocity clients.

Previously, when a view group was created on a Velocity client, that change was not being broadcast to the Velocity Server and the other open clients (so they could update the View Groups drop-down list in their Video Explorer windows).


VELVID-249 After switching operators, the Hirsch Video Integration was not updating its operator information.

After switching operators in a Velocity client, the Hirsch Video Integration was not updating its operator information and reloading the set of devices that should be visible to the current operator’s roles.


VELVID-251 The Event Viewer showed the server’s workstation name for some actions performed at a remote client.

Previously, the Event Viewer showed the server’s workstation name (instead of the client’s workstation name) when a view group, trigger-action pair, or DVR/NVR was added, updated, or deleted from a remote client.


VELVID-264 After renaming a DVR/NVR, you cannot immediately right-click on any of its cameras.

After renaming a DVR/NVR in Velocity’s Administration window (by right-clicking on it and choosing the Rename command on the pop-up menu), you could not immediately right-click on any of its cameras in the Components pane. Before you could right-click on a camera, you had to click on the renamed DVR/VNR to ensure it was properly selected.


VELVID-268 After switching from an operator whose role does not have permission to view a specific camera, an Administrator is also denied access to that camera.

After a Velocity client was switched from an operator whose role does not include the permission to view a specific camera to an Administrator (who has full permissions), the Administrator is also denied access to that camera.


of 20


VELVID-278 Some windows or dialogs do not properly display non-US date formats.

Previously, the Hirsch Video Integration was not correctly displaying non-US date formats on the following windows or dialogs:

• Search Video window

• Recorded Alarm Video dialog

• Playback window


VEL-3226 Operators without permission to the Administration window are not able to see Aventura cameras they have permission to

Previously, operators with the device permission to see a specific camera could not do so unless they also had the Application Permissions ▶ Administration Window ▶ Administration Window - Use role permission.


VEL-3270 “Aventura Plugin Update” gets removed from SQL database after uninstalling Aventura Plugin from a client

Previously, if you uninstalled the Aventura DVR plug-in from a Velocity Client, it removed it from the Velocity Server’s SQL database, so it was no longer available to any client.


VEL-3271 Cancelling an Aventura update doesn’t try to install it again the next time you launch Velocity and Help About shows the build that was cancelled

Previously, if you cancelled the installation of an update to the Aventura plug-in, the next time you launched Velocity there was no message informing you that the update had been cancelled, and the Help ▶ About command mistakenly showed the build number of the cancelled update.


Known Issues with the Hirsch Video Integration (or Velocity) Reference ID Summary Description

VELVID-10 Multiple “Record on Camera” windows can be opened for the same or different cameras

The dialog that is displayed after you right-click on a camera and choose Record on Camera is not a modal dialog, so you can open multiple instances of this dialog for various cameras. This can be confusing because the dialog does not include the camera’s name anywhere. (Instead, only the DVR’s name appears in the title bar.)

There is no workaround for this issue. Normally, this is not a problem because you should quickly specify two parameters and click OK to close the dialog. (If you got interrupted and did not remember which camera’s live feed you were going to record, you can click Cancel.)

VELVID-29 Trigger Action Manager and Search Video Events windows cannot be closed if the New DVR/NVR window is open

The Add New DVR/NVR dialog and the DVR/NVR Properties dialog are modal dialogs launched from Velocity’s Administration window. While either of these dialogs is open, you cannot close the Trigger Action Manager or the Search Video window.

There is no workaround for this issue. When you are done using one of these dialogs, close it. If you need to obtain more information (such as the IP address) to accomplish your task, close the dialog and perform the task later after you have the necessary information.

VELVID-52 All zeros are accepted in the IP address field when adding a new DVR

When you add a new DVR or NVR to Velocity (using the Hirsch Video Integration’s Add New DVR/NVR item in the Administration window), the dialog’s IP field accepts the default value of 0.0.0.0 for the IP address of the DVR or NVR.

The workaround is to enter the correct IP address for your DVR or NVR. (Before adding a DVR or NVR, see “Adding Your DVR to Velocity” in the integration’s help system.)

of 20


VELVID-108 When deleting a DVR, there is no warning message informing you that all Trigger Actions associated with that DVR will also be deleted

When you delete an Aventura DVR from the Hirsch Video Integration, there is no dialog warning you about the consequences of that action.

There is no workaround for this issue. (Before deleting a DVR or NVR, see “Deleting a DVR” in the integration’s help system.)

VELVID-126 Hirsch Video Integration Trigger Actions Report does not populate the preset name only the number

The “Hirsch Video Integration Trigger Actions” report shows only a number in the camera Preset column, instead of the number and the name.

There is no workaround for this issue. However, the number and name of the camera presets can be viewed in the Preset drop-down list for a selected camera in the Trigger Action Manager, and in the Preset drop-down list on the dialog that appears after you right-click on a camera in the Components pane of Velocity’s Administration window and choose the Record on Camera command.

VELVID-132 Operators without permissions to cameras are able to select them when creating a Trigger Action in the HVI Trigger Action Manager

When adding a new trigger-action pair in the Trigger Action Manager, the Locations tree and the Cameras tree display all the cameras, instead of just the cameras that the operator has permission to use.

There is no workaround for this issue. However, defining trigger-action pairs is typically a task that is performed by a dealer or administrator; most operators should not have the Application Permissions ▶ Velocity ▶ Trigger Action Manager - Use role permission.

VELVID-230 Online help has an outdated screen capture of a Trigger Actions report.

In the “Generating Reports about Alarm Videos and Trigger Actions” topic of the Hirsch Video Integration’s online help system, the screen capture of an example Trigger Actions report is outdated. That screen capture shows separate Record Duration and Preset columns, which have been combined into a single Action column that has rows for the Camera Index, Preset, and Record Duration information.

VELVID-277 If the Velocity Video Service is restarted, any object that was being edited becomes unlocked.

If you restart the Velocity Video Service, any Velocity objects (such as a person or a credential) which were locked because they were being edited in a client are unlocked.

There is no workaround for this issue.

of 20


VELVID-279 After the Velocity Video Service is restarted, the Alarm Viewer is slow to display the video icon for the first triggered action.

After the Velocity Video Service is restarted, it can take about a minute for the Alarm Viewer to display the video icon for the first triggered action. (The video icon is quickly displayed for subsequent triggered actions.) This happens on an American Dynamics DVR/NVR which has a disconnected camera.

The workaround is to use the American Dynamics software to delete any disconnected cameras (as shown in the following screen capture) after the Velocity Video Service has been restarted.

Known Issues with American Dynamics’s SDK Reference ID Summary Description

VELVID-266 When an AD VideoEdge NVR is disconnected, Velocity cannot detect that event.

When an American Dynamics VideoEdge NVR is disconnected, the event cannot be detected by Velocity, so no event will be logged or displayed.

This issue is caused by a bug in the American Dynamics SDK, which has been fixed in version 9.1.666.58. There is currently no workaround, because version 1.1 of the Hirsch Video Integration uses version 9.0.597.79 of the American Dynamics SDK.

video integration 1.1 installation guide and release...

Documents