ALPR Manager - Properties tab - Security Center 5.12

Security Center Administrator Guide 5.12

Product
Security Center
Content type
Guides > Administrator guides
Version
5.12
Language
English
Last updated
2024-09-13

In the ALPR task on the Properties tab, you can configure the general ALPR Manager role settings and optional AutoVu™ features. The availability of certain features depends on your Security Center license.

General settings

Use the General settings to configure the Root folder for the ALPR Manager, the user group for the Genetec Patroller™ installations, and how long the data from the ALPR Manager is kept in the database.
Root folder
The main folder on the computer hosting the ALPR Manager, where all the configuration files are created, saved, and exchanged between the ALPR Manager and the Patroller units it manages.
Optimize Root folder disk space
Enable the use of symbolic links to reduce disk utilization when the same file is replicated in multiple folders, such as when you have large hotlists or permit lists associated to individual Patroller units. This reduces the Root folder’s overall disk space, and optimizes file transfer performance to the Patroller in-vehicle computer.
IMPORTANT: If your root folder is on a network drive, the Genetec™ Server service must be configured to run using a domain user and not a local user.
User group for Patrollers
List of users (and their passwords) who are allowed to log on to the patrol vehicles managed by the ALPR Manager. This list is downloaded to the patrol vehicles.
Retention period
Specify how many days of ALPR-related data Security Center can query. The default is 90 days, and the maximum is 4000 days. The ALPR date that is older than the values specified do not appear in Security Center queries and reports (Hit reports, Read reports, and so on).
Genetec Patroller™ route retention period
Number of days the Patroller route data (GPS coordinates) is kept in the database.
Hit retention period
Number of days the hit data is kept in the ALPR Manager database.
Hit image retention period
Number of days the hit image data is kept by the linked Archiver role. The Hit image retention period cannot exceed the Hit retention period since a hit image is always associated with a hit.
Read retention period
Number of days the license plate reads are kept in the ALPR Manager database. The Read retention period cannot exceed the Hit retention period. If the read retention is lower than the hit retention, only the reads that are associated with hits are kept.
Read image retention period
Number of days the read image data is kept by the linked Archiver role. The Read image retention period cannot exceed the Read retention period since a read image is always associated to a read.
Event retention period
Number of days Patroller events (user logged on, logged off, and patrol vehicle positions) are kept in the ALPR Manager database.
Parking occupancy retention period
Number of days the parking occupancy data is kept in the ALPR Manager database.
Parking zone data retention period
Number of days the parking zone data is kept in the ALPR Manager database. This data includes parking session information, for example, parking session start times and state transitions, as well as information on the events that occur within the parking zone. The Parking zone data retention period cannot exceed the Read retention period.

Live

The Live settings are used to configure how data is transferred between Security Center and SharpV cameras, and also between Security Center and Patroller.
NOTE: You only need to configure the Live settings if you are enrolling a Sharp camera running SharpV OS 12.6 or earlier, or if you are configuring a Patroller connection.
Listening port
Port used to listen for connection requests coming from SharpV cameras. After the connection is established, the ALPR Manager can receive live updates from the ALPR units it manages.
NOTE: If you are using multiple ALPR Managers, each ALPR Manager must use a different listening port.
Sharp discovery port
Port used by the ALPR Manager to find fixed SharpV units on the network. The same port number must be used in the Discovery port setting on the SharpV.
NOTE: When setting the discovery port, do not use port 5050 as it is reserved for the logger service.
Send on read (SharpV units only)
The SharpV images that are sent to Security Center for each plate read. These images are displayed in Security Desk when monitoring ALPR events.
NOTE: This Live setting also applies when using the LPM protocol.
License plate image
Include the high resolution close-up image of the license plate along with the plate read data.
Context image
Include the wide angle context image of the vehicle along with the plate read data.
Channel security
Encrypt communication between Security Center and Patroller.
IMPORTANT: If you select this option, encryption must also be enabled in Patroller Config Tool.
Encrypt communication channel
Encrypt communication between Patroller and Security Center.
Accept non-encrypted messages
Security Center will accept incoming connections from patrol vehicles that do not have the encryption option enabled.

LPM protocol

When a Sharp camera (SharpV OS 12.7 or later with the LPM protocol enabled) connects to the ALPR Manager role, the connection is managed by the LPM protocol, which provides a secure and reliable connection to Security Center.

Listening port
Port used to listen for connection requests coming from fixed Sharp cameras. When the connection is established, the ALPR Manager can receive live updates from the ALPR units it manages.

File association

The File association settings specify which hotlists and permits are active and managed by the ALPR Manager.
Hotlists
A list of all the hotlists in Security Center. Select which hotlists you want the ALPR Manager to manage.
Permits
A list of all the permits in Security Center. Select which permits the ALPR Manager manages.

Matching

The Matching settings are used to enable matching between hotlists and fixed Sharp units. When matching is enabled, you can configure event-to-actions in Security Desk that trigger on Match and No match events.
Matching
When matching is enabled, you can configure event-to-actions in Security Desk that trigger when the Sharp reads a plate that is on a hotlist you have activated in File association.
Generate No match events
Security Center generates No match events when a plate is not found on a specific hotlist. You can then configure event-to-actions in Security Desk based on No match events.
Past-read matching
When past-read matching is enabled, the system compares new or updated hotlists against previously captured license plate reads.
NOTE:
  • The database retention period is configurable. All hits past the configured retention period are deleted from the database.
  • If a hotlist hit has already been generated for a plate, performing past-read matching does not generate a duplicate hit for the plate.
  • Federated hotlists cannot be used for past-read matching.
  • If a hit is generated based on a past-read match, it is indicated in the Post matched column in the Security Desk Hits report.
  • Past read matching is also available for Patroller systems.
Hotlists
Select one or more hotlists to be used for past-read matching.
NOTE: For a hotlist to be used with past-read matching, the hotlist must first be associated with the role or SharpV camera for which past-read matching has been activated.
Search back time
Set the limit for how far in the past the system searches for plate reads when past-read matching is triggered.

Geocoding

The Geocoding feature allows the ALPR Manager to perform geocoding and reverse geocoding.
NOTE: If your patrol vehicles are equipped with GPS but no maps, you need reverse geocoding to convert the raw GPS data (longitude, latitude) from patrol vehicles into street addresses. The street addresses are then saved along with the reads in the ALPR Manager database.
Map type
Displays the map type set in the Security Center license.
Maps and data folder
Folder where the BeNomad files are found. This folder must be on the same computer where the ALPR Manager is installed.

Plate filtering

The Plate filtering settings determine what to do when a hotlist or permit list is modified and the ALPR Manager detects that there are entries with invalid characters (non-alphanumeric characters).
Plate number valid characters
The types of characters to filter on (Latin, Arabic, Japanese, Cyrillic, or Thai).
Invalid plate number
How the ALPR Manager handles invalid records.
Modify record
(Default setting). Removes any non-alphanumeric characters from the plate number. For example, the plate number “ABC#%3” becomes “ABC3”.
Remove record
Deletes the entire entry from the list.
Log filtering
Select to log the filtering process. The plate filtering logs are saved in the AutoVu root folder: C:\Genetec\AutoVu\RootFolder.

Email notification

The Email notification setting turns on email notifications for hotlist hits, and lets you customize the look and contents of the email message.
Email attribute name
Used for email notification at the individual license plate level. Type the name of the hotlist attribute related to email notification. For example, if you added an “Email” attribute on the hotlist entity’s Properties tab, then type the same name here. The names must match exactly.
Email attachments
The ALPR data that is attached to the notification email, and whether to hide the license plate numbers in the message body.
License plate image
High-resolution close-up images of the license plate.
Context image
A wider angle color image of the vehicle.
Wheel image
Replaces the read plate number and the matched plate number in the email with asterisks (*).
Log emails
Select this option to log hotlist hit notification emails. The email logs are saved in the AutoVu root folder: C:\Genetec\AutoVu\RootFolder.
Template
Customize the email. Do any of the following:
  • Edit the email’s subject line or message body.
  • Switch between plain text and HTML.
  • Add formatting (bold, italics, and so on).
  • Right-click in the message body for a menu of quick tags that you can use to add more information to the email.
  • Restore the default email template at any time.

XML import

The XML import settings are used to import data from third-party applications into the ALPR Manager database. When you turn this setting on, Security Center creates an XML import entity, and then associates the imported data with this entity. In Security Desk, you can then filter on the XML import entity when running hit or read reports.
NOTE: This option requires a license. For more information, contact your Genetec representative.
XML read template file
Specify where the XML read template file is located. You will find a default template in the Security Center installation package in Program Files (x86)\Genetec Security Center X.X\Add-On\LPR\XMLTemplatesSamples\XMLImport.
NOTE: In most cases the default template can be used.
XML data folder
Specify the folder that contains the XML data files for Security Center to import.
NOTE: Files are deleted from this folder once they have been processed.
Supported XML import hashtags
The following XML import hashtags are supported. Each hashtag must have an opening and closing XML tag (for example, to use the tag #CONTEXT_IMAGE# you must write <ContextImage>#CONTEXT_IMAGE#</ContextImage> in the XML).
#PLATE_READ#
License plate as read by the Sharp.
#PLATE_STATE#
License plate's issuing state or province, if read.
#DATE_LOCAL#
Local date of the ALPR event.
#DATE_UTC#
UTC date of the ALPR event.
#TIME_UTC#
UTC time of the ALPR event.
#TIME_ZONE#
Local time zone for the ALPR event.
#CONTEXT_IMAGE#
Context image (Base64-encoded JPEG).
#PLATE_IMAGE#
License plate image (Base64-encoded JPEG).
#LONGITUDE#
Longitude of the ALPR event (in decimal degrees or DMS).
#LATITUDE#
Latitude of the ALPR event (in decimal degrees or DMS).
#GUID#
Unique identifier of the ALPR event.
#CUSTOM_FIELDS#
You can import other fields with this hashtag by using the key=value format. Format the key as #CUSTOM_FIELDS#{KEY}.
NOTE: You must specify a format for DATE and TIME hashtags. For example, #DATE_LOCAL#{yyyy/MM/dd}). Click here for more information about which formats to use. If these hashtags are not included, UTC dates and times are used as a baseline for calculating the local time. If an error occurs, the time the ALPR Manager role imported the data is used.

XML export

The XML export settings are used to send ALPR Manager reads and hits to third-party applications. Reads and hits are sent live as they occur.
XML templates folder
Specify where the XML templates folder is located. You will find default templates in Program Files (x86)\Genetec Security Center X.X\Add-On\LPR\XMLTemplatesSamples\XMLExport. There are XML templates for each type of ALPR event (plate reads, hotlist hits, overtime hits, permit hits, and shared permit hits).
NOTE: In most cases the default template can be used.
XML export folder
Specify the folder that contains the XML files exported by the ALPR Manager.
Time format
Enter the time format used in the exported files. As you set the time format, the information field displays what the time format will look like in the XML file.
To identify the units of time, use the following notation:
Notation Description
h Hour
m Minute
s Second
: Must use a colon (:) between the hour, minute, and second units.
hh,mm,ss Display time with leading zero. For example: 03:06:03 represents 3 hours 6 minutes 3 seconds.
h,m,s Display without leading zero. For example: 3:6:3 represents 3 hours 6 minutes 3 seconds.
tt Include am or pm If using a 12-hour clock, you might want to use am or pm notation. Unit can be preceded with or without a space. For example, HH:mm:ss tt displays 17:38:42 pm.
Lowercase h 12-hour clock.
Uppercase H 24-hour clock.
Date format
Select a date format to use in the exported files. You can choose either MM/dd/yyyy or yyyy-MM-dd. For example, yyyy-MM-dd displays 2016-06-21.
Supported XML hashtags
The following XML export hashtags are supported. Each hashtag must have an opening and closing XML tag (for example, to use the tag #CONTEXT_IMAGE# you must write <ContextImage>#CONTEXT_IMAGE#</ContextImage> in the XML).
#ACCEPT_REASON#
Reason hit was accepted.
#ADDRESS#
Address of the ALPR event.
#ATTRIBUTES#
Generate all Read and Hit attributes.
#CAMERA_NAME#
Name of the camera.
#CONTEXT_IMAGE#
Context image (Base64-encoded JPEG).
#DATE_LOCAL#
Local date of the ALPR event.
#DATE_UTC#
UTC date of the ALPR event.
#ELAPSED_TIME#
For an overtime hit, this tag indicates the time difference between the two plate reads (displaying the number of days is optional).
#FIRST_VEHICLE#
For a shared permit hit, this tag generates the content specified in ReadTemplate.xml for the first vehicle seen.
#FIRST_VEHICLE_FROM_STREET#
For an overtime hit, this tag retrieves the attribute From street from the first plate read.
#FIRST_VEHICLE_TO_STREET#
For an overtime hit, this tag retrieves the attribute To street from the first plate read.
#HOTLIST_CATEGORY#
Category field of the hotlist that generated the hit.
#GUID#
Unique identifier of the ALPR event.
#INVENTORY_LOCATION#
For MLPI installations, the location of the vehicle inventory.
#IS_POST_MATCHED#
(Hotlist only) If the Hit was post matched (matched with the Post-matching event).
#ISHIT#
This tag indicates if the ALPR event is a hit.
#LATITUDE#
Latitude of the ALPR event (in decimal degrees).
#LATITUDE#{dms}
Latitude of the ALPR event (in degrees, minutes, and seconds).
#LATITUDE#{dec}
Latitude of the ALPR event (in decimal degrees).
#LATITUDE_DEGREE#
Latitude of the ALPR event (degrees).
#LATITUDE_DMS#
Latitude of the ALPR event (in degrees, minutes, and seconds).
#LATITUDE_MINUTE#
Latitude of the ALPR event (minutes).
#LATITUDE_SECOND#
Latitude of the ALPR event (seconds).
#LONGITUDE#
Longitude of the ALPR event (in decimal degrees).
#LONGITUDE#{dec}
Longitude of the ALPR event (in decimal degrees).
#LONGITUDE#{dms}
Latitude of the ALPR event (in degrees, minutes, and seconds).
#LONGITUDE_DEGREE#
Longitude of the ALPR event (degrees).
#LONGITUDE_DMS#
Longitude of the ALPR event (in degrees, minutes, and seconds).
#LONGITUDE_MINUTE#
Longitude of the ALPR event (minutes).
#LONGITUDE_SECOND#
Longitude of the ALPR event (seconds).
#MATCHED_PLATE#
License plate against which the hit was generated.
#ORIGINAL#
For an overtime hit, this tag generates the content specified in ReadTemplate.xml for the first read of a given plate.
#OVERVIEW_IMAGE#
Overview image (Base64-encoded JPEG).
#PARKING_LOT#
(Read & any Hit Type) Get the extracted parking lot based on the Rule ID and the Lot ID.
#PATROLLER_ID#
ID of patrol vehicle.
#PATROLLER_NAME#
Name of patrol vehicle.
#PERMIT_ID#
(Permit only) Get the associated LPR Rule ID.
#PERMIT_NAME#
Name of the permit that generated the ALPR event.
#PLATE_IMAGE#
License plate image (Base64-encoded JPEG).
#PLATE_READ#
License plate as read by the Sharp.
#PLATE_READ_MATCHED#
(Hotlist only) (Same as #MATCHED_PLATE#) Get the Hit matched plate, based on the value of MatchPlate analytic.
#PLATE_STATE#
License plate's issuing state or province, if read.
#REJECT_REASON#
Reason hit was rejected.
#READ#
Embed the contents of the ReadTemplate.xml inside another XML template (useful for hits).
#RULE_COLOR#
Color of the rule associated to the ALPR event.
#RULE_ID#
ID of the rule associated to the ALPR event.
#RULE_NAME#
Name of the rule associated to the ALPR event (hotlist, overtime, permit, or permit restriction).
#SECOND_VEHICLE#
For a shared permit hit, this tag generates the content specified in ReadTemplate.xml for the second vehicle seen.
#SECOND_VEHICLE_FROM_STREET#
For an overtime hit, this tag retrieves the attribute From street from the second plate read.
#SECOND_VEHICLE_TO_STREET#
For an overtime hit, this tag retrieves the attribute To street from the second plate read.
#SHARP_NAME#
Name of the Sharp that read the plate.
#STATE#
License plate's issuing state or province, if read.
#TIME_LOCAL#
Local time.
#TIME_UTC#
UTC time of the ALPR event.
#USER_ACTION#
User action related to the ALPR event.
#USER_ID#
ID of the user.
#USER_NAME#
Name of the user.
#VEHICLE#
Same as #READ#.
#ZONE_COLOR#
(Overtime only) Get the color of the associated Overtime Rule.
#ZONE_ID#
(Permit & Shared Permits & Overtime) Get the associated LPR Rule ID.
#ZONE_NAME#
Get the Associated Rule Name.

AutoVu™ Free-Flow

Turn on Free-Flow to configure the XML export of parking events for third-party parking permit providers using the AutoVu™ Pay-by-Plate Sync plugin.

Matching
Match tolerance threshold
This value indicates the number of single-character differences between entry and exit plate reads that will still be considered a match. Setting the value to 0 is equivalent to an exact match.
IMPORTANT: Setting this value too high might cause plate reads to be associated with the wrong vehicle. The default value is 1.
Parking occupancy
Use independent occupancy
OFF
Security Center tracks parking occupancy using parking sessions from the Free-Flow Multi-tenant plugin.
ON
Security Center uses an independent counter to track vehicles entering and exiting the parking lot.
Pay-by-Plate
Server
Enter the IP address of the machine where Pay-by-Plate Sync is installed.
Port
Enter the port number for the Pay-by-Plate Sync connection (default: 8787).
XML export
XML export folder
Specify the export folder for Free-Flow XML data.
Include vehicle images with export
By default, vehicle images are not included with the exported XML file. To include vehicle images, select Include vehicle images with report.
NOTE: Including vehicle images increases the size of the XML export file.
Export occupancy

Export parking zone occupancy data to a separate XML file.

Export violations
When a vehicle is in violation, vehicle information is exported as a separate XML file.
Export completed sessions
When a vehicle exits the parking lot, the parking session information is exported as a separate XML file.
Events
Capacity threshold
Specify the parking zone capacity threshold where a capacity threshold reached event is generated.

Plate Finder

Turn on Plate Finder on AutoVu™ Managed Services (AMS) systems to receive ALPR reads and images from Genetec Mobile application. For more information, see https://techdocs.genetec.com/r/en-US/GenetecTM-Mobile-Getting-Started-Guide/Scanning-license-plates.
IMPORTANT: Ensure that the ALPR Image Manager plugin is configured on the system.

Cloudrunner integration

Turn on Cloudrunner integrations and click Registerto the add the cloud cameras to the required ALPR Manager.

Tenant ID
Name of the Cloudrunner service.
Service Name
Name of the integration type.
Service ID
ID of the Cloudrunner account.

AutoVu third party data exporter

Turn on AutoVu third party data exporter to configure the secure export of read and hit events to the required third-party systems.

Parameters
Endpoint name
Enter a relevant name for the required third-party server.
Destination folder
Enter the path of the destination folder on the third-party server.
Export format
Select the format in which the data needs to be exported.
  • XML: Select this option if you want to export reads and hits in XML format.
  • JSON: Select this option if you want to export reads and hits in JSON format.
  • UTMC: Select this option if you want to export reads.
  • JSON2: Select this option if you want to export hits.
File name template
Enter a relevant name for the export type.
Server URL
Enter the IP address of the third-party server.
File format-specific
Enter the value for the Customer ID provided by the customer.
NOTE: This section is displayed only if Export format selected in step 4 is JSON2.
What to export
Select the events that you want to export.
Export settings
Choose the export settings as required.
Export images
Select this option to export the images along with the read or hit.
Enforced hits only
Select this option to export enforced hits.
Critical
Select the events that you want to resend after an export operation fails.
Reads
Select this option to resend any reads.
Hits
Select this option to resend any hits.
NOTE: The AutoVu Data Exporter plugin will retry until the event is successfully exported or more than 1000 events need to be resent.
Authorization
Authorization mode
Choose the authorization mode as required.
None
Select this option if the third-party system does not require any specific authorization method.
SslCertificate
Select this mode if the third-party system uses TLS certificate.
PasswordGrant
Select this mode if the third-party system uses the PasswordGrant token.
Client certificate
Enter or browse the path to the TLS certificate provided by the third-party API.
NOTE: This parameter is displayed only if Certificate authorization mode is selected.
Token URL
Enter the value provided by the third-party API.
Client ID
Enter the value provided by the third-party API.
Client secret
Enter the value provided by the third-party API.
Username
Enter the value provided by the third-party API.
Password
Enter the value provided by the third-party API.
Scope
Enter the value provided by the third-party API.
NOTE: If no value is provided, the field can be left empty.
Connection settings
Hostname or IP
Enter the hostname or IP address of the destination.
Port
Enter the port number of the destination address.
Username
Enter the value provided by the third-party API.
Password
Enter the value provided by the third-party API.
SSH Key
Enter the value provided by the third-party API.
NOTE: If no value is provided, the field can be left empty.
SSH passphrase
Enter the value provided by the third-party API.
NOTE: If no value is provided, the field can be left empty.