Skip to main content

Custom Regex

Kieran Bicknell
Updated

Overview

This document covers the setup and use of the custom regex settings.

Minimum Version

Package Version
UI 1.4.35650
DS 1.4.34701
DB 1.4.32861
SMTP 1.4.27614

Features / Permissions

User must be an Administrator or have the CanEditSettings permission set.

The feature that must the turned on is Settings > CustomRegexDecoding

image.png

You can enable the displaying of event numbers by navigating to Setup Features, and searching for DisplayEventNumberInTable

mceclip0.png

How To Guide

Finding Custom Regex Settings

  1. Make sure that the above packages are installed and that the relevant features and permissions are set.

  2. Navigate to System Settings > Custom Regex. Located in the left sidebar under the configuration section.
    image.png

  3. This will show the Custom Regex Settings pane.
    image.png

Setting Up Device Type

Adding Custom Device Type

When new SMTP Emails are to be setup then a new device type will need to be created. When a new device is created the system picks the next available ID above 20,000. (Note: Server Type IDs over 20,00 are classed as custom Device Types)

  1. Click Add Device Type image.png

  2. This will open up the Add Device Menu. Enter a Name for the new Device.

image.png

  1. Click Save. (Note:The name must be unique in the system.)

Editing Device Type

The only option available to edit is the name of the Device. As above the same naming rules apply.

  1. Click Edit Device Type

  2. This will open up the Add Device Menu. Enter a Name for the new Device.

image.png

  1. Click Save.

  2. Click Delete Device Type

  3. This will open up theDelete Device Menu. To delete a device type you must type "delete" in the textbox before the Delete button is enabled.

image.png

  1. Click Delete button to confirm you want to delete.

Linking a Device Type to an SMTP Message.

SMTP Receiver.png

  1. From the main menu go to Setup-Devices

  2. Click Add Device Button

  3. Enter the following key details below.

Field Value
Title "Enter a title that will help you identify the Device as your custom SMTP"
Type "Here select the Custom Device Type you created"
Host localhost
Port 0
Username "Leave Blank"
Password "Leave Blank"
Extra Value "Leave Blank"

  1. Click Save

  2. Close the menu then Click Edit buttonimage.pngon the new Device.

  3. Make a note of the Id Number shown in the header. (Highlighted in red)

Device Details.png

  1. The SMTP Receiver reads the TO email address and extracts the S Number. It matches this to a unique device and loads the decoder linked to it.

Deleting Device Type

When deleting a device type the SMTP Receiver will no longer detect any incoming alarms from the SMTP Messages.

Setting Custom Regexes

After a Device Type has been created and a Device has been setup to link it to the SMTP Receiver. We can now add the Custom Regexes

When creating a regex expression it will be set against event properties. As listed below. The regex will be used to scan the body of the message and any matches will fill the property when raising the event.

Property Description Example
Input1 This is the Alarm Number, it can be any integer (number) Camera 3 triggers an alarm. Input1 would be '3'. // A Door Forced is triggered in Zone 66. Input1 would be '66'
Input2 The 'Input2' Alarm Property is a secondary Alarm Number which can be used in conjunction with Input1, it can be any integer (number) A door forced is triggered in Zone 66, Area 51. Input2 would be '51'
ServerTypeEventNum The “Event Type” Alarm Property is the type of alarm. You can add any Event Type as a string (text). This allows you to create a unique alarm type for this Device in the database. This is important as it allows you to create rules based on receiving a specific event type - i.e. Use this script when you receive a Motion Detected Alarm Motion Detected / Access Denied / Door Forced / Door Held Open
DateTimeOnServer The 'DateTime' Alarm Property is the exact Date & Time that alarm was triggered from the Alarm Source perspective. If this isn’t decoded directly from the alarm text then Sureview will simply use the DateTime that the alarm was received on the Server, DateTime format used in the email needs to be the same format used on the Immix server otherwise it will not be decoded. Invalid dates are not decoded. Alarm Triggered At: 03/05/2019 15:32:58
ExtraText The 'ExtraText' Alarm Property is used for any additional alarm information that should be included and displayed to the operator with the alarm. This information is provided to give the operator additional context about the nature of this alarm. It accepts any string (text) Card Holder Joe Blogs. Police close numerous roads in Jaures area, Paris, following reports of gunfire.
URL This is a web or internal link that the operator can see and click on while handling the alarm. http://www.sureviewsystems.com
Location This is the physical location of the alarm. It can be an address, post code/zip code, Lat/Long details etc 51.650662,-3.914961 / 400 N. Ashley Dr. Tampa, FL 33602

 

Before Adding, Editing & Deleting

  1. Select a Device Type from the dropdown box. This will load the regex table and enable the Event Properties.

image.png

  1. Select the event property you want to edit.

Adding a Custom Regex

  1. Follow the section Before Adding, Editing & Deleting

  2. Click Add Regex button image.png

  3. This will open the Add Regex Menu.

  4. Enter the following details below:

Property Value Example
Regex This will be used to find the match in the email. (Add help link to regex here.) EventType: DoorOpen
Value If the regex is matched then this will be entered into the field. This can be left blank when value is pulled from the email 2 (Id of the eventType)
Options Select the regex options for reading the regex. IgnoreCase / SingleLine

(Note: In this example "EventType: Door Open" is found in the email on a single line and ignores the case. It then sets ServerTypeEventNum to the value of 2.)

  1. Click Save button. This closes the menu and adds the regex to teh bottom of the list.
    (Note: The regex entered must not already exist in the device type.)

image.png

Edit Custom Regex

  1. Follow the section Before Adding, Editing & Deleting

  2. Click the Edit Icon image.pngon the Regex you want to edit.

  3. Change the values as needed.

  4. Click Save button. This will be reflected in the table.

Delete Custom Regex

  1. Follow the section Before Adding, Editing & Deleting

image.png

  1. Click the Delete Icon image.pngon the Regex you want to delete.

  2. This will open the Delete Custom Regex Menu.
    image.png

  3. Click Delete button. The delete will be reflected in the table and the priority of the regex will be reordered.

image.png

Re-order Regex Priority

  1. Follow the section Before Adding, Editing & Deleting

  2. If more than 1 regex is present in the list then you can reorder the priority at which they are searched.

  3. Click and drag the regex you want to re-order to its new position in the list.

  4. The system will then update the priority of all the regexes into the correct order.

Related articles

Comments

0 comments

Please sign in to leave a comment.