Appendix D. The Parameters of the Notification System Templates

The text for messages (sent by e-mail or Windows Messenger) 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

° - whitespace.

System Variables (Allowed in Subject, Headers):

SYS.TIME — current system time,

SYS.DATE — current system date,

SYS.DATETIME — current system date and time,

SYS.VERSIONServer version,

SYS.BUILDServer build date,

SYS.PLATFORMServer platform,

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

SYS.OSServer operating system name,

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

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

The environment variables have the same names as the variables specified in the environment with the ENV. prefix added (the prefix ends with a period).

Shared Variables of Messages (the Agent):

GEN.LoginTime — station login time,

GEN.StationAddress — station address,

GEN.StationID — station UUID,

GEN.StationName — station name.

Shared Variables of Messages (Dr.Web Enterprise Server updating subsystem):

GEN.CurrentRevision –– current version identifier,

GEN.NextRevision –– updated version identifier,

GEN.Folder –– product location folder,

GEN.Product –– product description.

Message Variables United According to Message Types (for the Agent):

Administrator_Authorization_Failed:

MSG.Login — login,

MSG.AddressDr.Web Control Center network address;

Approved_Newbie:

MSG.AdminName — administrator name,

MSG.AdminAddress Dr.Web Control Center address;

AutoApproved_Newbie: no variables are available;

Awaiting_Approval: no variables are available;

Cannot_Add_Station:

MSG.ID — station UUID;

Connection_Terminated_Abnormally:

MSG.Reason — reason for the termination;

Infection:

MSG.Component — component name,

MSG.RunBy — component is launched by this user,

MSG.ServerTime — event receipt time (GMT),

MSG.ObjectName — infected object name,

MSG.ObjectOwner — infected object owner,

MSG.InfectionType — infection type,

MSG.Virus — virus name,

MSG.Action — curing action;

Installation_Bad:

MSG.Error — error message;

Installation_OK: no variables are available;

License_Limit:

MSG.Used — number of stations in the base,

MSG.Licensed — permitted by license,

is 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;

Near_Max_Stations:

MSG.Used — number of stations in the base,

MSG.Licensed — permitted by license,

MSG.Percent — the percentage of free licenses,

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

Newbie_Not_Allowed: no variables are available;

Not_Seen_For_A_Long_Time:

MSG.StationName — station name,

MSG.StationID — station UUID,

MSG.DaysAgo — number of days since the last visit,

MSG.LastSeenFrom — address the station was seen at the last visit;

Processing_Error:

MSG.Component — component name,

MSG.RunBy — component is launched by this user,

MSG.ServerTime — event receipt time (GMT),

MSG.ObjectName — object name,

MSG.ObjectOwner — object owner,

MSG.Error — error message;

Rejected_Newbie:

MSG.AdminName — administrator name,

MSG.AdminAddress — administrator Dr.Web Control Center address;

Station_Already_Logged_In:

MSG.ID — station UUID,

MSG.StationName — name of the station,

MSG.Server — ID of the Server at which the station is registered,

is sent, if the station is already currently registered at this or another Server;

Station_Authorization_Failed:

MSG.ID — station UUID,

MSG.Rejected — values: rejected — access to a station is denied, newbie — there was an attempt to assign the "newbie" status to a station;

Statistics:

MSG.Component — component name,

MSG.ServerTime — event receipt time (GMT),

MSG.Scanned — number of scanned objects,

MSG.Infected — number of infected objects,

MSG.Modifications — number of objects infected with known modifications of viruses,

MSG.Suspicious — number of suspicious objects,

MSG.Cured — number of cured objects,

MSG.Deleted — number of deleted objects,

MSG.Renamed — number of renamed objects,

MSG.Moved — number of moved objects,

MSG.Speed — processing speed in KB/s;

Too_Many_Stations:

MSG.ID — station UUID,

is sent when a new station cannot log in on the Server due to the license limitations;

Unknown_Administrator:

MSG.Login — login,

MSG.Address — network Dr.Web Control Center address;

Unknown_Station:

MSG.ID — UUID of unknown station,

MSG.Rejected — values: rejected — access for a station is denied; newbie — there was an attempt to assign the "newbie" status to a station;

Update_Failed:

MSG.Product — updated product,

MSG.ServerTime — (local) time of receipt of a message by the Server;

Update_Wants_Reboot:

MSG.Product — updated product,

MSG.ServerTime — (local) time of receipt of a message by the Server.

Message variables, according to messages (for Server updating subsystem):

Srv_Repository_Cannot_flush: no variables are available;

Srv_Repository_Frozen: no variables are available;

Srv_Repository_Load_failure:

MSG.Reason — message on the cause of the error;

Srv_Repository_Update:

MSG.AdddedCount — number of added files,

MSG.ReplacedCount — number of replaced files,

MSG.DeletedCount — number of deleted files,

MSG.Added — list of added files (each name in a separate line),

MSG.Replaced — list of replaced files (each name in a separate line),

MSG.Deleted — list of deleted files (each name in a separate line);

Srv_Repository_UpdateFailed:

MSG.Error — error message,

MSG.ExtendedError — detailed description of the error;

Srv_Repository_UpToDate: no variables are available.

 

The variables of the last 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.

 

The variables of the Server messages about the coming license expiration.

Key_Expiration:

MSG.Expiration — date of license expiration,

MSG.Expired — 1, if the term has expired, otherwise 0,

MSG.ObjId — object GUID,

MSG.ObjName — object name,

MSG.ObjType – object using an expiring key (server/station/group).