| GeViScope SDK > Action documentation > System actions

System actions

All actions describing system behaviour.

Custom action

Action name:CustomAction(Int, String)

Action category: logical

This action has no side effects and can be used for customer purposes.

Parameter		Function
INT parameter	Int	Numeric parameter.
STRING parameter	String	Literal parameter.

Database recording info per ring

Action name:DatabaseRecordingInfoRing(DatabaseRing, NoVideoRecording, NoAudioRecording, NoRecordingAtAll, VideoSamplesPerSecond, VideoMBPerSecond, AudioSamplesPerSecond, AudioMBPerSecond, WriteWaitTimesPercent, RingCapacity, OldestItem, RecordingDepth, EstimatedRequiredCapacity)

Action category: logical

Database recording info per ring.

Parameter		Function
database ring	DatabaseRing	Database ring.
no video recording	NoVideoRecording	Video is recording or not.
no audio recording	NoAudioRecording	Audio is recording or not.
no recording	NoRecordingAtAll	Video and/or audio is recording or not.
video samples/s	VideoSamplesPerSecond	Video samples per second.
video samples MB/s	VideoMBPerSecond	Video MB per second.
audio samples/s	AudioSamplesPerSecond	Audio samples per second.
audio samples MB/s	AudioMBPerSecond	Audio MB per second.
write wait %	WriteWaitTimesPercent	Write wait times in percent.
ring capacity	RingCapacity	Ring capacity.
oldest item	OldestItem	Time stamp of the oldest item.
recording depth	RecordingDepth	Recording depth in hours.
estimated required capacity	EstimatedRequiredCapacity	Estimated required capacity.

Database recording info total

Action name:DatabaseRecordingInfoTotal(NoVideoRecording, NoAudioRecording, NoRecordingAtAll, VideoSamplesPerSecond, VideoMBPerSecond, AudioSamplesPerSecond, AudioMBPerSecond, WriteWaitTimesPercent, TotalCapacity, FreeCapacity, AllocatedCapacity, OldestItem, RecordingDepth, EstimatedRequiredCapacity, RequiredCapacityFactor, RequiredCapacityAvailable)

Action category: logical

Database recording info total.

Parameter		Function
no video recording	NoVideoRecording	Video is recording or not.
no audio recording	NoAudioRecording	Audio is recording or not.
no recording	NoRecordingAtAll	Video and/or audio is recording or not.
video samples/s	VideoSamplesPerSecond	Video samples per second.
video samples MB/s	VideoMBPerSecond	Video MB per second.
audio samples/s	AudioSamplesPerSecond	Audio samples per second.
audio samples MB/s	AudioMBPerSecond	Audio MB per second.
write wait %	WriteWaitTimesPercent	Write wait times in percent.
total capacity	TotalCapacity	Total capacity.
free capacity	FreeCapacity	Free capacity.
allocated capacity	AllocatedCapacity	Allocated capacity.
oldest item	OldestItem	Time stamp of the oldest item.
recording depth	RecordingDepth	Recording depth in hours.
estimated required capacity	EstimatedRequiredCapacity	Estimated required capacity.
required capacity factor	RequiredCapacityFactor	Required capacity factor.
required capacity available	RequiredCapacityAvailable	Required capacity available.

Database started

Action name:DatabaseStarted(Status, TotalSize)

Action category: logical

This action will be fired at the database start-up.

Parameter		Function
status	Status	Database status message.
total size	TotalSize	Database total size.

Event recording changed

Action name:EventRecordingChanged(EventID, TypeID)

Action category: logical

Event recording settings are changed.

Parameter		Function
instance ID	EventID	Instance ID of the event.
event type	TypeID	Type of the event.

Event started

Action name:EventStarted(EventID, TypeID, ForeignKey)

Action category: logical

Event has started.

Parameter		Function
instance ID	EventID	Instance ID of the event.
event type	TypeID	Type of the event.
foreign key	ForeignKey	Optional foreign key used to start the alarm.

Event stopped

Action name:EventStopped(EventID, TypeID)

Action category: logical

Event has stopped.

Parameter		Function
instance ID	EventID	Instance ID of the event.
event type	TypeID	Type of the event.

FRC notification

Action name:FRCNotification(Notification, Param, Description, XMLInfo)

Action category: logical

FRC notification.

Parameter		Function
notification	Notification	Notification reason.
param	Param	Additional parameter.
description	Description	Optional notification text.
additional info	XMLInfo	Optional additional info (usually as XML string).

GEMOS alarm

Action name:GEMOSalarm(GEMOSkey, GEMOSint, GEMOSstr)

Action category: logical

GEMOS alarm notification.

Parameter		Function
GEMOS key	GEMOSkey	GEMOS alarm key.
GEMOS int	GEMOSint	GEMOS alarm integer parameter.
GEMOS str	GEMOSstr	GEMOS alarm string parameter.

Kill all events

Action name:KillAllEvents()

Action category: logical

Kill all active events.

Kill event

Action name:KillEvent(TypeID)

Action category: logical

Kill event.

Parameter		Function
event type	TypeID	Type of the event.

Kill event by instance

Action name:KillEventByID(EventID)

Action category: logical

Kill event by instance ID.

Parameter		Function
instance ID	EventID	Instance ID of the event.

Live check

Action name:LiveCheck(Counter, Date)

Action category: logical

This action will be fired every 10 seconds and intended for use as live check.

Parameter		Function
counter	Counter	This is the number of already fired live check actions.
time stamp	Date	Current server time.

Set clock

Action name:SetClock(Date)

Action category: logical

Set clock.

Parameter		Function
current time	Date	Current time.

Setup changed

Action name:SetupChanged(User, Host, Date, ResourceKind, ResourceID, ChangeKind, Details, ClientHost, ClientType, ClientAccount)

Action category: logical

Setup changed.

Parameter		Function
user name	User	Name of the user modified the setup.
remote host	Host	Host from where the connection was done.
current time	Date	Current time.
resource kind	ResourceKind	Modified resource kind.
resource ID	ResourceID	Modified resource ID.
change kind	ChangeKind	Change kind.
details	Details	Details of the modification.
client host	ClientHost	Host from where the connection is done.
client type	ClientType	Client type.
client account	ClientAccount	User account from where the connection is done.

Setup upload progress

Action name:SetupUploadProgress(User1, User2, Host, Progress, Date)

Action category: logical

Setup upload progress.

Parameter		Function
first user	User1	Name of the user modified the setup.
second user	User2	Name of the second user by four eyes authentication.
remote host	Host	Host from where the connection was done.
progress %	Progress	Progress in percent.
current time	Date	Current stage time.

Set watchdog

Action name:SetWatchdog(Timeout)

Action category: logical

Set watchdog.

Parameter		Function
timeout	Timeout	Timeout in seconds, before the watchdog must be retriggered and before the hardware watchdog will set the hardware contact.

SMRP viewer cleared

Action name:SMRPViewerCleared()

Action category: logical

SMRP viewer cleared.

SMRP viewer connected

Action name:SMRPViewerConnected(Server, Channel)

Action category: logical

SMRP viewer connected to the camera.

Parameter		Function
server	Server	Server name.
channel	Channel	Channel.

SMTP mail

Action name:SMTPMailSend(Subject, To, Cc, Body, Channel)

Action category: logical

This action will send a user defined email if GscMail is connected

Parameter		Function
subject	Subject	Mail subject.
to	To	Mail recepients.
cc	Cc	Carbon copy recepients.
body	Body	Mail body.
channel	Channel	Channel.

Start event

Action name:StartEvent(TypeID, ForeignKey)

Action category: logical

Start event.

Parameter		Function
event type	TypeID	Type of the event.
foreign key	ForeignKey	Optional foreign key used to store for the alarm.

Stop all events

Action name:StopAllEvents()

Action category: logical

Stop all active events.

Stop event

Action name:StopEvent(TypeID)

Action category: logical

Stop event.

Parameter		Function
event type	TypeID	Type of the event.

Stop event by instance

Action name:StopEventByID(EventID)

Action category: logical

Stop event by instance ID.

Parameter		Function
instance ID	EventID	Instance ID of the event.

System error

Action name:SystemError(Source, Message, WindowsError, Description, XMLInfo)

Action category: logical

Notify system error.

Parameter		Function
source subsystem	Source	Source of the message.
message code	Message	Kind of the message.
Windows error code	WindowsError	Optional Windows error code.
description	Description	Optional description of the message.
additional info	XMLInfo	Optional additional info (usually as XML string).

System info

Action name:SystemInfo(Source, Message, Description, XMLInfo)

Action category: logical

Notify system information.

Parameter		Function
source subsystem	Source	Source of the message.
message code	Message	Kind of the message.
description	Description	Optional description of the message.
additional info	XMLInfo	Optional additional info (usually as XML string).

System settings changed

Action name:SystemSettingsChanged(SetupChanged, User1, User2, Host, TimeRangeChanged, TimeRange, LicenceChanged, Date)

Action category: logical

Setup of the system and/or the current time range changed.

Parameter		Function
setup changed	SetupChanged	System setup has changed.
first user	User1	Name of the user modified the setup.
second user	User2	Name of the second user by four eyes authentication.
remote host	Host	Host from where the connection was done.
time range changed	TimeRangeChanged	Time range has changed.
current time range	TimeRange	Currently active time range.
licence changed	LicenceChanged	Licence has changed.
change time	Date	Time of the system settings changed.

System started

Action name:SystemStarted(Date)

Action category: logical

This action will be fired only once at the system start-up.

Parameter		Function
start time	Date	Time of the system start-up.

System terminating

Action name:SystemTerminating(Date, WindowsShutdown)

Action category: logical

This action will be fired when the system is going shutdown.

Parameter		Function
stop time	Date	Time of the system shutdown.
Windows shutdown	WindowsShutdown	Indicates whether the system shutdown is done due to the windows shutdown.

System warning

Action name:SystemWarning(Source, Message, WindowsError, Description, XMLInfo)

Action category: logical

Notify system warning.

Parameter		Function
source subsystem	Source	Source of the message.
message code	Message	Kind of the message.
Windows error code	WindowsError	Optional Windows error code.
description	Description	Optional description of the message.
additional info	XMLInfo	Optional additional info (usually as XML string).

Transfer binary buffer

Action name:TransferBinaryBuffer(InternalHandle, Parameter)

Action category: logical

Transfer binary buffer.

Parameter		Function
internal handle	InternalHandle	Internal handle.
parameter	Parameter	Parameter.

Transfer binary channel buffer

Action name:TransferBinaryChannelBuffer(Channel, InternalHandle, Parameter)

Action category: logical

Transfer binary channel buffer.

Parameter		Function
channel	Channel	Channel.
internal handle	InternalHandle	Internal handle.
parameter	Parameter	Parameter.

User login

Action name:UserLogin(User1, User2, Host, ClientHost, ClientType, ClientAccount)

Action category: logical

This action will be fired when the user has connected to the system.

Parameter		Function
first user	User1	Name of the user connected to the system.
second user	User2	Name of the second user by four eyes authentication.
remote host	Host	Host from where the connection is done.
client host	ClientHost	Host from where the connection is done.
client type	ClientType	Client type.
client account	ClientAccount	User account from where the connection is done.

User login failed

Action name:UserLoginFailed(User1, User2, Host, RejectReason, ClientHost, ClientType, ClientAccount)

Action category: logical

This action will be fired when the user has tried to connect to the system but was rejected.

Parameter		Function
first user	User1	Name of the user tried to connect to the system.
second user	User2	Name of the second user by four eyes authentication.
remote host	Host	Host from where the connection is done.
reject reason	RejectReason	Reason of the rejection.
client host	ClientHost	Host from where the connection is done.
client type	ClientType	Client type.
client account	ClientAccount	User account from where the connection is done.

User logout

Action name:UserLogout(User1, User2, Host, ClientHost, ClientType, ClientAccount)

Action category: logical

This action will be fired when the user has disconnected from the system.

Parameter		Function
first user	User1	Name of the user disconnected from the system.
second user	User2	Name of the second user by four eyes authentication.
remote host	Host	Host from where the connection was done.
client host	ClientHost	Host from where the connection is done.
client type	ClientType	Client type.
client account	ClientAccount	User account from where the connection is done.