Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

You can use message templates in commands (see E-mail E–mail notification, SMS notificationExecuting a web Web-query) that involve sending notifications:

  • {cameraNode}  - Server name;
  • {eventNode} - Server name (used if the macro launching condition is not linked is not linked to a particular camera);

  • {cameraName} - name and short name of the camera that initiated the macro;
  • {cameraLabel} - just the camera's name;

  • {cameraIpAddress} - camera's IP address;
  • {cameraId}  - camera's ID;
  • {cameraRef} - the VIDEOSOURCEID identifier;
  • {list} – name of the List of Facial Templates or ANPR list;

  • {plate} - recognized – recognized vehicle number;
  • {plateDirection} – the direction of movement of the vehicle in the frame;

    Info
    titleNote

    Possible values:

    1 – from top to bottom;

    2 – from bottom to top.


  • {name} – name} - name of the recognized person from Lists of Facial Templates;

  • {age} - age of the recognized individual;

  • {gender} - gender of the recognized individual;

    Note
    titleAttention!

    The {age} and {gender} templates can be applied when the following conditions are met:

    1. The Gender and Age parameter is activated in facial detection tool settings (see Configure Facial Recognition Configuring Face detection).
    2. The Face Appeared: Specified Triggering event is selected as a launch condition for this macro (s).


  • {appearedTime} - UTC time of object detection;

  • {dateTime}  - date and UTC time of triggering the macro in ISO format;

  • {serverDateTime} - local Server time of triggering the macro in ISO format;

  • {rectangles} - coordinates and size of the object that triggered the detection tool;

  • statistics templates:

    • {cpuUsage}   -  – percentage of CPU load on a Server;

    • {netUsage} - percentage of used network bandwidth on a Server;

    • {memoryUsage} - percentage of used RAM on a Server;

    • {diskUsage} - percentage of disk usage;

    • {archiveUsage} - percentage of Video Footage usage.

      Note
      titleAttention!

      You can apply statistics templates only if you launch a macro by a corresponding statistical condition (see Triggering macros by statistical data).


Info
titleNote

Templates allow  allow {} and %%. For example,  %cameraId%%cameraId%


Info
titleNote

Date/time templates (such as dateTime, serverDateTime, appearedTime and serverAppearedTime) offer an extended input option which allows you to set date and time in arbitrary format. A format description parameter must be contained within a pair of @ symbols. 

Here's an example: {dateTime@%Y-%m-%d dateTime@%Y–%m–%d %H:%M:%S@}. In this case, the actual format is presented as 2020-10-04 2020–10–04 18:43:23.

Available parameters:

Expand


Parameter

Description

%a

Abbreviation for the day of the week

%A

Full name of the day of the week

%b

Abbreviation for the month 

%B

Full name of the month 

%y

Last two digits of the year

%Y

Full number of the year

%m 

Month of the year 

%d 

Day of the month

%H

Hour in 24h format

%M

Minute as a decimal number 

%S

Second as a decimal number

%F

Fractions of second

Combined parameters:

Parameter

Description

%D

Equivalent to %m/%d/%y

%T

Equivalent to %H:%M:%S



E.g. this macro sends an email of the following format when a water level detection tool triggers:

Code Block
Subject: Notification: Attention, water level detection is triggered.

Server: Server1
Camera: 10.0.11.36 34.Camera
Time: 20190812T085517.926430

...