Synchronized entities and properties - OnGuard 5.1.1

OnGuard Plugin Guide 5.1.1

Applies to
OnGuard 5.1.1
Last updated
2023-08-02
Content type
Guides > Plugin and extension guides
Language
English
Product
OnGuard
Version
5.1

It is important to know which entities and related properties can be synchronized by the OnGuard plugin.

The following table lists entities and properties that are synchronized in Security Center and whether or not they are automatically synchronized in real time.
NOTE:
  • Cardholder groups and partitions in Security Center are not synchronized with OnGuard.
  • Cardholder and visitor entities and their related properties are synchronized in real time.
  • Custom fields in cardholder profiles are overwritten when a synchronization occurs.
  • There are many types of panels in OnGuard, the plugin only synchronizes access control unit and intrusion detection panels.
  • For each reader in OnGuard, one reader and one door entity is created in Security Center.
  • Modifications to the names of OnGuard panels or devices are automatically pushed to Security Center when a synchronization occurs.
  • The frequency that an automatic synchronization of OnGuard hardware occurs is set in Plugin role > Proxy settings > Advanced settings > Hardware refresh interval (in minutes).
IMPORTANT:
  • The default proxy setting for polling the hardware status of OnGuard devices is False, which can cause incorrect device status reports after a manual synchronization.
  • In order for entities to be updated automatically, you must enable live synchronization.
  • For entities that cannot be updated automatically, you must perform a manual synchronization.
  • After Security Center and OnGuard are initially connected, a manual synchronization is required to pull entities from OnGuard to Security Center.
  • When hardware is deleted in the OnGuard system, a manual synchronization is required in order to delete the associated entities in Security Center.
  • In order to receive cardholder updates, you must select the Generate software events option on the OnGuard system. This is found on System options form in the System Administration task.
  • In the OnGuard System Administration application, user created alarms must have the "Text instructions" setting configured to be synchronized through the OnGuard plugin integration.
OnGuard entity Security Center entity Properties that are synchronized Properties can be synchronized automatically
Lnl_Cardholder Cardholder All related properties Yes
Lnl_Visitor Visitor All related properties Yes
Lnl_Panel Access Control unit or Intrusion detection unit
  • AC and battery state
  • Tamper state
  • Running state
Yes
Lnl_Reader Reader and Door
  • Door open and door lock state based on event.
  • Running state based on event.
Yes
Lnl_ReaderInput1 Input
  • Input state
  • Running state based on event.
Yes
Lnl_ReaderInput2 Input
  • Input state
  • Running state based on event.
Yes
Lnl_ReaderOutput1 Output
  • Output state
Yes
Lnl_ReaderOutput2 Output
  • Output state
Yes
Lnl_Area Area
  • Name
  • Area type
No
Lnl_IntrusionDoor Door
  • Name
Yes
Lnl_IntrusionArea Intrusion Area
  • Name
No
Lnl_IntrusionZone Input
  • Running state based on event.
Yes
Lnl_AlarmDefinition Alarm
  • Name
  • Description
  • Priority
No
Lnl_AlarmInput Input
  • Input state
  • Running state based on event.
Yes
Lnl_AlarmOutput Output
  • Output state
  • Running state based on event.
Yes
Lnl_OnboardRelay Alarm Panel Output
  • Name
  • Output state
Yes
Lnl_OffboardRelay Alarm Panel Output
  • Name
  • Output state
Yes