Alarms Configuration, rev. 4.9.1 and earlier| Call Recording Reference

VSLogger Alarms Configuration, rev. 4.9.1 and earlier

CLI (Command Line Interface)

How to use CLI Tool - refer to CLI Tool Overview

GUI (Graphical User Interface)

cli>(config)
->alarms

cli>(config-alarms)

Alarm configuration settings can be reached by navigating to Setup->Alarms->Edit
Gallery: alarmconfig-1

General Parameters

GUI Setting	Command Format	Description	Extra Notes
Alarm Settings: Additional Settings for "noactivity" Alarm:	`add [system \| thread \| noactivity \| drivefull \| login \| request]`	add alarm
	`remove [system \| thread \| noactivity \| drivefull \| login \| request]`	remove alarm
	`alarm [system \| thread \| noactivity \| drivefull \| login \| request]`	alarm configuration
	`test [system \| thread \| noactivity \| drivefull \| login \| request]`	test alarm	Force test alarm
	`emails [@com,...] [y\|n]`	add/remove emails to/from recipients list
	`enable [y\|n]`	enable alarms feature	If alarms feature disabled. No alarms will be issued even if added with "add" command.
	`beepperiod [sec]`	beep period (sec) default 0 (once)	Period between beeps, when alarm is issued and not reset yet.
	`sendperiod [hr]`	send email period (hr) default 0 (once)	Email can be resent periodically, until alarm is reset
	`list`	list of available alarms
	`reset`	reset alarms	Alarms can be reset from VSLogger Monitor. Signed In drop down menu > Reset Alarms option is available to all users with Administrator permissions.

Individual Alarm Configuration

system, thread, drivefull, login,request alarm configuration `cli>(config-alarms)` `->alarm thread` `cli>(config-alarms-thread)` `->show` `email: n` `beep: n` `exec: n log: n` `script: ;` `resetscript: ;` `cli>(config-alarms-thread)` `->?` `help\|? - embedded help` `email [y\|n] - enable/disable email` `beep [y\|n] - enable/disable beep log [y\|n] - enable/disable logging``exec [y\|n] - enable/disable script execution` `script [path;prm1,prmN] - script and parameters (optional)` `resetscript [path;prm1,prmN] - reset script and parameters (optional)` `cli>(config-alarms-thread)` Note: for login and request alarms email, beep, exec script and reset script entries ignored by recorder. These alarms enabled only for logging of user activity. See Log File Notes below	noactivity alarm configuration `cli>(config-alarms)` `->add noactivity` `cli>(config-alarms-noactivity)` `->show` `email: n` `beep: n` `exec: n log: n` `script: ;` `resetscript: ;` `noactivitytmout: 1 hrs` `checkhours:` `checkdays:` `exclude:` `cli>(config-alarms-noactivity)` `->?` `help\|? - embedded help` `email [y\|n] - enable/disable email` `beep [y\|n] - enable/disable beep` `log [y\|n] - enable/disable logging exec [y\|n] - enable/disable script execution` `script [path;prm1,prmN] - script and parameters (optional)` `resetscript [path;prm1,prmN] - reset script and parameters (optional)` `noactivitytmout [hr] - not-recording timeout` `checkhours [0-23] [y\|n] - check hours for not-recording timeout` `checkdays [1-7] - check days of the week for not-recording timeout (Su,Mo,Tu,We,Th,Fr,Sa)` `exclude [mm/dd,..] - exclude specific dates from check for not-recording timeout` `cli>(config-alarms-noactivity)`

Individual Alarm Parameters

GUI Setting	Command Format	Description	Extra Notes
	`email [y\|n]`	`enable/disable email`	email alarm notification
	`beep [y\|n]`	`enable/disable beep`	PC speaker beep generated as alarm notification
	`log [y\|n]`	`enable/disable logging`	alarm notification message stored in the log file
	`exec [y\|n]`	`enable/disable script execution`	enable script executions , if set below
	`script [path;prm1,prmN]`	`script and parameters (optional)`	script to execute on alarm
	`resetscript [path;prm1,prmN]`	`reset script and parameters (optional)`	script to execute when alarm is reset by administrator
Extra parameters for noactivity alarm
	`noactivitytmout [hr]`	`not-recording timeout`
	`checkhours [0-23] [y\|n]`	`check hours for not-recording timeout`	for example: checkhours 8-17 - add range of hours checkhours 20 - add specific hour checkhours 12-14 n - remove range of hours checkhours 20 n - remove specific hour show - display current settings
	`checkdays [1-7] [y\|n]`	`check days of the week for not-recording timeout (Su,Mo,Tu,We,Th,Fr,Sa)`	for example: checkdays 2-6 , add work days checkdays 4 n - remove specific day
	`exclude [mm/dd,..] [y\|n]`	`exclude specific dates from check for not-recording timeout`	for example: exclude 12/31, 01/01 - exclude new year holiday exclude 01/01 n - remove specific date

Each alarm can trigger all enabled options:

send email to all recipients in email list. Can send periodic emails, if send period configured.
beep or periodic beeps, if beep period configured
execute script
create log

"Reset alarms" command can trigger separate reset script, if configured.

Alarm Log files

If alarms logging is enabled (log: y) two log files created in C:\ProgramData\Adutante\vslogger\log folder. One for alarms generated in Recording service, other for alarms from Connection service.

Attention:
For versions prior to 4.7.1.0 to enable alarms logging, you should use logging - Logging Configuration
login and request alarms have logging level - info(6). If you wish to have login and user request activities recorded to alarms log files, make sure to set:

cli>(config-log)
->level alarms 6
cli>(config-log)