Configuring the HTTPS endpoint to export read and hit events - Security Center 5.11

Security Center Administrator Guide 5.11

Applies to
Security Center 5.11
Last updated
2024-04-03
Content type
Guides > Administrator guides
Language
English
Product
Security Center
Version
5.11

You must configure the ALPR manager role to export a license plate read or hit event automatically to the required HTTPS endpoint.

Before you begin

  • Ensure that your Security Center license has a valid certificate for the AutoVu™ third-party data exporter plugin integration. For more information about licenses, see About the AutoVu Third-party Data Exporter.
  • To configure a secure connection, you must have all the required information from the corresponding third-party API.
  • Ensure that the server firewall rule is updated with the port number specified by the third-party API.
  • To set the Queueing protocol to High volume, ensure that the system uses RabbitMQ. For more information, see High-volume data export using RabbitMQ .
    NOTE: If you already have a RabbitMQ installed for another Genetec™ application, you can use the same credentials and TLS certificates to export high volumes of data.

Procedure

  1. From the Config Tool homepage, click System > Roles, and then click the ALPR Manager you want to configure.
  2. Click the Properties tab and enable the Data Exporter option.
  3. Select the required Queueing protocol from the drop down menu.
    Standard
    This is the default mode.
    High volume
    Select this mode if you need to export a high volume of events.
    NOTE: In the Communication settings pop-up window, enter the details configured in the RabbitMQ installation.
  4. Click and select the required secure connection type from the list.
  5. In the Parameters section, configure the following:
    Endpoint name
    Enter a relevant name for the required third-party server.
    Server URL
    Enter the IP address of the third-party server. You can also add URL parameters that are required, for example, https://server:5001/api/json?params1=test1&params2=test2.
    NOTE: The default port for the server URL is 443. To override the default value, add the required port to the server URL. For example, to use port 5001, enter the IP address as https://server:5001/api/.
    Export format
    Select the format in which the data needs to be exported.
    • XML: Export reads and hits in XML format.
    • JSON: Export reads and hits in JSON format.
    • UTMC: Export reads in UTMC format supported in Europe.
    • JSON2: Export hits to a T2 ticketing system.
    • JSONLAP: Export reads in a JSON format supported by Brazil municipalities.
  6. (Optional) If the Export format selected in step 4 is XML or JSON or JSON2, configure the following settings in the File format-specific section:
    Customer ID
    Enter the value provided by the customer.
    NOTE: This section is displayed only if Export format selected 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.
    Add watermarks to context images
    Select this option to add watermark to context images. To better suit your requirements, you can customize the variables in the following ways.
    • Modify the variables. For example, you can add {timezone} to the template.
    • Arrange the order of the variables. For example, you can add {timezone} at the start of the template.
    • Add words to provide more information. For example, you can add We are in before {timezone} to provide more context about the timezone.
    Date format
    Select how you want the date to appear in exported license plate reads. The following formats are available:
    • MM/dd/yyyy
    • MM-dd-yyyy
    • dd/MM/yyyy
    • dd-MM-yyyy
    • yyyy/MM/dd
    • yyyy-MM-dd
    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 third-party data exporter retries until the event is successfully exported or a long list of events need to be resent.
  7. (Optional) If the Export format selected in step 4 is JSONLAP, configure the following settings in the File format-specific section:
    Company code
    Enter the value provided by third-party API.
    Contract code
    Enter the value provided by third-party API.
  8. In the Authorization section, configure the following settings:
    NOTE: This section is displayed only if Connection type selected is Https.
    Authorization mode
    Choose the authorization mode as required.
    None
    Select this option if the third-party system does not require any specific authorization method.
    Certificate
    Select this mode if the third-party system uses TLS certificate.
    PasswordGrant
    Select this mode if the third-party system uses PasswordGrant token.
    Client Credentials
    Select this mode if the third-party system uses Client Credentials token.
    Client certificate
    Enter or browse the path to the TLS certificate provided by third-party API.
    NOTE: This parameter is displayed only if Certificate authorization mode is selected.
    Token URL
    Enter the value provided by third-party API.
    Client ID
    Enter the value provided by third-party API.
    Client secret
    Enter the value provided by third-party API.
    Username
    Enter the value provided by third-party API.
    Password
    Enter the value provided by third-party API.
    Scope
    Enter the value provided by third-party API.
    NOTE: If no value is provided, the field can be left empty.
  9. Click Apply.