To configure the VMS integration, you have to configure and establish the VMS connection. Afterwards, you have to process remaining tasks in order to enable data activation on the runtime client.
Creating the VMS Connection
- The hostname of the Video API service is resolvable by the Siveillance Control servers. If it cannot be resolved the host IP address has to be resolved manually. For more information refer to: Resolving the Host IP Address.
- The certificate has been installed on the Siveillance Control servers. For more information refer to: Importing the Video API Certificate to the Siveillance Control Servers.
- The token for the API authentication has been enabled and noted during installation of the Video API. For more information refer to: Installing the Video API on the VMS Server.
- Start the engineering client.
- Open the Video Configuration perspective.
- Right-click in the Video Configuration tree and select Create VMS Connection. Only one VMS connection is supported. If a VMS connection already exist, you cannot select this option.
- Enter the following information:
- Instance Name: Enter a name.
- Server URL: Enter https://[machine name]:[port number], where [machine name] is the name of VMS server and [port number] is the number of the port in which Video API accepts incoming connection. Default port number is 7442.
- Authentication Token: Enter the authentication token. Copy and paste the REST API token, that was created during installation of the Video API. Refer to Installing the Video API on the VMS Server.
- To enable the internal video player, mark the Use internal player check box.
- To synchronize only cameras that are in active state, the Synchronize only active cameras checkbox is enabled by default. Unmark the checkbox if you want to synchronize the active and inactive cameras.
- Click Finish.
- Right-click the newly created VMS connection and select Verify connection.
- The connection is verified. The info line displays whether the connection is available.
Editing the VMS Connection
- The Video Configuration perspective is displayed.
- Right-click in the Video Configuration tree and select Edit VMS Connection.
- Enter your changes.
- Click Finish.
- Right-click the VMS connection and select Verify connection.
- The connection is verified. The Info Line displays whether the connection is available.
Establishing the VMS Connection
- The defaultDisciplines.mox file has been imported to Siveillance Control in the configuration phase.
- Open the Video Configuration perspective.
- Right-click the VMS connection and select Synchronize VMS Connection.
- Camera data, recording server data and trigger data are imported.
- If the default disciplines are available, the camera discipline, recording server discipline and the trigger discipline are set automatically while discovering them.
- The imported camera data does not include positions.
- A certain number of tasks categorized as error are displayed in the Tasks view based on the number of synchronized cameras.
- Right-click the VMS connection and select Connect.
- The connection is established and the VMS connection icon turns green.
Device Mapping after Video API Migration
To retain the VMS cameras, VMS recording servers and VMS triggers in the location tree after video API migration, perform the device mapping in the following order. Please make sure that the VMS Connection is mapped at last.
- VMS Cameras
- VMS Recording servers
- VMS Triggers
- VMS Connection
To retain the VMS cameras, perform the following device mapping steps:
- An upgraded version of Video API has been migrated in the VMS. For more information refer to: BackupRestoreOfVideoAPIConfiguration.pdf provided in coresdk-****.zip.
- After migration, a second VMS connection is created, and the data are synchronized.
- The Device Mapping perspective is displayed.
- In the Candidate From section,
- Select VMS Camera from the MOT drop-down list.
- Select VMS Synchronization from the Data Source drop-down list.
- In the Candidate Into section,
- Select VMS Camera from the MOT drop-down list.
- Select New VMS Camera Synchronization from the Data Source drop-down list.
- In the Candidate From section, click Transfer.
- In the Transferred Attributes dialog,
- Select Move from the Handle references drop-down list.
- Click Ok.
- In the Candidate From section, click Device Mapping: not selected.
- In the Device Mapping Attribute and Pattern Selection dialog,
- Select Instance Name (Base Object Type) from the Device Mapping Attribute drop-down list.
- Enter the pattern, for example .*-\s*(.*)$ from the Device Mapping Pattern drop-down list.
- Click Ok.
- In the Candidate Into section, click Device Mapping: not selected.
- In the Device Mapping Attribute and Pattern Selection dialog,
- Select Instance Name (Base Object Type) from the Device Mapping Attribute drop-down list.
- Enter the pattern, for example .*-\s*(.*)$ from the Device Mapping Pattern drop-down list.
- Click Ok.
- The list of all available VMS cameras is displayed.
- Ensure that the listed cameras are not duplicated with the same instance names.
- If a duplicate exists, you have the following options to change the instance name for any one of the cameras:
- Open the Video Configuration perspective.
- Select Group of VMS Cameras > [Camera].
- In the Object Properties view, edit the instance name.
- Open the Device Mapping perspective and perform the steps 1 to 8 again.
- Click Autocorrelate.
- Click Commit Merge.
- All the related cameras can be seen in the location tree.
- After device mapping, only the latest VMS connection is retained.
- To delete the error messages from the Tasks view, you have the following options:
- Open the System Tree in the Engineering perspective or the Video Configuration tree in the Video Configuration perspective.
- The Tasks view displays all error messages for group of VMS cameras, group of VMS recording servers, and group of triggers.
- In the Objects view, select Group of VMS Cameras from the Base Interactive Object drop-down list.
- The groups available for the VMS cameras are displayed.
- Select any one of the groups of VMS cameras.
- The selection automatically highlights the corresponding group in the System Tree or in the Video Configuration tree.
- Right-click the other group from the list in the Objects view and select Delete Object(s) from Database.
Keep in mind that you need to delete the group which does not get highlighted when you make the selection.
- Select Group of VMS Recording Servers or Group of VMS Triggers from the Base Interactive Object drop-down list and perform the steps mentioned in 14 again to delete the error messages for the corresponding groups.
- Perform the following steps to delete the second VMS connection:
- Open the Engineering perspective or the Video Configuration perspective.
- In the System Tree or in the Video Configuration tree, right-click the second VMS connection and select Delete Node(s).
- To retain the VMS recording servers, VMS triggers and VMS connection, repeat the steps above with the values given in the following table.
| Candidate From | Candidate Into | ||||||
| MOT | Data Source | Device Mapping Attribute | Device Mapping Pattern | MOT | Data Source | Device Mapping Attribute | Device Mapping Pattern |
VMS Recording Servers | VMS Recording Server | Old VMS Recording server synchronization | External ID (Base Object Type) | .*/\s*(.*)$ | VMS Recording Server | New VMS Recording server synchronization | External ID (Base Object Type) | .*/\s*(.*)$ |
VMS Triggers | VMS Trigger | Old VMS Trigger synchronization | External ID (Base Object Type) | .*/\s*(.*)$ | VMS Trigger | New VMS Trigger synchronization | External ID (Base Object Type) | .*/\s*(.*)$ |
VMS Connection | VMS Connection | Old VMS Connection synchronization | External ID (Base Object Type) | .*/\s*(.*)$ | VMS Connection | New VMS Connection synchronization | External ID (Base Object Type) | .*/\s*(.*)$ |
Processing Tasks
- The VMS has been connected.
- In the Tasks view, click
Refresh.
- For every camera, a task Object does not appear in Location Tree appears in the Tasks view. The task is categorized with the severity level error.
- You have the following options:
- Position all cameras in the Location Tree. Or
- Change the preference for validation of VMS cameras in the Location Tree.
- If you do not want to add the cameras in the Location Tree and to proceed for activation of data in the runtime client, perform the following steps:
- In the menu bar, select Window > Preferences.
- Select Siveillance Control > Locations.
- Make sure that Validate Presence of VMS Cameras in Location Tree checkbox is not activated.
- Click Ok.
- The severity level of the tasks is re-categorized from errors to warnings.
Deleting the VMS Connection
- Engineering client has been started.
- Two VMS connections exist.
- Open the Video Configuration perspective.
- Right-click the VMS connection that you want to delete and select Delete Object(s) from Database.
- When you delete a VMS connection, all related cameras, triggers and recording servers are also deleted.
Activating Data in the Runtime Client
After setting up the VMS connection in the engineering client, you have to activate it in the runtime client.
NOTICE
If more than one VMS connection exists, any one VMS connection must be deleted before activating data in the runtime client. For more information on deleting the VMS connection, refer Deleting the VMS Connection.
- Make sure that no errors are displayed in the Tasks view. For more information on removing errors, refer Processing Tasks.
- Start the runtime client.
- Click
Activation.
- Enter the following information:
- The hostname and site name of the engineering system
- Your authorization data (username and password).
- Click Next.
- A data validation operation is carried out on the engineering server.
- Click Finish.
- The configuration is transferred to the runtime server.
- All operations on cameras and triggers are also available on the runtime system.