How the Clearance plugin works with Security Center - 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

When the Genetec Clearance™ plugin is installed, you can export video recordings from a Security Center system to a Clearance account and receive video requests from external parties. The plugin uploads selected video exports over the internet. All uploaded data remains encrypted in transit and at rest.

Architecture diagrams

The following diagram shows the Clearance plugin architecture and network communication. The design includes a server to run the Clearance plugin connected to a Security Center Omnicast solution, which should typically include at least one Directory Server, one Archiver server, and at least one camera that manages the Archiver server.

The Clearance plugin architecture showing the network details related to a video export.
Action Description
A Security Desk request to send video toClearance. Outbound TCP5500 to Directory.
B Directory communication with the Clearance Plugin. TCP 5500 inbound/outbound.
C The Clearance plugin requests video. TCP554 outbound to Media Router.
D The Clearance plugin requests video from archiver and stores it into buffer. TCP560, 555 and 605 Outbound.
E Exported Video transferred to Clearance (See list of Clearance domains). Outbound 443 (HTTPS)
The Clearance plugin architecture showing the network details related to a video request.
Action Description
A Investigator submits video request from Clearance Web Client. Outbound HTTPS port (443) to Clearance domains.
B Request for video goes from Clearance to the server running the Clearance plugin. HTTPS outbound from plugin server.
C Notification of a request for video reaches the Directory and then the Security Desk client through Directory/Server/Client communication. Client to Directory: Outbound TCP5500 Plugin to Directory: Inbound & Outbound TCP5500
D Operator approves or denies request for video through Clearance. HTTPS outbound to the Clearance domains (see list of Clearance domains).
E The Clearance plugin requests video. TCP554 outbound to Media Router.
F The Clearance plugin requests video export and stores it into buffer. TCP560, 555 and 605 Outbound.
G Exported video is transferred to Clearance domains (See list of Clearance HTTPS Outbound (port 443).
NOTE: Your network must allow outgoing communication over HTTPS port TCP443 from your internal network to access Clearance. See the following link for a list of domains that must be allowed: https://developer.clearance.network/docs/clearance-domains.

Components

The following components are required for a Clearance plugin integration:
Expansion Server
An expansion server is any server machine in a Security Center system that does not host the Directory role. The purpose of the expansion server is to add to the processing power of the system.
The Clearance plugin is run on a Security Center expansion server to avoid affecting the performance of the Directory.
Clearance plugin
The Genetec Clearance™ plugin is used to export video recordings and snapshots from Security Center to Clearance. You can also create a registry of Security Center cameras in a Clearance™ account that you can use to send notifications to operators and automate exports when video requests are received.
The The Genetec Clearance™ role manages video exports to a Genetec Clearance™ account. This role also handles communications between Security Center and the Genetec Clearance™ web application.
Video requests are submitted from Clearance and processed by the Clearance plugin.
  • When a request is received, the requested video is immediately encrypted by Clearance and exported to a temporary location to prevent the Archiver retention policy from deleting the requested video.
  • If the video request is approved, the requested video is transferred to a case in Clearance with all associated camera metadata.
  • If the video request is rejected, the video is deleted from the temporary location and is never sent to the requester.

In Security Center, the Clearance plugin must be installed and the Clearance role must be active to ensure that video can be exported to Clearance.

Clearance
Clearance is an evidence management system that you can use to help accelerate investigations by securely collecting, managing, and sharing evidence from different sources.
A Clearance account is required. An account administrator must download a configuration file from the appropriate Clearance account to associate it with their Security Center system.