================================================================================
GeViScope SDK Documentation - Pages 61 to 80
================================================================================


============================================================
PAGE 61
============================================================

Special functions are mapped to this action.
(MBeg functions X, Y, U and V).
Parameter
Function
PTZ head
Camera
Global camera number
Camera spec func V off
Action name: CameraSpecFuncVOff(PTZ Head)
Category: command
Special functions are mapped to this action.
(MBeg functions X, Y, U and V).
Parameter
Function
PTZ head
Camera
Global camera number
Camera spec func V on
Action name: CameraSpecFuncVOn(PTZ Head)
Category: command
Special functions are mapped to this action.
(MBeg functions X, Y, U and V).
Parameter
Function
PTZ head
Camera
Global camera number
Camera spec func X off
Action name: CameraSpecFuncXOff(PTZ Head)
Category: command
Special functions are mapped to this action.
(MBeg functions X, Y, U and V).
Parameter
Function
PTZ head
Camera
Global camera number
Camera spec func X on
Action name: CameraSpecFuncXOn(PTZ Head)
Category: command
Special functions are mapped to this action.
(MBeg functions X, Y, U and V).
Parameter
Function
PTZ head
Camera
Global camera number
Camera spec func Y off
Action name: CameraSpecFuncYOff(PTZ Head)
Category: command
Special functions are mapped to this action.
(MBeg functions X, Y, U and V).
Parameter
Function
PTZ head
Camera
Global camera number


============================================================
PAGE 62
============================================================

Camera spec func Y on
Action name: CameraSpecFuncYOn(PTZ Head)
Category: command
Special functions are mapped to this action.
(MBeg functions X, Y, U and V).
Parameter
Function
PTZ head
Camera
Global camera number
Camera stop all
Action name: CameraStopAll(PTZ Head)
Category: command
This action stops all movements of the camera.
Parameter
Function
PTZ head
Camera
Global camera number
Camera text off
Action name: CameraTextOff(PTZ Head)
Category: command
This action turns off the text display of the camera.
Parameter
Function
PTZ head
Camera
Global camera number
Camera text on
Action name: CameraTextOn(PTZ Head)
Category: command
This action turns on the text display of the camera.
Parameter
Function
PTZ head
Camera
Global camera number
Camera tour start
Action name: CameraTourStart(PTZ Head, tour ID, tour name)
Category: command
This action starts a pre-defined tour.
Parameter
Function
PTZ head
Camera
Global camera number
tour id
TourID
Tour id.
tour name
TourName
Tour name.
Camera tour stop
Action name: CameraTourStop(PTZ Head)
Category: command
This action stops a running tour.
Parameter
Function
PTZ head
Camera
Global camera number


============================================================
PAGE 63
============================================================

Camera version off
Action name: CameraVersionOff(PTZ Head)
Category: command
With this action the firmware version of the camera will be hidden.
Parameter
Function
PTZ head
Camera
Global camera number
Camera version on
Action name: CameraVersionOn(PTZ Head)
Category: command
With this action the firmware version of the camera will be shown as OSD.
Parameter
Function
PTZ head
Camera
Global camera number
Camera wash-wipe off
Action name: CameraWashOff(PTZ Head)
Category: command
This action disables the functions “wash” and “wipe”.
Parameter
Function
PTZ head
Camera
Global camera number
Camera wash-wipe on
CameraWashWhipeOn
Action name: CameraWashOn(PTZ Head)
Category: command
This action enables the functions “wash” and “wipe”.
Parameter
Function
PTZ head
Camera
Global camera number
Move to default position
Action name:DefaultPosCallUp(Camera)
Action category: command
The PTZ camera moves back to the home position (usually position 1).
Therefor the home position has to be set and saved in advance by the action "SaveDe-
faultPosition".
Parameter
Function
PTZ head
Camera
Global camera number
Clear default position
Action name: ClearDefaultPosition(PTZ Head)
Category: command
This action deletes the currently defined default position.
Parameter
Function
PTZ head
Camera
Global camera number


============================================================
PAGE 64
============================================================

Clear preset position
Action name: CameraPresetPosition(PTZ Head, position)
Category: command
This action deletes a position previously saved by the action “SavePresetPosition”.
Parameter
Function
PTZ head
Camera
Global camera number
position
Number of camera position to be deleted.
Save default position
Action name: SaveDefaultPosition(PTZ Head)
Category: command
This action saves the current position of the camera as default position.
Parameter
Function
PTZ head
Camera
Global camera number
Fast speed off
Action name: FastSpeedOff(PTZ Head)
Category: command
This action switches from high-speed of the camera to normal speed of the camera.
Parameter
Function
PTZ head
Camera
Global camera number
Fast speed on
Action name: FastSpeedOn(PTZ Head)
Category: command
This action switches from normal speed of the camera to high-speed of the camera.
Parameter
Function
PTZ head
Camera
Global camera number
Focus far
Action name:FocusFar(Camera, Speed)
Action category: command
The camera focus adjusts on far.
Parameter
Function
PTZ head
Camera
Global camera number
speed
Speed
Depending on the protocol of camera man-
ufacturer velocities between 1 and 255 are
being adjusted to the velocity range of the
camera.
Focus near
Action name:FocusNear(Camera, Speed)
Action category: command
The camera focus adjusts on near.


============================================================
PAGE 65
============================================================

Parameter
Function
PTZ head
Camera
Global camera number
speed
Speed
Depending on the protocol of camera man-
ufacturer velocities between 1 and 255 are
being adjusted to the velocity range of the
camera.
Focus stop
Action name:FocusStop(Camera)
Action category: command
The camera stops the focusing process.
Parameter
Function
PTZ head
Camera
Global camera number
Iris close
Action name:IrisClose(Camera)
Action category: command
The camera closes the aperture.
Parameter
Function
PTZ head
Camera
The camera closes the aperture
Iris open
Action name:IrisOpen(Camera)
Action category: command
The camera opens the aperture.
Parameter
Function
PTZ head
Camera
The camera opens the aperture
Iris stop
Action name:IrisStop(Camera)
Action category: command
The camera stops closing/opening aperture.
Parameter
Function
PTZ head
Camera
The camera stops
closing/opening
aperture
Move to absolute position
For internal use only
Move to by speed
For internal use only
Move to relative position
For internal use only


============================================================
PAGE 66
============================================================

Pan auto
Action name:PanAuto(Camera, Modus)
Action category: command
Cameras without automatic end stop turn on and on until this function is stopped through the
action "PanStop". Cameras with automatic end stop do stop automatically after a 360 turn.
It depends on the camera type if this function is even available and in case how it is going to
be accomplished.
Parameter
Function
PTZ head
Camera
Global camera number
modus
Modus
Depends on camera type (model and man-
ufacturer)
Pan left
Action name:PanLeft(Camera, Speed)
Action category: command
The camera pans to the left.
Parameter
Function
PTZ head
Camera
Global camera number
modus
Speed
Depending on the protocol of camera man-
ufacturer velocities between 1 and 255 are
being adjusted to the velocity range of the
camera.
Pan right
Action name:PanRight(Camera, Speed)
Action category: command
The camera pans to the right.
Parameter
Function
PTZ head
Camera
Global camera number
modus
Speed
Pan speed.
Pan stop
Action name:PanStop(Camera)
Action category: command
The camera stops pan movement.
Parameter
Function
PTZ head
Camera
Global camera number
Move to preset position
Action name:PrePosCallUp(Camera, Position)
Action category: command
The camera moves to a preset position determined in advance through the action "SavePre-
setPosition".
Parameter
Function
PTZ head
Camera
Global camera number
position
Position
Number of selected preset position.
The amount of positions to save depends on


============================================================
PAGE 67
============================================================

Parameter
Function
the camera type (model and manufacturer).
Clear preset position
Action name:PrePosClear(Camera, Position)
Action category: command
Clear camera preset position.
Parameter
Function
PTZ head
Camera
Global camera number
position
Position
Preset position.
Save preset position
Action name:PrePosSave(Camera, Position)
Action category: command
Saves current position of the PTZ camera as a preset position.
Parameter
Function
PTZ head
Camera
Global camera number
position
Position
Number of preset position on which the cur-
rent position of the camera should be saved.
The amount of positions to save depends on
the camera type (model and manufacturer).
Set camera text
Action name: SaveCameraText(PTZ Head, text)
Category: command
This action saves the camera description in accordance with the parameter “text”.
Parameter
Function
PTZ head
Camera
Global camera number
text
Text
Text to be displayed on the camera as OSD.
Tilt down
Action name:TiltDown(Camera, Speed)
Action category: command
The camera tilts down.
Parameter
Function
PTZ head
Camera
Global camera number
speed
Speed
Depending on the protocol of camera man-
ufacturer velocities between 1 and 255 are
being adjusted to the velocity range of the
camera.
Tilt stop
Action name:TiltStop(Camera)
Action category: command
The camera stops the tilt movement.
Parameter
Function
PTZ head
Camera
Global camera number


============================================================
PAGE 68
============================================================

Tilt up
Action name:TiltUp(Camera, Speed)
Action category: command
The camera tilts up.
Parameter
Function
PTZ head
Camera
Global camera number
speed
Speed
Depending on the protocol of camera man-
ufacturer velocities between 1 and 255 are
being adjusted to the velocity range of the
camera.
Zoom in
Action name:ZoomIn(Camera, Speed)
Action category: command
The Camera zooms in (tele range).
Parameter
Function
PTZ head
Camera
Global camera number
speed
Speed
Depending on the protocol of camera man-
ufacturer velocities between 1 and 255 are
being adjusted to the velocity range of the
camera.
Zoom out
Action name:ZoomOut(Camera, Speed)
Action category: command
The camera zooms out (wide-angle range).
Parameter
Function
PTZ head
Camera
Global camera number
speed
Speed
Depending on the protocol of camera man-
ufacturer velocities between 1 and 255 are
being adjusted to the velocity range of the
camera.
Zoom stop
Action name:ZoomStop(Camera)
Action category: command
The camera stops zooming process.
Parameter
Function
PTZ head
Camera
Global camera number
Cash management actions
Cash Management Actions offer the exchange of accompanying meta data between Cash
Management Systems and GeViScope/Re_porter. With these actions money handling pro-
cesses can be documented consistently via video. The use of these actions for starting and
restarting of event recordings leads to the display of the accompanying video data in live


============================================================
PAGE 69
============================================================

streams of GscView and the storage of those in the video database. The video sequences
recorded by Cash Management Actions can later be recovered easily in GscView by using
the accompanying meta data and a special data filter dialog.
Safebag close
Action name:SafebagClose(WorkingPlace, StartTime, StopTime, SafebagNo, Safe-
bagInfo, StepID, Debit, Total, Difference, HasDifference, Notes, Coins, Cheques)
Action category: logical
Safebag close.
The integrated Cash Management System sends the action as soon as the user has fin-
ished the counting of one safe bag and has confirmed that to the Cash Management System
.
Via the parameter "working place" the affected working place will be identified. The further
parameter will be provided with accompanying video data by Cash Management System.
The parameter "StepID" can be provided with a code figure by the Cash Management Sys-
tem for the currently running process step.
Parameter
Function
working
place
WorkingPlace Working place no.
start time StartTime
Time stamp, when the handling of the safe bag began.
stop time
StopTime
Time stamp, when the handling of the safe bag stopped.
safebag
no.
SafebagNo
Alphanumerical identification of safe bag; search criteria in GscView
safebag
info
SafebagInfo
Additional alphanumerical identification of safe bag
step id
StepID
Code figure for the currently running process step (given by Cash Man-
agement System individually)
debit
Debit
Debit amount of safebag
total
Total
Effective total amount of safe bag according to counting (will be accu-
mulated by Cash Management Systems on counting)
difference Difference
Difference between total amount and result respectively progress of
counting
has dif-
ference
HasDifference Yes = current total amount has a difference to debit amount
No = current total amount is identical with debit amount
notes
Notes
Denomination of counted banknotes. The Display in GscView is in table
form. The table has max. 2 columns. The individual lines can be sep-
arated via insertion of control '\r' (0x0D). The separation of both
columns within one line can be carried out via insertion of control '\t'
(0x09).
coins
Coins
Denomination of counted coins. The Display in GscView is in table
form. The table has max. 2 columns. The individual lines can be sep-
arated via insertion of control '\r' (0x0D). The separation of both
columns within one line can be carried out via insertion of control '\t'
(0x09).
cheques
Cheques
Denomination of counted cheques. The Display in GscView is in table
form. The table has max. 2 columns. The individual lines can be sep-
arated via insertion of control '\r' (0x0D). The separation of both
columns within one line can be carried out via insertion of control '\t'
(0x09).


============================================================
PAGE 70
============================================================

Safebag data
Action name:SafebagData(WorkingPlace, StartTime, SafebagNo, SafebagInfo, StepID,
Debit, Total, Difference, HasDifference, Notes, Coins, Cheques)
Action category: command
Safebag data.
The integrated Cash Management System sends the action as soon as the user has fin-
ished counting one variety of notes or coins and has confirmed that to the system.
Via the parameter "working place" the affected working place will be identified. The further
parameter will be provided with accompanying meta data by the Cash Management Sys-
tem.
The parameter "StepID" can be provided with a code figure by the Cash Management Sys-
tem for the currently running process step.
Parameter
Function
working
place
WorkingPlace Working place no.
start time StartTime
Time stamp, when the handling of the safe bag began.
safebag
no.
SafebagNo
Alphanumerical identification of safe bag; search criteria in GscView
safebag
info
SafebagInfo
Additional alphanumerical identification of safe bag
step id
StepID
Code figure for the currently running process step (given by cash man-
agement system individually
debit
Debit
Debit amount of safe bag
total
Total
Effective total amount of safe bag according to counting ( will be accu-
mulated by the Cash management System during counting)
difference Difference
Difference between total amount and result respectively progress of
counting
has dif-
ference
HasDifference Yes = current total amount has a difference to debit amount
No = current total amount is identical with debit amount
notes
Notes
Denomination of counted banknotes. The Display in GscView is in table
form. The table has max. 2 columns. The individual lines can be sep-
arated via insertion of control '\r' (0x0D). The separation of both
columns within one line can be carried out via insertion of control '\t'
(0x09).
coins
Coins
Denomination of counted coins. The Display in GscView is in table
form. The table has max. 2 columns. The individual lines can be sep-
arated via insertion of control '\r' (0x0D). The separation of both
columns within one line can be carried out via insertion of control '\t'
(0x09).
cheques
Cheques
Denomination of counted cheques. The Display in GscView is in table
form. The table has max. 2 columns. The individual lines can be sep-
arated via insertion of control '\r' (0x0D). The separation of both
columns within one line can be carried out via insertion of control '\t'
(0x09).
Safebag open
Action name:SafebagOpen(WorkingPlace, StartTime, SafebagNo, SafebagInfo, StepID)
Action category: notification
Safebag open.
The integrated Cash Management System sends the action as soon as the user has opened
the safe bag and confirmed that with an entry in the Cash Management System.


============================================================
PAGE 71
============================================================

The affected Working Place will be identified via the parameter "Working place". Further
parameters will be filled with accompanying meta data on the part of the Cash Management
System.
The Parameter "StepID" can be addressed by the Cash Management System with a code
figure for the currently running process step.
Parameter
Function
working
place
WorkingPlace Working place no.
start time
StartTime
Time stamp, when the handling of the safe bag began.
safebag
no.
SafebagNo
Alphanumerical identification of safe bag; search criteria in GscView
safebag
info
SafebagInfo
Additional alphanumerical identification of safe bag
step id
StepID
Code figure for the currently running process step (given by cash man-
agement system individually
Safebag passing of risk data
Action name:SafebagPassingOfRiskData(WorkingPlace, StartTime, SafebagNo, Safe-
bagInfo, StepID, UserID1, UserID2, TourNumber, TargetWorkingPlace,
PassingOfRiskType)
Action category: command
The integrated Cash Management System sends the action continuously for each safe bag
while the amount of safe bags between two employees will be transferred and this will be
confirmed to the Cash Management System. This part of the money handling process is a
"passing of risk". Via the parameter "working place" the affected transfer place and respect-
ively the working place will be identified. The further parameters will be filled with accom-
panying video data by the Cash Management System. The parameter "StepID" can be
provided with a code figure by the Cash Management System for the currently running pro-
cess step.
Parameter
Function
working
place
WorkingPlace
Working place no.
start time
StartTime
Time stamp, when the handling of the safe bag began.
safebag no. SafebagNo
Alphanumerical identification of safe bag; search criteria in
GscView
safebag
info
SafebagInfo
Additional alphanumerical identification of safe bag
step id
StepID
Code figure for the currently running process step (given by
cash management system individually
user 1
UserID1
Number of employee, transferring the safe bag to another
employee.
user 2
UserID2
Number of employee, who receives the safe bag from another
employee.
tour no
TourNumber
Tour-Number (optional)
target work-
ing place
TargetWorkingPlace Alphanumerical identification of a place respectively a working
place where safe bags will be transferred to (optional)
passing of
risk type
PassingOfRiskType
Detailed information to "passing of risk" (optional)


============================================================
PAGE 72
============================================================

Safebag passing of risk start
Action name:SafebagPassingOfRiskStart(WorkingPlace, StartTime, SafebagNo, Safe-
bagInfo, StepID, UserID1, UserID2, TourNumber, TargetWorkingPlace,
PassingOfRiskType)
Action category: command
The integrated Cash Management System sends the action as soon as a number of safe
bags will be transferred between two employees and this is confirmed to the Cash Man-
agement System. This part of the money handling process is a "passing of risk". Via the
parameter "working place" the affected transfer place and respectively the working place
will be identified. The further parameters will be filled with accompanying meta data by the
Cash Management System. The parameter "StepID" can be provided with a code figure by
the Cash Management System for the currently running process step.
Parameter
Function
working
place
WorkingPlace
Working place no.
start time
StartTime
Time stamp, when the handling of the safe bag began.
safebag no. SafebagNo
Alphanumerical identification of safe bag; search criteria in
GscView
safebag
info
SafebagInfo
Additional alphanumerical identification of safe bag
step id
StepID
Code figure for the currently running process step (given by
cash management system individually
user 1
UserID1
Number of employee, transferring the safe bag to another
employee.
user 2
UserID2
Number of employee, who receives the safe bag from another
employee.
tour no
TourNumber
Tour-Number (optional)
target work-
ing place
TargetWorkingPlace Alphanumerical identification of a place respectively a working
place where safe bags will be transferred to (optional)
passing of
risk type
PassingOfRiskType
Detailed information to "passing of risk" (optional)
Safebag passing of risk stop
Action name:SafebagPassingOfRiskStop(WorkingPlace, StartTime, StopTime, Safe-
bagNo, SafebagInfo, StepID, UserID1, UserID2, TourNumber, TargetWorkingPlace,
PassingOfRiskType)
Action category: command
The integrated Cash Management System sends the action closing after the last safe bag,
while the number of safe bags will be transferred between two employees and this is con-
firmed to the Cash Management System. This part of the money handling process is a
"passing of risk". Via the parameter "Working place" the affected transfer place respective
working place will be identified. The further parameters will be filled with accompanying
video data by the Cash Management System. The parameter "StepID" can be supplied by
Cash Management System with a code figure for a currently running process step
Parameter
Function
working
place
WorkingPlace
Working place no.
start time
StartTime
Time stamp, when the handling of the safe bag began.
safebag no. SafebagNo
Alphanumerical identification of safe bag; search criteria in


============================================================
PAGE 73
============================================================

Parameter
Function
GscView
safebag
info
SafebagInfo
Additional alphanumerical identification of safe bag
step id
StepID
Code figure for the currently running process step (given by
cash management system individually
user 1
UserID1
Number of employee, transferring the safe bag to another
employee.
user 2
UserID2
Number of employee, who receives the safe bag from another
employee.
tour no
TourNumber
Tour-Number (optional)
target work-
ing place
TargetWorkingPlace Alphanumerical identification of a place respectively a working
place where safe bags will be transferred to (optional)
passing of
risk type
PassingOfRiskType
Detailed information to "passing of risk" (optional)
Device information
All actions for low-level notification of the device or media channels changes.
Device found
Action name:DeviceFound(Type, Name, Serial)
Action category: logical
This action will be fired when the USB or NET device is connected to the system. It is also
fired at start-up for all detected devices.
Parameter
Function
device type
Type
Type of the device.
device name Name Device name if assigned in setup, empty otherwise.
serial ID
Serial Serial ID of the device.
New firmware received
Action name:DeviceNewFirmware(Type, Name, Serial, Firmware)
Action category: logical
This action will be fired when the USB or NET device has got the new firmware.
Parameter
Function
device type
Type
Type of the device.
device name
Name
Device name if assigned in setup, empty otherwise.
serial ID
Serial
Serial ID of the device.
firmware serial Firmware Serial ID of the firmware.
Device plugin error
Action name:DevicePluginError(Channel, Type, SubType, Name, Serial, ErrorClass,
ErrorCode, Description)
Action category: logical
This action notifies device plugin error.
Parameter
Function
channel
Channel
Channel.
device type
Type
Type of the device.
device sub type SubType
Sub type of the device.


============================================================
PAGE 74
============================================================

Parameter
Function
device name
Name
Device name.
serial ID
Serial
Serial ID of the device.
error class
ErrorClass
Error class of the error occured.
error code
ErrorCode
Plugin type specific error code.
description
Description Error description.
Device plugin state
Action name:DevicePluginState(Channel, Type, SubType, Name, Serial, State, Intern-
alState, Description)
Action category: logical
This action notifies device plugin state.
Parameter
Function
channel
Channel
Channel.
device type
Type
Type of the device.
device sub type SubType
Sub type of the device.
device name
Name
Device name.
serial ID
Serial
Serial ID of the device.
plugin state
State
New plugin device state.
internal state
InternalState Plugin device specific state.
description
Description
State description.
Device reattached
Action name:DeviceReattached(Type, Name, Serial)
Action category: logical
This action will be fired when the USB or NET device is reattached to the system.
Parameter
Function
device type
Type
Type of the device.
device name Name Device name if assigned in setup, empty otherwise.
serial ID
Serial Serial ID of the device.
Device removed
Action name:DeviceRemoved(Type, Name, Serial)
Action category: logical
This action will be fired when the USB or NET device is disconnected from the system. It is
also fired at the start-up for all parameterized but not present devices.
Parameter
Function
device type
Type
Type of the device.
device name Name Device name if assigned in setup, empty otherwise.
serial ID
Serial Serial ID of the device.
Digital contacts
All actions for handling digital inputs and outputs.
Digital input
Action name:DigitalInput(Contact, State)


============================================================
PAGE 75
============================================================

Action category: logical
This action will be fired when the state of the digital input has changed.
Parameter
Function
contact Contact Contact.
state
State
New state.
IOI43 reset mainboard
Action name:IOI43ResetMainboard()
Action category: logical
Reset mainboard using IOI43a/ab USB Alarm-I/O.
IOI43 temperature notification
Action name:IOI43Temperature(ID, Temperature)
Action category: logical
Temperature notification from IOI43a/ab USB Alarm-I/O.
Parameter
Function
ID
ID
ID of the IOI43 module (like IOI43-00).
temperature Temperature Temperature.
IOI43 watchdog activate
Action name:IOI43WDActivate()
Action category: logical
Activate watchdog on IOI43a/ab USB Alarm-I/O.
IOI43 watchdog deactivate
Action name:IOI43WDDeactivate()
Action category: logical
Deactivate watchdog on IOI43a/ab USB Alarm-I/O.
IOI43 watchdog trigger
Action name:IOI43WDTrigger()
Action category: logical
Trigger watchdog on IOI43a/ab USB Alarm-I/O.
Key pressed
Action name:KeyPressed(Key)
Action category: logical
This action is notified if one of the GEVISCOPE system keys is pressed.
Parameter
Function
Key
Key
System key.
Key released
Action name:KeyReleased(Key)
Action category: logical
This action is notified if one of the GEVISCOPE system keys is released.


============================================================
PAGE 76
============================================================

Parameter
Function
Key
Key
System key.
Set digital output
Action name:SetDigitalOutput(Contact, State)
Action category: logical
This action is used to modify the state of the digital output and to notify this change.
Parameter
Function
contact Contact Contact.
state
State
New state.
Set system LED
Action name:SetLED(LED, State)
Action category: logical
This action is used to turn the system LEDs on or off.
Parameter
Function
LED
LED
System LED.
state
State
New state.
Set system LED to blink
Action name:SetLEDBlink(LED, LedTimeOnMs, LedTimeOffMs)
Action category: logical
This action is used to blink the system LEDs.
Parameter
Function
LED
LED
System LED.
Led time ON
LedTimeOnMs
Time in milliseconds the LED will be switched on.
Led time OFF LedTimeOffMs Time in milliseconds the LED will be switched off.
Lenel
Lenel OnGuard actions.
Lenel access event
Action name:LenelAccessEvent(ID, Panel, Device, SecondaryDevice, CardNumber,
AccessResult, Type, SubType, Description, SerialNumber, TimeStamp, AreaEnteredID,
AreaExitedID, AssetID, CardholderEntered, Duress, ElevatorFloor, FacilityCode, IsRead-
ableCard, IssueCode, CommServerHostName, EventText)
Action category: logical
Lenel OnGuard access event.
Parameter
Function
ID
ID
The ID that uniquely identifies the type of this event.
panel
Panel
The name of the panel where this event originated.
device
Device
The name of the device where this event originated.
secondary
device
SecondaryDevice
The ID of the secondary device where this event ori-
ginated.
card number
CardNumber
The badge ID for the card that was read, if available.
access result
AccessResult
The level of access that was granted that resulted from
reading the card.


============================================================
PAGE 77
============================================================

Parameter
Function
type
Type
Event type i.e., duress, system, etc.
subtype
SubType
Event sub-type i.e., granted, door forced open, etc.
description
Description
A human readable, brief description of this event.
serial number
SerialNumber
A number that uniquely identifies the instance of the
event for a particular panel.
time stamp
TimeStamp
Time stamp.
area entered
AreaEnteredID
The ID of the area that was entered, if any.
area exited
AreaExitedID
The ID of the area that was exited, if any.
asset ID
AssetID
The ID of the asset related to this event, if any.
cardholder
entered
CardholderEntered
Whether entry was made by the cardholder.
duress
Duress
Indicates whether this card access indicates an under
duress/emergency state.
elevator floor
ElevatorFloor
The elevator floor on which the access event was gen-
erated, if any.
facility code
FacilityCode
The facility code for the card that was read, if available.
readable card
IsReadableCard
Whether the card could be read.
issue code
IssueCode
The issue code for the card that was read, if available.
server host
CommServerHostName Host name of the Communication server through which
the event arrived.
event text
EventText
Text associated with event
Lenel fire event
Action name:LenelFireEvent(ID, Panel, Device, SecondaryDevice, TroubleCode, Type,
SubType, Description, SerialNumber, TimeStamp, CommServerHostName, EventText)
Action category: logical
Lenel OnGuard fire event.
Parameter
Function
ID
ID
The ID that uniquely identifies the type of this event.
panel
Panel
The name of the panel where this event originated.
device
Device
The name of the device where this event originated.
secondary
device
SecondaryDevice
The ID of the secondary device where this event ori-
ginated.
trouble code
TroubleCode
A trouble code associated with the fire event.
type
Type
Event type i.e., duress, system, etc.
subtype
SubType
Event sub-type i.e., granted, door forced open, etc.
description
Description
A human readable, brief description of this event.
serial num-
ber
SerialNumber
A number that uniquely identifies the instance of the event
for a particular panel.
time stamp
TimeStamp
Time stamp.
server host
CommServerHostName Host name of the Communication server through which the
event arrived.
event text
EventText
Text associated with event
Lenel intercom event
Action name:LenelIntercomEvent(ID, Panel, Device, SecondaryDevice, IntercomData,
LineNumber, Type, SubType, Description, SerialNumber, TimeStamp, Com-
mServerHostName, EventText)
Action category: logical
Lenel OnGuard intercom event.


============================================================
PAGE 78
============================================================

Parameter
Function
ID
ID
The ID that uniquely identifies the type of this event.
panel
Panel
The name of the panel where this event originated.
device
Device
The name of the device where this event originated.
secondary
device
SecondaryDevice
The ID of the secondary device where this event ori-
ginated.
intercom
data
IntercomData
Additional data for the intercom event that occurred.
line number
LineNumber
The line number involved in the intercom event.
type
Type
Event type i.e., duress, system, etc.
subtype
SubType
Event sub-type i.e., granted, door forced open, etc.
description
Description
A human readable, brief description of this event.
serial num-
ber
SerialNumber
A number that uniquely identifies the instance of the event
for a particular panel.
time stamp
TimeStamp
Time stamp.
server host
CommServerHostName Host name of the Communication server through which the
event arrived.
event text
EventText
Text associated with event
Lenel raw data
Action name:LenelRawData(TimeStamp, LenelData)
Action category: logical
Lenel OnGuard raw data.
Parameter
Function
time stamp TimeStamp Time stamp.
data
LenelData
Lenel OnGuard data.
Lenel refresh names
Action name:LenelRefreshNames()
Action category: logical
Lenel OnGuard refresh names.
Lenel security event
Action name:LenelSecurityEvent(ID, Panel, Device, SecondaryDevice, Type, SubType,
Description, SerialNumber, TimeStamp, CommServerHostName, EventText)
Action category: logical
Lenel OnGuard security event.
Parameter
Function
ID
ID
The ID that uniquely identifies the type of this event.
panel
Panel
The name of the panel where this event originated.
device
Device
The name of the device where this event originated.
secondary
device
SecondaryDevice
The ID of the secondary device where this event ori-
ginated.
type
Type
Event type i.e., duress, system, etc.
subtype
SubType
Event sub-type i.e., granted, door forced open, etc.
description
Description
A human readable, brief description of this event.
serial num-
ber
SerialNumber
A number that uniquely identifies the instance of the event
for a particular panel.
time stamp
TimeStamp
Time stamp.
server host
CommServerHostName Host name of the Communication server through which the
event arrived.


============================================================
PAGE 79
============================================================

Parameter
Function
event text
EventText
Text associated with event
Lenel video event
Action name:LenelVideoEvent(ID, Panel, Device, SecondaryDevice, Channel, Type,
SubType, Description, SerialNumber, TimeStamp, StartTime, EndTime, Com-
mServerHostName, EventText)
Action category: logical
Lenel OnGuard video event.
Parameter
Function
ID
ID
The ID that uniquely identifies the type of this event.
panel
Panel
The name of the panel where this event originated.
device
Device
The name of the device where this event originated.
secondary
device
SecondaryDevice
The ID of the secondary device where this event ori-
ginated.
channel
Channel
The physical channel the camera is connected to that is
creating this event.
type
Type
Event type i.e., duress, system, etc.
subtype
SubType
Event sub-type i.e., granted, door forced open, etc.
description
Description
A human readable, brief description of this event.
serial num-
ber
SerialNumber
A number that uniquely identifies the instance of the event
for a particular panel.
time stamp
TimeStamp
Time stamp.
start stamp
StartTime
The time the video event started
end time
EndTime
The time the video event ended.
server host
CommServerHostName Host name of the Communication server through which the
event arrived.
event text
EventText
Text associated with event
Logistic
Logistic actions are used in the logistic environment where meta data, e.g. barcodes, is
used to start recording events. Later, a research on the barcodes is done to show the scan-
ning operation in the recorded images. To speed up the search, a CRC32 checksum is used
as a hash and serves as a foreign key of the event startd. The foreign key is indexed in the
event table an can therefore be found much faster than a lookup on the string itself. Addi-
tional parameters are used to notify positioning information since the assignment of scan-
ning and recording camera is often done according to the position of the scanner.
Log barcode data
Action name:LogBarcodeData(Barcode, Hash, Scanner, AreaID, AreaName, Channel,
TimeStamp)
Action category: notification
Logistic barcode data .
Parameter
Function
barcode
Barcode
Barcode.
hash value
Hash
Hash value of barcode (Optional)
scanner name Scanner
Scanner name or IP Address (Optional)
area number
AreaID
Global number of area for event mapping (Optional)


============================================================
PAGE 80
============================================================

Parameter
Function
area name
AreaName
Area name (Optional)
channel
Channel
Global number of a media channel for mapping (Optional)
time stamp
TimeStamp Time stamp (Optional)
Log barcode data LPS
Action name:LogBarcodeDataLPS(Barcode, Hash, Scanner, AreaID, AreaName, Channel,
TimeStamp, X, Y, Z, LpsTagID, LpsStatus, LpsCellID, LpsAreaID, UserParam)
Action category: notification
Logistic barcode data including positioning and area information.
Parameter
Function
barcode
Barcode
Barcode.
hash value
Hash
Hash value of the barcode (Optional)
scanner name Scanner
Scanner name or IP Address (Optional)
area number
AreaID
Global number of area for event mapping (Optional)
area name
AreaName
Area name. (Optional)
channel
Channel
Global number of a media channel for mapping (Optional)
time stamp
TimeStamp Time stamp (Optional)
X coordinate
X
X coordinate of the position query (Optional)
Y coordinate
Y
Y coordinate of the position query (Optional)
Z coordinate
Z
Z coordinate of the position query (Optional)
LPS tag ID
LpsTagID
Tag ID of the positioning system (Optional)
LPS status
LpsStatus
LPS status of the position query(Optional)
LPS cell ID
LpsCellID
Cell ID of the positioning system (Optional)
LPS area ID
LpsAreaID
Area ID of the positioning system (Optional)
User param
UserParam User param for internal use (Optional)
Log NPR recognition
Action name:LogNPRRecognition(PlateNo, Hash, Country, Channel, TimeStamp, Restric-
tion, Category)
Action category: logical
Log NPR recognition.
Parameter
Function
plate no.
PlateNo
Recognized plate no.
hash value Hash
Hash value of the recognized plate no. (Optional)
country
Country
Country (Optional)
channel
Channel
Channel (Optional)
time stamp TimeStamp Time stamp (Optional)
restriction
Restriction Restriction of recognized number (Optional)
category
Category
Category of recognized number (Optional)
LPS Actions
LPS (Local Positioning System) actions are used to query and receive position data. The
positioning system is integrated by the GscLPS plugin and is used to locate tagged objects,
e.g. mobile scanners in the logistic environment. The tags have IDs that can be used to
query the position which is then notified as cartesian or geografic coordinates. Some tags
are able to initiate a position request by an external trigger or by a scan event on a mobile
scanner.