|
Runtime variables
Runtime variables are variables that may change during runtime or that depend on the event record being processed. These variables are supported in the following fields:
Action / Feature
|
Variable Name
|
Expands to
|
Supported Fields
|
Example
|
SMTP Action
|
$HOSTNAME
|
local computer name
|
Sender name
Sender Email
Subject
Header & Footer
|
FILESERVER1
|
|
$COUNT
|
the number of event log records in the email
|
Subject
|
3
|
|
$LOG
|
the event log that was scanned
|
Subject
Header & Footer
|
Directory Service
|
|
The following variables always reflect the value of the first event contained in the email (since emails may contain multiple records).
|
|
$PACKAGE
|
the package of the filter which captured the event is located in
|
Subject
Header & Footer
|
Email Notifications
|
|
$FILTER
|
the name of the filter which captured the event
|
Subject
Header & Footer
|
Default Filter
|
|
$GROUP
|
the group the computer is a member of
|
Subject
Header & Footer
|
File Servers
|
|
$EVENTID
|
the event ID of the first event
|
Subject
Header & Footer
|
14
|
|
$EVENTSOURCE
|
the event source of the first event
|
Subject
Header & Footer
|
Security
|
|
$EVENTCATEGORY
|
the event category of the first event
|
Subject
Header & Footer
|
Account Logon
|
|
$EVENTTYPE
|
the event type of the first event
|
Subject
Header & Footer
|
Warning
|
|
$EVENTUSER
|
the event username (if available)
|
Subject
Header & Footer
|
User1
|
|
$EVENTCOMPUTER
|
the event computer name
|
Subject
Header & Footer
|
DBSERVER
|
|
$EVENTMESSAGE
|
the event message (max. 100 characters) of the first event. Messages longer than 100 characters will have " ..." appended.
|
Subject
|
The EventSentry service is ready.
|
|
$STR1 .. $STR24
|
Respective insertion string
|
Subject
|
|
|
|
|
|
|
|
Additional Notes:
The $LOG and other variables are expanded to "Various" if the SMTP message is a summary notification or backup message. In this case an email can contain messages from different event logs and not just from a single one.
The following runtime variables are supported in the SMTP Header and Footer: $FILTER, $GROUP, $PACKAGE, $LOG, $EVENTTYPE, $EVENTSOURCE, $EVENTCATEGORY, $EVENTID, $EVENTMESSAGE
|
|
|
|
|
|
File Action
|
$HOSTNAME
|
local computer name
|
File Name
|
FILESERVER1
|
|
$PACKAGE
|
the package of the filter which captured the event is located in
|
File Name
|
Files
|
|
$GROUP
|
the group the computer is a member of
|
File Name
|
File Servers
|
|
$DAY, $MONTH,
$YEAR, $HOUR,
$MINUTE
|
current date and/or time
|
File Name
|
n/a
|
|
|
|
|
|
Database
|
$HOSTNAME
|
local computer name
|
Table Name
|
FILESERVER1
|
|
|
|
|
|
|
Please note that certain characters might not be allowed in the table name even though they are valid in the local computer name, depending on the database software that you are using.
One such example is the hyphen character " - " which is not allowed by default in a table name when using MS SQL Server. To avoid problems enclose the table name in brackets such as [My-Table] or [$HOSTNAME] when using MS SQL Server. Please check with your database vendors documentation for details.
|
|
|
|
|
|
Process Action
|
$DAY, $MONTH,
$YEAR, $HOUR,
$MINUTE
|
current date and/or time
|
resulting
command line string
|
n/a
|
|
$STR1 .. $STR24
|
Respective insertion string
|
Command Line Arguments
|
|
|
|
|
|
|
Event Log
|
$HOSTNAME
|
local computer name
|
File Name
|
FILESERVER1
|
Backup
|
$LOG
|
event log being processed
|
File Name
|
Application
|
|
$DAY, $MONTH,
$YEAR, $HOUR,
$MINUTE
|
current date and/or time
|
File Name
|
n/a
|
|
|
|
|
|
Service / Process Control
|
$STR1 .. $STR24
|
Respective insertion string
|
Service and Process Name
|
|
Insertion String Variables
Contain the insertion strings of event records. You can identify insertion strings with the Event Message Browser, where insertion strings are identified with percentage signs followed by a number, e.g. %1, %2 etc.. To use an event insertion strings in EventSentry, use the $STRx variable, where x is replaced with the number from the insertion string. For example, to display the 3rd insertion string from an event in an email subject, include $STR3 in the email subject of the action. Please refer to the table above to find out which fields support insertion string variables.
Custom Variables
Custom variables can have any name, but may only contain letters. Numbers and special characters are not supported in the name of a custom variable. Custom variables are supported in the following fields:
Backup Event Logs
Backup File ("File")
Filters
Source
Category
Username
SMTP Notification
Sender Name
Sender Email
Recipients
Subject
Primary (incl. User & Pass)
Secondary (incl. User & Pass)
Dial
Header and Footer
Character Set
ODBC Notification
DSN Name
Table Name
Username
Password
Syslog
Host Name
SNMP + SNPP Notification
Host Name
File
File Name
Character Set
Network Message
NetBIOS Name
Process
Arguments
|
