Auto-provisioning algorithms
Auto-provisioning is carried out according to the following sequential algorithm.
Create a new location
To create a new location, the following is required:
Interaction of VMS with the customer billing system.
Availability of the code in the code database of the customer address system.
The algorithm for creating a new location:
Once a new contract is signed and added to the customer system, a request to create a new location is sent to VMS from the operator’s billing system.
The request must contain the user code and contract number.
A new location is created in VMS.
The Administrator interface features a camera tree where new locations (addresses) are created according to the code. Within these locations, cameras can be assigned to users based on their contract numbers through dedicated tabs. For details, see View, add and edit camera data documentation section.
Create a camera instance
To create a camera instance, the following is required:
Interaction of VMS with the customer billing system.
The camera must be added to the customer equipment control system.
The auto-provisioning procedure must be enabled.
The algorithm for creating a camera instance:
A new camera appears in the customer network equipment control system.
A request to create a NetworkDevice instance is sent from the operator billing system to VMS.
The request must include the camera MAC address and serial_number.
A new NetworkDevice entity is created in VMS:
For a camera with a new MAC address and
serial_number, a UUID is generated.The data is displayed in the Administrator interface in the Provisioning > Network Devices section.
Create a camera profile and configure the archive storage days
To create a camera profile, the following is required:
Interaction of VMS with the customer billing system.
The camera is added to the CRM/CMS system.
The auto-provisioning procedure is enabled.
The algorithm for creating a camera profile:
A request to create a new camera is received from the customer billing system, along with a code for setting the archive retention period.
VMS determines the action:
Create a new camera. The algorithm for creating a profile for a new camera continues.
Replace a camera. The algorithm proceeds to the steps for camera replacement.
VMS checks the validity of the camera instance (NetworkDevice).
If the camera entity is invalid, it must be recreated. For more information, see the steps in Create a camera instance above.
The camera profile is created. The camera profile is displayed in the Administrator interface on the General data tab when viewing the camera details.
VMS checks for the code and possible changes in it.
The camera entity and camera profile are created in the corresponding location.
On the General data tab, the method of camera provisioning is specified: Source: auto – an automatic camera provisioning method via auto-provisioning.
The camera replacement algorithm:
A request to create a new camera is received from the customer billing system, along with a code for setting the archive retention period.
VMS determines the action:
Create a new camera. The algorithm for creating a profile for a new camera continues.
Replace a camera. The algorithm proceeds to the steps for camera replacement.
VMS searches for the camera in the specified location. The camera must be available for replacement. The search is carried on:
Camera name.
Camera MAC address.
serial_number.
An attempt is made to update the camera reservation, camera profile and camera instance NetworkDevice.
On the General data tab, the method of camera provisioning is specified: Source: auto – automatic camera provisioning method via auto-provisioning.
The camera data is updated, the basic NTP configuration is set for the camera.
All necessary data is cleared on DHCP servers.
The archive retention period configuration:
The request to create a camera is accompanied by a code for setting the archive retention period, received from the customer billing system.
If the archive configuration code is empty, the archive retention period is automatically set to 30 days.
The following services are available:
30 days of archive retention.
Additional 10 days (increases the number of days to 40).
Additional 30 days (increases the number of days to 60).
Additional 60 days (increases the number of days to 90).
Decrease the archive retention period by 15 days (reduces the number of days to 15).
The services can be modified if necessary.
When a camera is automatically added, the field for the archive retention period in the camera settings becomes unavailable for modification. For details, see the General data documentation article.
Assign an IP address for the camera
To assign an IP address for the camera, the following is required:
The camera must be connected to the data transmission network designated for the service.
IP address pools for DHCP servers must be configured. For details, see the DHCP subnet groups documentation article.
In VMS, the following camera data is available:
A camera MAC address.
serial_number.
The auto-provisioning procedure must be enabled.
The algorithm for assigning an IP address for the camera:
VMS receives a request from the DHCP server. The request contains the following information about the connected camera:
A camera MAC address.
A camera IP address.
The DHCP server allocates an IP address.
VMS searches for the device in its database based on the MAC address and IP address.
VMS checks the current IP address of the device.
If the device has an IP address, the algorithm proceeds to configure streams and apply settings for the replaced camera. For details, see below Create video streams and Apply configurations sections.
The IP address is reserved in the DHCP server.
An entry for the IP address is added to the NetworkDevice.
An entry for DHCP option 82 parameters is added to the camera profile.
Once this auto-provisioning stage is completed, manual addition of video streams unavailable within the next 5 minutes.
Set up video streams
To set up video streams, the following is required:
The camera must be connected to the data transmission network designated for the service.
IP address pools for DHCP servers must be configured. For details, see the DHCP subnet groups documentation article.
In VMS, the following camera data is available:
A camera MAC address.
serial_number.
The algorithm for setting up video streams:
VMS receives video streams via the ONVIF protocol.
VMS connects to the camera via the ONVIF protocol.
A request is made to obtain RTSP links for video streams.
The automatic video stream capture mechanism is initiated.
VMS selects a media server for setting up video streams.
The high-quality and standard-quality video streams are set up.
The algorithm for setting up video streams for a replaced camera:
The camera is connected via the ONVIF protocol.
A request is made to obtain RTSP links for video streams.
The high-quality and standard-quality video streams are set up.
Apply configurations
To apply configurations, the following is required:
The camera must be connected to the data transmission network designated for the service.
IP address pools for DHCP servers must be configured. For details, see the DHCP subnet groups documentation article.
In VMS, the following camera data is available:
A camera MAC address.
serial_number.
The algorithm for applying configurations:
VMS communicates with the camera via the ONVIF protocol.
VMS retrieves camera data:
A vendor
A model
A configuration for the camera is selected. Configurations of the following types are chosen:
'OSD_Time''OSD_Text''VideoEncoder_Second''VideoEncoder_First''NTP'A camera model
A camera manufacturer
Application of configurations.
Configuration application for replaced cameras follows the same algorithmic process as for new cameras.
Remove the camera
The camera is removed at the user's request, if necessary.