OnGuard

The OnGuard integrated system — built on the OpenAccess platform — provides ID data management, access control, and real-time notification integration.

For more information, visit the OnGuard product website.

Definitions

REX — Request to Exit. This is used in access control systems to manage accessibility within secured areas.

DPS — Door Position Switch. Device to detect the open or closed status of a door relative to its frame.

Compatibility

The OnGuard integrated system is compatible with software versions:
  • 7.6
  • 8.0
  • 8.1

To connect with older versions of OnGuard, please contact support at ipfusionsupport@ipfusion.ca for further assistance.

Prerequisites

Software Minimum Version
IPFusion — OnGuard 3.4
.NET Framework 4.7.2
Important: For the connections you will require an OnGuard integration license with support for the OpenAccess application. Only one license is required for any number of connections. Please contact your OnGuard reseller for a quote on the annual license fee required for this plugin to connect. Use the part number IPC-011-DLCO01 when obtaining your quote.

When completing your setup, be sure to have the OnGuard documentation available for reference.

Ports

These ports must be open in your network firewall for the integration to work.

Purpose Default Value Configurable
Communication Settings 8080 Yes
Dataserver 9002 Yes
Debug Tools 9569 No

Communication Configuration

Communication Settings

Server The address of the OnGuard server. To find the IP address, follow the steps here.
Port The port for the OnGuard server connection. The default value is 8080.

The 9002 port must be open to facilitate communication between Runtime and the data server. The port configured in the above communication settings must be open to facilitate communication between the driver and OnGuard.

Authentication

For information about logging in to the OnGuard system, refer to the Logging into the OnGuard System section in the OnGuard Installation Guide.

Note: IPFusion works with segmented OnGuard systems. It is recommended the OnGuard user account used for the IPFusion connection is configured to be an <All Segments> user. IPFusion will only be able to monitor and control users and devices within the assigned segment for this user.
Username The username used to authenticate with the OnGuard server.
Password The password used to authenticate with the OnGuard server.
Directory Name The Directory used to authenticate with the OnGuard server. To get the list of all Directories, enter your server address and save. Then click Refresh to update the directory list.

Advanced

Badge Information Refresh Rate The OnGuard driver caches new and updated badge information from access events to reduce the load on the OnGuard server. This field is the time in minutes for how long the data server will store that information. This resets every time a user sends an access event. If no access events for that user are sent before the time is up, it will be removed from memory.
Note: Red X indicates an invalid or out of range value given for field.
Important: Once the IPFusion - OnGuard Service successfully connects to the OnGuard server, it performs a panel refresh cache. The refresh results in a delay of 60 seconds before getting status for Readers, Doors, Inputs and Outputs. This is observed both when making the initial connection and during data server failover scenarios.

Assets

Door

This asset represents a door based on a collection of readers, inputs, and outputs in the OnGuard system.

Required Property Grid Fields

Reader IDs The OnGuard IDs of the associated Panel/Reader pairs.

View all properties

Supported States

Acknowledged An asset alarm has been acknowledged.
No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.
Masked The asset has been masked over its true state.
Fault An issue has been detected in a connected asset.
Forced Open The secured door has been forcibly opened.
Held Open The door was unlocked, and is now being held open for a period of time.
Reader Card Only Mode Reader will only accept cards as a method to unlock door.
Reader Pin and Card Mode Reader requires both a card swipe and pin code to be entered to grant access through door.
Reader Pin or Card Mode Either a pin or a card will grant access through the door.
Reader Unlocked Mode Reader is in unlocked mode. Door can be opened.
Reader Facility Code Only Mode Reader will only accept an authentication code to open door.
Reader Locked Mode Reader is in locked mode and cannot be opened via card or keypad.
Input 1 Active The first auxiliary input for the associated reader is active.
Input 2 Active The second auxiliary input for the associated reader is active.
Input 1 Secure The first auxiliary input for the associated reader is secure.
Input 2 Secure The second auxiliary input for the associated reader is secure.
Output 1 Active The first auxiliary output for the associated reader is active.
Output 2 Active The second auxiliary output for the associated reader is active.
Output 1 Secure The first auxiliary output for the associated reader is secure.
Output 2 Secure The second auxiliary output for the associated reader is secure.
Note: The Masked and Acknowledged statuses are internal to IPFusion and do not represent states in the OnGuard system.
Important: The Door asset uses the first reader in its Reader IDs list in the Properties grid to determine its status.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands

Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.
Pass Temporarily unlocks the door.
Set Reader Mode Sets the mode of the associated readers to one of the following:
  • Reader Unlocked Mode
  • Reader Pin or Card Mode
  • Reader Pin and Card Mode
  • Reader Locked Mode
  • Reader Facility Code Only Mode
  • Reader Card Only Mode
Pulse Output 1 Activates then deactivates the first output associated with the door. The amount of time the output is active is configured on the OnGuard server. If the output is already active, this command will not deactivate it.
Pulse Output 2 Activates then deactivates the second output associated with the door. The amount of time the output is active is configured on the OnGuard server. If the output is already active, this command will not deactivate it.
Note: The Mask, Acknowledge, Reset, and Cancel commands are not sent to the OnGuard system and are only used within IPFusion.

See the Command Tables page for more information on configuring command tables.

Reader

This asset represents a reader entity in the OnGuard system.

Required Property Grid Fields

Panel ID The OnGuard ID of the associated panel.
Reader ID The OnGuard ID of the associated reader.

View all properties

Supported States

No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.
Masked The asset has been masked over its true state.
Acknowledged An asset alarm has been acknowledged.
Fault An issue has been detected in a connected asset.
Reader Card Only Mode Reader will only accept cards as a method to unlock door.
Reader Pin and Card Mode Reader requires both a card swipe and pin code to be entered to grant access through door.
Reader Pin or Card Mode Either a pin or a card will grant access through the door.
Reader Unlocked Mode Reader is in unlocked mode. Door can be opened.
Reader Facility Code Only Mode The reader will only accept an authorization code to open the door.
Reader Locked Mode Reader is in locked mode and cannot be opened via card or keypad.
Note: The Masked and Acknowledged statuses are internal to IPFusion and do not represent states in the OnGuard system.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands

Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.
Set Reader Mode Sets the reader into one of the supported modes:
  • Reader Unlocked Mode
  • Reader Pin or Card Mode
  • Reader Pin and Card Mode
  • Reader Locked Mode
  • Reader Facility Code Only Mode
  • Reader Card Only Mode
Note: The Mask, Acknowledge, Reset, and Cancel commands are not sent to the OnGuard system and are only used within IPFusion.

See the Command Tables page for more information on configuring command tables.

Output

This asset represents an output entity in the OnGuard system.

Required Property Grid Fields

Output ID The OnGuard ID of the associated output device.
Panel ID The OnGuard ID of the associated panel.
Reader ID The OnGuard ID of the associated reader.

View all properties

Supported States

No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.
Masked The asset has been masked over its true state.
Acknowledged An asset alarm has been acknowledged.
Fault An issue has been detected in a connected asset.
Active The output device has been activated.
Secure The output device is online but not activated.
Note: The Masked and Acknowledged statuses are internal to IPFusion and do not represent states in the OnGuard system.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands

Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.
Activate Set the output device to an active state.
Deactivate Set the output device to a secured state.
Pulse Activates then deactivates the output. The amount of time the output is active is configured on the OnGuard server. If the output is already active, this command will not deactivate it.
Note: The Mask, Acknowledge, Reset, and Cancel commands are not sent to the OnGuard system and are only used within IPFusion.

See the Command Tables page for more information on configuring command tables.

Input

This asset represents an input entity in the OnGuard system.

Required Property Grid Fields

Input ID The OnGuard ID of the associated input device.
Panel ID The OnGuard ID of the associated panel.
Reader ID The OnGuard ID of the associated reader.

View all properties

Supported States

No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.
Masked The asset has been masked over its true state.
Acknowledged An asset alarm has been acknowledged.
Fault An issue has been detected in a connected asset.
Active The input device has been activated.
Secure The input device is online and not activated.
Note: The Masked and Acknowledged statuses are internal to IPFusion and do not represent states in the OnGuard system.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands

Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.
Note: The Mask, Acknowledge, Reset, and Cancel commands are not sent to the OnGuard system and are only used within IPFusion.

See the Command Tables page for more information on configuring command tables.

System

This asset represents the state between Runtime and the OnGuard server.

View all properties

Supported States

No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.
Normal The asset is online and in its default state.
Masked The asset has been masked over its true state.
Acknowledged An asset alarm has been acknowledged.
Fault An issue has been detected in a connected asset.
Note: The Masked and Acknowledged statuses are internal to IPFusion and do not represent states in the OnGuard system.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands

Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.
Note: The Mask, Acknowledge, Reset, and Cancel commands are not sent to the OnGuard system and are only used within IPFusion.

See the Command Tables page for more information on configuring command tables.

Hardware Import

The Reader, Input, and Output assets can be populated automatically in Designer based on the hardware currently connected to the system. Refer to the Hardware Import section for further information.

Workflow Integration

System Events

System events are events used to trigger Workflow actions at the system level. For more information about Workflows, see the Workflows section.

System Alarm

This event occurs when one of the devices in the system has an alarm triggered for it. If the alarm requires acknowledgement, it must be acknowledged from the OnGuard server.

Note: The values for the properties listed below match the labels as displayed in the Alarm Monitoring application in the OnGuard server.
Table 1. Properties
Alarm Description A description of the active alarm type.
Time/Date The timestamp for when the alarm was triggered.
Controller The OnGuard controller for the device.
Device The device which is currently in an alarmed state.
Priority The priority of the active alarm.

Access Granted

Table 2. Properties
Username The name of the cardholder.
Badge ID The badge identifier.
Date/Time The timestamp of the event.
Access Granted Whether access was granted (True) or not (False).
In Duress Whether the last access event was made in duress (True) or not (False).
Description A description of the access event.

Access Denied

Table 3. Properties
Username The name of the cardholder.
Badge ID The badge identifier.
Date/Time The timestamp of the event.
Access Granted Whether access was granted (True) or not (False).
In Duress Whether the last access event was made in duress (True) or not (False).
Description A description of the access event.

System Commands

System commands are commands executed through Workflows at the system level. For more information about Workflows, see the Workflows section.

Set Reader Mode

Sets the reader to a desired mode.

Table 4. Parameters
OnGuard Assets The assets to set the reader mode for.
Reader Mode The supported mode to set the associated readers to. This can be:
  • Reader Unlocked Mode
  • Reader Pin or Card Mode
  • Reader Pin and Card Mode
  • Reader Locked Mode
  • Reader Facility Code Only Mode
  • Reader Card Only Mode

Troubleshooting

Logs from the driver and Runtime can be viewed in the Debug Tools client. These messages contain information which can provide further context for issues during initialization, or while actively running. This can help diagnose problems.

Forced Open/Held Open Statuses are not Coming in Runtime

If you are not receiving forced open or held open statuses for your door assets:
  1. In Designer, right-click on the OnGuard system from Project Explorer and select Configure.
  2. Navigate to the status table for your door assets.
  3. Check the below settings on your held open and forced open statuses:
    • Ensure the State drop-down has the Forced Open/Held Open state selected.
    • The priority is set to a smaller value than your other statuses.
    • If you wish for this status to appear in the Alarm Grid, check Bind to Alarm. To force users to acknowledge and reset the alarm before it is cleared from the Alarm Grid, check Latch Alarm.

Asset is not Resolving to the Correct Status

If an asset is stuck in the incorrect status (e.g., fault, held open, forced open), the OnGuard driver may have been started too quickly after changes were made on the OnGuard server. To resolve this:

  1. In Windows, open Services.
  2. Right-click the IPFusion - OnGuard service and select Stop. Note that OnGuard assets in Runtime will go into no communication while disconnected from the OnGuard server.
  3. Wait 60 seconds, ensuring that no changes are being made to devices on the OnGuard server during this time.
  4. Right-click the IPFusion - OnGuard service and select Start.

Unable to Connect to OnGuard Server

If your connection settings for the OnGuard server are correct but you are still unable to connect to the OnGuard server, your password may be expired. To see if this is the issue:
  1. On your OnGuard server, try logging in to System Administration.
  2. If your password is expired, a prompt will appear for you to update your password. In this case, you can enter in a new password. Be sure to update the OnGuard Communication Settings in Designer with the new password.
  3. If your password is not expired, it may be your license.
    1. On your OnGuard server, log in to License Administration.
    2. Select your license and click View.
    3. In the license description, check the expiry date to see if you are past it. If so, you will need to contact OnGuard support for a new license and install it on the server.
  4. If after completing the above steps your assets are still offline, restart the IPFusion - OnGuard service running on your data server.