SAFR Avigilon Integration Guide

Integrated SAFR Avigilon is only available on Windows.

Integrating SAFR's facial recognition and analysis capabilities into Avigilon enables you to use SAFR's video feed information overlays within Avigilon's camera video feeds, thus making it much easier to quickly and accurately separate unknown people from authorized people from known threats. You'll also have immediate access to additional infomation such as age, gender, sentiment, name, company, known associates, and any other configurable information you want to create.

This page discusses how to install and configure SAFR and Avigilon so that the two systems are properly integrated. The SAFR Avigilon Operation Guide discusses how to operate the integrated systems.

Integration Overview and Requirements

A typical deployment requires the following:

System Requirements

Avigilon has the following requirements:

SAFR has the following requirements:

Install the Avigilon Client and Server

Download and install the ACC Client and the ACC Server from the Avigilon website:

If you've already installed the ACC Server and merely want to install a second ACC Client, there's a client-only install location:

The ACC Admin Tool can be used to manage network and storage configurations.

When logging in to the site for the first time, the default credentials use administrator as the username without a password. You'll be asked to immediately enter a new password.

Install the ACC Web Endpoint Service

To install the ACC Web Endpoint Service, download and install the ACC 7 Web Endpoint Service from the Avigilon website at https://www.avigilon.com/support/. Note that the ACC Web Endpoint Service must be installed on the same machine as the ACC Server.

Once installed, you can view the health of the ACC 7 Web Endpoint Service at https://localhost:8443/

Change the Default Ports

The default port for the ACC Web Endpoint Service is 8443. You can change the default port by doing the following:

  1. In the %ProgramData%\Avigilon\ folder, open the WebEndpoint.config.yaml file in a text editor.

  2. Add the following config parameter to the file, where 123 is the new port number:

    publicRestInterface: port: 123

  3. Save the config file and restart the ACC Web Endpoint Service.

The default port is updated. All commands should be sent to the new port.

Using Insecure Connections

Although the default connection type used between SAFR and Avigilon is secure, (i.e. HTTPS) insecure connections (i.e. HTTP) are also supported. To change to an insecure connection, do the following:

  1. In the %ProgramData% folder, open the WebEndpoint.config.yaml file in a text editor.

  2. Add the following config parameter to the file:

    publicRestInterface: secure: false

  3. Save the WebEndpoint.config.yaml file and restart the ACC Web Endpoint Service.

All communication with the WebEndpoint will now be done insecurely using HTTP.

Install and Configure SAFR

  1. Go to the SAFR Download Portal.
  2. If you're doing a cloud deployment, download and install Windows SAFR Desktop. Make sure to select the Avigilon Control Center install option.
  3. If you're doing an on-premises deployment, download and install Windows SAFR Platform. Make sure to select the Avigilon Control Center install option.
    • When installing the SAFR Platform, the default SAFR port assignments sometimes conflict with other software port assignments. If a port conflict occurs, the error message shown below will pop up in the middle of your installation.

      If this happens, do the following:
      1. Click OK to edit port configurations.
      2. Notepad will open, displaying the safrports.conf file.
      3. Edit any conflicting ports to new values. (e.g. CoviHTTP=18080)
      4. Save and exit Notepad.
    The Platform installer will then restart and the new port values will be used. You can find the modified safrports.conf file at C:\Program Files\RealNetworks\SAFR\.

After the installation finishes, two icons will appear on your desktop: one labeled SAFRActions and another labeled SAFR. SAFRActions launches SAFR Actions, while SAFR launches the Desktop Client. The SAFR Server (when installed as part of a local deployment) automatically runs as a collection of background services.

Immediately following installation, the installer opens the Desktop Client and prompts you to log in with your SAFR Account credentials. Make sure to log in; it's important in acquiring the SAFR license.

Configure SAFR

You can configure several Avigilon-specific preferences by opening the SAFR Desktop Client, going to the Preferences Window and clicking on the Avigilon tab.

More Information about ACC Software

For more information about installing, configuring, and using ACC software, see https://www.avigilon.com/support/software/acc7/avigilon-acc7.4-installworkflowchecklist-en-rev2.pdf

See Also