In a Windows domain a create a domain user account. The domain account can be used on all computers in the domain. In a Windows workgroup environment create a local user account with the same name and password on all computers where Video API service and Siveillance VMS are running.

In the following documentation the username VideoApiService is used for the Video API service user account.

The username is used to create the service during installation through the InstallVideoApi.msi installer.

For more information refer to the Video API documentation that can be found in the documentation folder of the release bundle.

If the username or password need to change later, use the Services program of Windows.

The used user account must be added in the VMS management client to the administrator role. For more information refer to: Configuring VMS Permissions for the Video API Service User Account.

Configuration Hints

Name Change after Service Installation

If the machine name or service username or any of the BaseAddress parameters in the VideoApiService.exe.config change after the service is installed, the following command must be performed in the installation directory with Administrator rights:

VideoApiService.exe -setupsecurity [computername\user] [password]

 

Missing File Permissions in the Installation Folder

Sometimes you find that you cannot connect to the restarted Video API service. Most likely this is due to missing file permissions in the installation folder of the service. Check the file permissions as follows:

  1. In the file explorer, right-click the Siemens folder and choose Properties.
  1. In the Security tab, select the Video API service account and click Edit.
  1. The Video API service account needs the right to modify and write files in the folder and subfolders of %PROGRAMDATA%\Siemens:

 

Password Change

If a password change is done later, for example following a password policy, it must be done on all computers where Video API is installed. This is done automatically in a domain and needs to be done manually for all local accounts in a workgroup.