Auto-Provisioning Algorithm and Methods

Autoprovisioning is carried out according to the following sequential algorithm.

Creating a new location

To create a new location you need:

• Interaction of VMS with customer billing

• Availability of the code in the customer address system code database

Algorithm for creating a new location:

• After concluding a new contract in the customer’s system, a request is received from the operator’s billing system to VMS to create a new location

The request must consist of the user code and contract number.

• A new location is created in VMS

• In the administrator interface in the camera server, a new location (address) is created according to the code. At this address, it is possible to add cameras to users by agreement number in the appropriate tabs (for more details, see «View, add and edit camera data»)

Creating a camera entity

To create a camera entity you need:

• Interaction of VMS with customer billing

• The camera must be added to the customer's equipment monitoring system

• The autoprovisioning procedure must be enabled

Algorithm for creating a camera entity:

• A new camera appears in the customer’s network equipment motion control system

• A request comes from the operator billing to VMS to create a NetworkDevice entity

The request must include the camera's 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 (see «Glossary»)

  • The data is displayed in the administrator interface in the «Provisioning» → «Network Devices» section

Creating a camera profile and configuring the archive storage days

To create a camera profile, the following steps are necessary:

• Interaction between the VMS and the customer's billing system

• The camera is added to the CRM/CMS system

• The autoprovisioning procedure must be enabled

Algorithm for creating a camera profile:

• A request is received from the customer's billing system to create a new camera, along with a code for setting the archive retention period

• The VMS checks what needs to be done:

  • Create a new camera, and the algorithm for creating a profile for a new camera continues

  • Replace a camera, and the algorithm proceeds to the steps for camera replacement

• The VMS checks the validity of the camera entity (NetworkDevice)

If the camera entity is not valid, it is recreated (for more information, see «Creating a camera entity»).

• The camera profile is created. The camera profile is displayed in the administrator interface under the «General data» tab when viewing the camera

• The VMS checks for the presence and possible changes in the code

• 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, automatic camera provisioning method through auto-provisioning

Camera replacement algorithm:

• A request is received from the customer's billing system to create a new camera, along with a code for setting the archive retention period

• The VMS checks what needs to be done:

  • Create camera, the algorithm proceeds to the procedure for creating a new camera profile

  • Replace the camera, the algorithm for replacing the camera continues

• The VMS searches for the camera in the specified location. The camera must be available for replacement. The search is performed based on:

  • Camera name

  • Camera MAC address

  • serial_number

• An attempt is made to update the camera reservation, camera profile and camera entity NetworkDevice

• On the «General data» tab, the method of camera provisioning is specified:

  • Source: auto, automatic camera provisioning method through auto-provisioning

• The camera data is updated, and the basic NTP configuration is set on the camera

• All necessary data is cleared on DHCP servers

Archive retention period configuration:

Along with the request to create a camera, a code for setting the archive retention period is received from the customer's billing system.

If the archive configuration code is empty, the archive retention period is automatically set to 30 days.

The following services are provided:

• 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 inaccessible for modification (see «General data»).

Obtaining an IP Address by the camera

To obtain an IP address for the camera, the following steps are necessary:

• The camera must be connected to the data transmission network designated for the service

• DHCP server IP address pools must be configured (see «DHCP subnet groups»)

• The VMS has the camera data available, including:

  • Camera MAC address

  • serial_number

• The autoprovisioning procedure must be enabled

Algorithm for obtaining an IP address by the camera:

• The VMS receives a request from the DHCP server containing the following information about the connected camera:

  • Camera MAC address

  • Camera IP address

  • DHCP option 82 parameters (see «Glossary»)

• The DHCP server allocates an IP address

• The VMS searches for the device in its database based on the MAC address and IP address

• The VMS checks the current IP address value of the device

If the device has an IP address, the further algorithm proceeds with setting up streams and applying configurations for the replaced camera (see «Creating video streams» and «Applying configurations»).

• 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

After completing this auto-provisioning stage, manual addition of video streams is not possible for the next 5 minutes.

Creating video streams

To set up video streams, the following steps are necessary:

• The camera must be connected to the data transmission network designated for the service

• DHCP server IP address pools must be configured (see «DHCP subnet groups»)

• The VMS has the camera data available, including:

  • Camera MAC address

  • serial_number

Algorithm for creating video streams:

• The VMS receives video streams via the ONVIF protocol

• The 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

• The VMS selects a media server for setting up video streams

• The high-quality and low-quality video streams is set up

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 low-quality video streams is set up

Applying configurations

To apply configurations, the following steps are necessary:

• The camera must be connected to the data transmission network designated for the service

• DHCP server IP address pools must be configured (see «DHCP subnet groups»)

• The VMS has the camera data available, including:

  • Camera MAC address

  • serial_number

Algorithm for applying configurations:

• The VMS communicates with the camera via the ONVIF protocol

• The VMS retrieves camera data, including:

  • vendor

  • model

• A configuration for the camera is selected for application. Configurations of the following types are chosen:

  • 'OSD_Time'

  • 'OSD_Text'

  • 'VideoEncoder_Second'

  • 'VideoEncoder_First'

  • 'NTP'

  • Camera model

  • Camera manufacturer

• Applying configurations

The algorithm for applying configurations for a replaced camera follows the same steps as the algorithm for applying configurations for a new camera.

Removing the camera

The camera is removed at the user's request, if necessary.