D3. The Parameters of the Notification System Templates

Top  Previous  Next

The text for messages is generated by a Server component named the templates processor on the basis of the templates files.

Windows network message system functions only under Windows OS with Windows Messenger (Net Send) service support.

Windows Vista OS and later do not support Windows Messenger service.

A template file consists of text and variables enclosed in braces. When editing a template file, the variables listed below can be used.

The templates processor does not perform recursive substitutions.

The variables are written as follows:

{<VAR>}—substitute the current value of the <VAR> variable.

{<VAR>:<N>}—the first <N> characters of the <VAR> variable.

{<VAR>:<first>:<N>}—the value of <N> characters of the <VAR> variable that go after the first <first> characters (beginning from the <first>+1 symbol), if the remainder is less, it is supplemented by spaces on the right.

{<VAR>:<first>:-<N>}—the value of <N> characters of the <VAR> variable that go after the first <first> characters (beginning from the <first>+1 symbol), if the remainder is less, it is supplemented by spaces on the left.

{<VAR>/<original1>/<replace1>[/<original2>/<replace2>]}—replace specified characters of <VAR> variable with given characters: <original1> characters are replaced with <replace1> characters, <original2> characters are replaced with <replace2> characters, etc.

There is no limitation for the number of substitution pairs.

Notation of variables

Variable

Value

Expression

Result

SYS.TIME

10:35:17:456

{SYS.TIME:5}

10:35

SYS.TIME

10:35:17:456

{SYS.TIME:3:5}

35:17

SYS.TIME

10:35:17:456

{SYS.TIME:3:-12}

°°°35:17:456

SYS.TIME

10:35:17:456

{SYS.TIME:3:12}

35:17:456°°°

SYS.TIME

10:35:17:456

{SYS.TIME/10/99/35/77}

99:77:17.456

Conventions

Environment Variables

To form messages texts you can use environment variables of the Server process (the System user).

Environment variables are available in the Control Center messages editor, in the ENV drop-down list. Please note: the variables must be specified with the ENV. prefix (the prefix ends with a dot).

System Variables

SYS.BRANCH—system version (Server and Agents),

SYS.BUILD—Server build date,

SYS.DATE—current system date,

SYS.DATETIME—current system date and time,

SYS.OS—Server operating system name,

SYS.PLATFORM—Server platform,

SYS.PLATFORM.SHORT—short variant of SYS.PLATFORM,

SYS.SERVER—product name (Dr.Web Server),

SYS.TIME—current system time,

SYS.VERSION—Server version.

Common Variables for Stations

GEN.LoginTime—station login time,

GEN.StationAddress—station address,

GEN.StationID—station UUID,

GEN.StationName—station name,

GEN.StationPrimaryGroupName—name of the station primary group,

GEN.StationPrimaryGroupID—ID of the station primary group.

Common Variables for Repository

GEN.CurrentRevision—current version identifier,

GEN.Folder—product location folder,

GEN.NextRevision—updated version identifier,

GEN.Product—product description.

Variables by Message Types

Administrators

Message

Variables

Description

Administrator authorization failed

MSG.Login

login

MSG.Address

Control Center network address

MSG.LoginErrorCode

numeric error code

Unknown administrator

MSG.Login

login

MSG.Address

network address of Dr.Web Security Control Center

Installations

For messages of this group, you can also use common variables for stations given above.

Message

Variables

Description

Installation on station failed

MSG.Error

error message

Installation on station successfully completed

no variables are available

Licenses

Message

Variables

Description

License key expiration

Sent if a license key is about to expire and the automatic update of a license is not available.

MSG.ExpirationDate

date of license expiration

MSG.Expired

1—the term has expired

0—the term has not expired

MSG.KeyId

Identifier of a license key

MSG.KeyName

Name of a license key

Licenses donation has expired

Sent if the time of licenses donation to the neighbor Server has expired.

MSG.ObjId

license key ID

MSG.Server

the neighbor Server name

License key automatically updated

Sent if a license key has been automatically updated. At this, a new key has been successfully downloaded and propagated on all objects of an old license key.

MSG.KeyId

Identifier of an old license key

MSG.KeyName

Name of an old license key

MSG.NewKeyId

Identifier of a new license key

MSG.NewKeyName

Name of a new license key

License key cannot be automatically updated

Sent if a license key cannot be automatically updated, because the compound of licensed components differs in the current and the new keys or the new license key has fewer licenses than the current license key. At this, a new key successfully downloaded but not propagated on all objects of an old license key. You must replace the license key manually.

MSG.ExpirationDate

date of license expiration

MSG.Expired

1—the term has expired

0—the term has not expired

MSG.KeyId

Identifier of an old license key

MSG.KeyName

Name of an old license key

MSG.NewKeyId

Identifier of a new license key

MSG.NewKeyName

Name of a new license key

MSG.KeyDifference

The reason why the key cannot be updated:

1—the compound of licensed components differs in the current and the new license keys

2—the new license key has fewer licenses than the current license key

Limitation on donated licenses is reached

Sent when trying to donate to the neighbor Server more licenses than the license key has.

MSG.ObjId

license key ID

Limitation on online stations is reached

Sent when a new station cannot log in on the Server due to the license limitations.

MSG.ID

station UUID

MSG.StationName

station name

Common variables for stations given above are also available.

Limitation on stations in the group is approaching

Sent at every Server launch in case the Server is launched with a key allowing a lesser number of stations than it already has.

MSG.Licensed

permitted by license

MSG.Percent

the percentage of free licenses

MSG.Used

number of stations in the base

GEN.StationPrimaryGroupID

primary group ID

GEN.StationPrimaryGroupName

primary group name

Limitation on stations in the group is exceeded

Sent when the number of registered stations is approaching the license limit, namely less than 5% of the license limit or less than two stations is unused.

MSG.Licensed

permitted by license

MSG.Used

number of stations in the base

GEN.StationPrimaryGroupName

primary group name

GEN.StationPrimaryGroupID

primary group ID

Newbies

For messages of this group, you can also use common variables for stations given above.

Message

Variables

Description

Station automatically rejected

no variables are available

Station is waiting for approval

Station rejected by administrator

MSG.AdminAddress

Control Center network address

MSG.AdminName

administrator name

Other

Message

Variables

Description

Epidemic in the network

MSG.Action

action performed

MSG.Infected

number of detected threats

MSG.Virus

threat type

Neighbor Server has not connected for a long time

MSG.LastDisconnectTime

the time when the Server has been connected at the last time

MSG.StationName

the neighbor Server name

Server log rotation error

MSG.Error

message text

Server log write error

MSG.Error

message text

Statistic report

MSG.Attachment

path to the report

MSG.AttachmentType

MIME type

GEN.File

report file name

Test message

MSG.TestMessage

text of the test message

Repository

For messages of this group, you can also use common variables for repository given above.

Message

Variables

Description

Not enough free space on disk

Sent when it is not enough free space on disk with variable data.

Common variables for repository given above are not available.

MSG.FreeInodes

the number of free inodes file descriptors (has the meaning only for some UNIX system-based OS)

MSG.FreeSpace

free space in bytes

MSG.Path

the path to the folder with low free space

MSG.RequiredInodes

number of free inodes required for operation (has the meaning only for some UNIX system-based OS)

MSG.RequiredSpace

free space required for operation

Repository product cannot be updated

MSG.Error

error message

MSG.ExtendedError

detailed description of an error

Repository product is up-to-date

no variables are available

Repository product is updated

MSG.Added

list of added files (each name in a separate line)

MSG.AdddedCount

number of added files

MSG.Deleted

list of deleted files (each name in a separate line)

MSG.DeletedCount

number of deleted files

MSG.Replaced

list of replaced files (each name in a separate line)

MSG.ReplacedCount

number of replaced files

Update of repository product is frozen

no variables are available

Update of repository product is started

The variables of the Repository product is up-to-date template do not include the files marked as not to be notified of in the product configuration file, read F1. The Syntax of the Configuration File .config.

Stations

For messages of this group, you can also use common variables for stations given above.

Message

Variables

Description

Cannot create the station account

MSG.ID

station UUID

MSG.StationName

station name

Connection terminated abnormally

MSG.Reason

reason for the termination

MSG.Type

client type

Critical error of station update

MSG.Product

updated product

MSG.ServerTime

local time of receipt of a message by the Server

Scan error

MSG.Component

component name

MSG.Error

error message

MSG.ObjectName

object name

MSG.ObjectOwner

object owner

MSG.RunBy

component is launched by this user

MSG.ServerTime

event receipt time, GMT

Scan statistics

MSG.Component

component name

MSG.Cured

number of cured objects

MSG.DeletedObjs

number of deleted objects

MSG.Errors

number of scan errors

MSG.Infected

number of infected objects

MSG.Locked

number of blocked objects

MSG.Modifications

number of objects infected with known modifications of viruses

MSG.Moved

number of moved objects

MSG.Renamed

number of renamed objects

MSG.RunBy

component is launched by this user

MSG.Scanned

number of scanned objects

MSG.ServerTime

event receipt time, GMT

MSG.Speed

processing speed in KB/s

MSG.Suspicious

number of suspicious objects

MSG.VirusActivity

 

Security threat detected

MSG.Action

action upon a detection

MSG.Component

component name

MSG.InfectionType

threat type

MSG.ObjectName

infected object name

MSG.ObjectOwner

infected object owner

MSG.RunBy

user who launched the component that detects the threat

MSG.ServerTime

event receipt time, GMT

MSG.Virus

threat name

Station already logged in

Sent if the station is currently registered at this or another Server.

MSG.ID

station UUID

MSG.Server

ID of the Server at which the station is registered

MSG.StationName

name of the station

Station approved by administrator

MSG.AdminAddress

network address of the Control Center

MSG.AdminName

administrator name

Station authorization failed

MSG.ID

station UUID

MSG.Rejected

values:

0—access for the station is denied

1—the station state will be reset to "newbie"

MSG.StationName

station name

Station automatically approved

no variables are available

Station has not connected to the Server for a long time

Common variables for stations given above are not available.

MSG.DaysAgo

number of days since the last connection to the Server

MSG.LastSeenFrom

address of the station at the last connection to the Server

MSG.StationID

station UUID

MSG.StationName

station name

Station reboot required

MSG.Product

updated product

MSG.ServerTime

local time of receipt of a message by the Server

Unknown station

MSG.ID

UUID of unknown station

MSG.Rejected

values:

0—access for the station is denied

1—the station state will be reset to "newbie"

MSG.StationName

station name