Enabling live synchronization of entities - 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

For entities to be synchronized in real time between OnGuard and Security Center, you must enable live synchronization.

What you should know

  • When a panel or device is deleted in the OnGuard system, the changes are not automatically reflected in Security Center. To see the changes in Security Center, you must perform a manual synchronization.
  • Disabling these options does not remove any of the entities that were previously added. Entities added by the plugin (except cardholders) can only be removed through the synchronization or on removal of the plugin role.
  • To synchronize logged events, you must perform a manual synchronization.

Procedure

  1. From the homepage in Config Tool, open the Plugins task.
  2. In the Plugins task, select the OnGuard plugin from the entity browser, and click the Synchronization tab.
  3. In the Synchronization options section, move the Live updates slider to ON.
    The Synchronization Options area of the Synchronization window with Live Updates turned on.
  4. (Optional) To trigger a synchronization following a loss of connection between the OnGuard system in Security Center, in the Parameters section, move the Automatically synchronize when connection is restored slider to ON.
    When this option is turned on:
    • A full synchronization is done using the settings in the Entities to synchronize section when the plugin role first starts up and connects to the proxy.
    • The Disconnection threshold option determines whether or not a full synchronization is triggered when the connection to the proxy is interrupted and restored. If the reconnection happens within the configured time-frame, it does not trigger a full synchronization. The default is 15 seconds.
  5. In the Entities to synchronize section, select which types of entities that you want to synchronize in real time.
    NOTE: Cardholder groups and partitions are not supported by the plugin.
  6. Click Apply.
  7. In the Synchronized entities section, click the refresh button () to view the number of entities from OnGuard that have been synchronized with Security Center.
  8. Click the Proxy settings tab.
  9. In the Advanced settings section, configure the following:
    Hardware refresh interval (in minutes)
    The interval determines the frequency at which Security Center synchronizes with the OnGuard system to obtain the status of properties on OnGuard panels and devices. This interval takes effect immediately after you enter a number in the field and click Apply. The minimum interval is 1 minute, however, given the impact that a refresh has on OpenAccess, the recommended minimum is 30 minutes. There is no maximum interval. If you enter 0 or -1, the interval is deactivated.

Results

The number of synchronized entities are displayed in the Synchronized entities section of the Synchronization screen.