Configuring the Clearance plugin role - Clearance plugin 3.5.38

Genetec Clearance™ Plugin Guide 3.5.38

Applies to
Clearance plugin 3.5.38
Last updated
2023-05-24
Content type
Guides > Plugin and extension guides
Language
English
Product
Clearance Plugin
Version
3.5

To export recordings from a Security Center system to a Genetec Clearance™ account, you must connect the Clearance plugin role to the Clearance account. The cameras that you select here are shared with Clearance and published in the Clearance Registry.

What you should know

The first time the plugin role is activated, it creates the following entities in your system:
view camera selection (privilege)
Users with this privilege can view and modify the Camera selection page.
View plugin configuration (privilege)
Users with this privilege can view and modify the configuration settings.
View request notifications (privilege)
Users with this privilege can view and modify the Request notifications page.

Procedure

  1. From the Config Tool home page, open the Plugins task.
  2. In the Plugins task, select the plugin role from the entity browser, and click the Properties tab.
  3. Configure the following:
    The Clearance Plugin Properties tab showing configuration details.
    Account ID
    Displays the Clearance account ID. Click Import file () and select the JSON configuration file you want to use to import Clearance account connection settings. These settings include the Account ID that is used to connect the Clearance plugin to a Clearance account.
    Polling interval
    Specifies how frequently the Clearance plugin connects back to Clearance for updates or sending back new requests.
    Archive destination folder
    Specifies a folder location where video is temporarily stored during the upload process. After the upload completes the video is deleted.
    NOTE: If you are running Clearance on an expansion server, using the Browse button to set the archive destination folder opens the file explorer for the local machine, but saving the destination creates the folder on the directory server. As a workaround, enter the correct file path in the Archive destination folder text field.
    Use proxy
    Click to use a forward proxy server to connect to the Clearance plugin.
    Use throttling
    Activate throttling to execute uploads sequentially. Disable throttling to run uploads concurrently, for a maximum of five concurrent uploads or video requests by evidence processes at a time.
    NOTE: Bandwidth throttling is only possible if the proxy server is set to off.
    Maximum bandwidth
    If you activated throttling, define a maximum bandwidth for your uploads in MBPS.
    Hide camera selection hierarchy
    Import entities from any area or federation without showing their tree hierarchy. This results in a faster import process.
    Tip: After you activate this setting, restart Config Tool for the changes to take effect.
  4. If you require a forward proxy server, click Use proxy and enter your:
    1. IPv4 address or hostname.
    2. Port number.
    3. Username.
    4. Password.
    5. Click Apply.
      The Clearance Plugin Properties tab showing configuration details with the proxy server information configured.
  5. If you want to implement bandwidth throttling, do the following:
    1. Set Use throttling to On.
    2. Define a maximum bandwidth value
      The Clearance Plugin Properties tab showing configuration details with bandwidth throttling activated.
    NOTE: The bandwidth throttling feature is not available when the proxy service is enabled.
  6. If you are adding cameras or areas to the Clearance Registry, select the entities you want to publish:
    1. Click Camera selection.
    2. Click .
    3. Search for or select cameras and areas that you want to be displayed in the Clearance camera registry and click OK.
      The Camera Selection window showing a list of areas and cameras that can be published.
    NOTE:
    • When a Federation™ or area is added to the selection, you can only remove the whole area or Federation™ thereafter. You cannot remove individual cameras from the area or Federation™.
    • If your network of cameras and areas is large, it could cause Config Tool to stop working. If this happens, navigate to the Properties tab and activate the Hide camera selection hierarchy setting.
  7. Configure request notifications:
    NOTE: The users you select here receive notifications in Security Desk when new video requests are submitted in Clearance.
    1. Click Request notifications.
    2. Click .
    3. Search for or select users from the list and click OK.
      The Request Notifications window showing a list of user groups that can receive notifications.
  8. Click Apply.

After you finish

You are now ready to receive video requests from Clearance.