Help Menu

This help page is for version 5.6. The latest available help is for version 8.2.

Variables

A number of the actions accept variables to alter their output. The messaging actions ( E-mail, Message Box, Network Message, Pager Alert, and SMS Message) can all accept variables in their message template. In addition, the executable actions (Execute Script and Start Application) can also accept variables to change the action at run time.

Replacement Variables

The variables below can be inserted into the action or the message template as shown. The one exception is the Execute Script action -- in that case, the starting and ending $ are not used.


General Variables

The following variables are always available. Please note that variables are case sensitive.

$Date$ - Current date in string format
$Details$ - Text describing the result of the monitor. This is what most other actions display/report. If you want the value on a single line, you can use $Details_Single_Line$
$Group$ - The group that contains the computer where the monitor detected the issue
$GroupPath$ - The full group path (ie Group1\Group2\Group3) that contains the computer where the monitor detected the issue
$Machine$ - The computer where the monitor detected the issue
$MachineIP$ - The IP address of the computer where the monitor detected the issue. Defaults to 0.0.0.0 if the value can't be determined.
$MachineAlias$ - The aliased computer name (if an alias was entered, otherwise the same as Machine above)
$MonitorTitle$ - Title of the reporting monitor
$MonitorMsg$ - Custom message text from the originating monitor. This can be set in the monitor's Advanced Monitor Options
$NL$ - New Line character
$ProdVer$ - Current version of this program
$MonitorType$ - The type of monitor that detected the issue. This is the same text as you see in the list when choosing to create a new monitor.
$Status$ - Status of the alert. Typically this will be msALERT or msOK depending on whether a problem is being reported, or if an issue is being reported as fixed. msSKIPPINGACTIONS can occur when there is a problem but it shouldn't be alerted on yet.In the case of an emergency alert (internal error for example), you could also potentially see msTRAINING, msERROR or msCANTMONITOR.
$Time$ - Current time in string format
$TimeInError$ - Amount of time that a monitor is or was in error. Ex: "Was in error for 1h 2m 3s"



Row Variables

In addition to the values that are always available, the following values are available depending on which monitor type is sending the alert. The additional information is reported in rows for those monitors that can report information on a number of items (such as a list of changed files and directories). The number in parenthesis (the x) should therefore be replaced with a 1 for the first row of results, 2 for the second, etc. (Example: $Item(1)$, $Item(2)$, $State(1)$...). NOTE: Is is possible to not have any extra row data, especially in the emergency alert cases shown above.

Citrix Monitor $CurrentValue(x)$ - Number of ms for the the Connection or Login to happen. Equals -1 on error
$Item(x)$ - The server being probe
$ItemType(x)$ - Constant value always equal to 'Connection' or 'Login'
$LimitValue(x)$ - Configured threshold seconds for login to complete
$State(x)$ - OK or PROBLEM
Directory Quota Monitor $CurrentValue(x)$ - Directory size in MB
$Item(x)$ - Directory being checked
$ItemType(x)$ - Constant value always equal to 'Directory'
$LimitValue(x)$ - Configured threshold directory size in MB
$State(x)$ - OK or PROBLEM
Disk Space Monitor $CurrentValue(x)$ - Number of free MB on the drive
$Item(x)$ - The drive whose free disk space is being checked
$ItemType(x)$ - Constant value always equal to 'Disk'
$LimitValue(x)$ - Configured threshold (could be in % or an absolute size and unit)
$State(x)$ - OK or PROBLEM
Esensor EM01B Monitor $CurrentValue(x)$ - The value of the measured item
$Item(x)$ - Constant value always equal to 'EM01b Temperature', 'EM01b Humidity', or 'EM01b Luminescence'.
$ItemType(x)$ - Constant value always equal to 'EM01b Temperature', 'EM01b Humidity', or 'EM01b Luminescence'.
$LimitValue(x)$ - Configured threshold for the item
$State(x)$ - OK or PROBLEM
Event Log Monitor $CurrentValue(x)$ - Time of the log item in the Event Log, as a string
$Extra1(x)$ - Content of the log item
$Extra2(x)$ - Event ID of the log item
$Item(x)$ - The Event Log Source that produced the log item
$ItemType(x)$ - Constant value always equal to 'Source'
$State(x)$ - OK or PROBLEM
File Age Monitor $CurrentValue(x)$ - Age of the file in minutes
$Item(x)$ - Complete filename that is too old
$ItemType(x)$ - Constant value always equal to 'File'
$State(x)$ - OK or PROBLEM
File/Directory Size Monitor $CurrentValue(x)$ - Current size of the file/directory
$Item(x)$ - The directory or file that has grown beyond the threshold
$ItemType(x)$ - Constant value always equal to 'Directory' or 'File'
$LimitValue(x)$ - Threshold for the file/directory before firing actions
$State(x)$ - OK or PROBLEM
File & Directory Change Monitor (IDS) $CurrentValue(x)$ - Type of change that occurred. One of: 'Created', 'Deleted', or 'Changed'.
$Item(x)$ - Complete filename or directory that changed
$ItemType(x)$ - Constant value always equal to 'File' or 'Directory'
$State(x)$ - OK or PROBLEM
File Sight Monitor $CurrentValue(x)$ - Type of change that occurred. One of: 'Created', 'Deleted', 'Renamed', 'Read', or 'Wrote'.
$Extra1(x)$ - Name of the user that made the change
$Extra2(x)$ - Name of the application (if available) used to make the change
$Item(x)$ - Complete filename that was viewed or changed
$ItemType(x)$ - Constant value always equal to 'File'
$State(x)$ - OK or PROBLEM
Log File Monitor $Extra1(x)$ - Content of the matching log line(s)
$Item(x)$ - The Log File that produced the log item
$ItemType(x)$ - Constant value always equal to 'File'
$State(x)$ - OK or PROBLEM
Mail Server Monitor $Item(x)$ - The mail server being monitored
$ItemType(x)$ - Constant value always equal to 'Server'
$State(x)$ - OK or PROBLEM
FTP Server Monitor $Item(x)$ - The ftp server being monitored
$ItemType(x)$ - Constant value always equal to 'Server'
$State(x)$ - OK or PROBLEM
Performance Monitor $CurrentValue(x)$ - Current value of the counter
$Item(x)$ - The complete path of the performance counter
$ItemType(x)$ - Constant value always equal to 'Counter'
$LimitValue(x)$ - Configured threshold value as specified in the monitor
$State(x)$ - OK or PROBLEM
Ping Monitor $CurrentValue(x)$ - Time the ping took to return (could possibly be empty depending on settings)
$Item(x)$ - The host name/IP address of the server/device being pinged
$ItemType(x)$ - Constant value always equal to 'Server'
$LimitValue(x)$ - Maximum time the ping is allowed to take before alerting
$State(x)$ - OK or PROBLEM
TCP Port Monitor $Extra1(x)$ - Port that is being monitored
$Item(x)$ - The server being monitored
$ItemType(x)$ - Constant value always equal to 'Server'
$State(x)$ - OK or PROBLEM
Execute Script $Item(x)$ - Unused
$State(x)$ - OK or PROBLEM
Calculated Status $Item(x)$ - Unused
$State(x)$ - OK or PROBLEM
Service Monitor $CurrentValue(x)$ - One of three values: 'Up', 'Down', or '?' if the status can't be determined
$Extra1(x)$ - The display name of the service being checked
$Item(x)$ - The system name for the service being checked
$ItemType(x)$ - Constant value always equal to 'Service'
$State(x)$ - OK or PROBLEM
Process Monitor $CurrentValue(x)$ - Either 'Up' or 'Down'
$Item(x)$ - The process name being checked
$ItemType(x)$ - Constant value always equal to 'Process'
$LimitValue(x)$ - Configured threshold value as specified in the monitor
$State(x)$ - OK or PROBLEM
SNMP Monitor $CurrentValue(x)$ - The current value of the object
$Item(x)$ - The name of the SNMP object being queried
$ItemType(x)$ - Constant value always equal to 'Object'
$LimitValue(x)$ - Configured threshold for the object
$State(x)$ - OK or PROBLEM
Server Temperature Monitor $CurrentValue(x)$ - Current temperature
$Item(x)$ - Probe Number
$ItemType(x)$ - Constant value always equal to 'Temperature'
$LimitValue(x)$ - Threshold temperature
$State(x)$ - OK or PROBLEM
User Quota Monitor $CurrentValue(x)$ - Current size being used by the user
$Item(x)$ - The user who is over or under their quote
$ItemType(x)$ - Constant value always equal to 'User'
$LimitValue(x)$ - Maximum size allowed before alert actions are fired
$State(x)$ - OK or PROBLEM
File System Analyzer $CurrentValue(x)$ - Current size the user or directory is using
$Item(x)$ - The user or directory that is being reported on
$ItemType(x)$ - Constant value always equal to 'User' or 'Directory'
$State(x)$ - OK or PROBLEM
Web Monitor $CurrentValue(x)$ - Time the page took to return
$Item(x)$ - The URL being monitored
$ItemType(x)$ - Constant value always equal to 'URL'
$LimitValue(x)$ - Maximum time the page was allowed to take before alerting
$State(x)$ - OK or PROBLEM

PA File Sight

Help Map
 
Power Admin Social Network Channels
site search

Download Trial
Buy Now