How synchronization works with OnGuard - OnGuard 4.0

OnGuard Plugin Guide 4.0

Applies to
OnGuard 4.0
Last updated
2021-07-19
Content type
Guides > Plugin and extension guides
Language
English (United States)
Product line
Ecosystem (add-ons) > OnGuard
Version
4.0

Synchronization of OnGuard entities and events in Security Center is performed when the OnGuard plugin connects with the OnGuard server, or when cardholder changes are detected. You can also perform a manual synchronization from Config Tool.

The plugin performs two types of synchronization:
Full synchronization
  • Occurs when a synchronization is triggered and all of the sliders are set to On in the plugin Properties tab in Config Tool.
  • Synchronizes all entities and events from the server to Security Center.
  • Can be configured to start manually or automatically (when a connection is established) within the Config Tool.
  • Must be the first type of synchronization conducted to ensure all entities are synchronized.
  • Required for events and alarms to appear correctly and raise events.
  • Required when hardware or alarms are added or removed in OnGuard.
  • Typically takes more time because all entities are being synchronized.
Partial synchronization
  • Occurs when a synchronization is triggered and selected sliders are set to On in the plugin Properties tab in Config Tool.
There are three ways that a synchronization can be performed:
Startup synchronization
  • Performs a synchronization with the OnGuard system when a connection is established with the OnGuard server.
  • Can be configured to perform a full or partial synchronization between the plugin role and the server.
  • Can be disabled in Config Tool.
Manual synchronization
  • Can be started on demand through the plugin Properties tab in Config Tool.
  • Performs a full or partial synchronization between the plugin role and the server.
  • You can deselect classes of entities, such as cardholders or hardware, when performing a manual synchronization.
Live/Real time synchronization
  • Once a start up or manual synchronization has been completed, subsequent changes are received in real time from the server.
    NOTE: Not all entities support real time synchronization. You must perform a manual synchronization for hardware entity changes. For more information, see Synchronized entities and properties.
  • Real time synchronization is an automatic process.
  • Typically takes less time because only changes are being synchronized.
    IMPORTANT: A synchronization must be performed after hardware or alarms are added or removed in OnGuard. It is also required if an entity is not listed in as "Completed" in the Synchronize tab of the Config Tool .

If an event occurs while synchronization is in progress and the source entity has not been synchronized yet, the event may be raised for the OnGuard plugin role. These events are not reported in Security Desk.