Avigilon Unity Access

The Avigilon Unity Access integrated system provides access control integration.

Setup

See the Data Servers page for information on configuring driver communication.

Compatibility

The Avigilon Unity Access integrated system is compatible with Avigilon Unity Access software version 7.12.0.9.

Prerequisites

Software Minimum Version
IPFusion — Avigilon Unity Access 1.0
.NET Framework 4.7.2

When completing your setup, be sure to have the Avigilon Unity Access documentation available for reference.

Ports

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

Purpose Default Value Configurable
Dataserver 9715 Yes
Debug Tools 9716 No
Collaboration Port 8965 Yes

Additional Prerequisites

  • Licensing: The software must be licensed and include REST Support.

  • Collaboration: A Collaboration must be configured to receive events.

  • Identity: An Identity with the correct credentials must be created for login and assigned the necessary permissions.

Required Events in the Collaboration Minimum Delegation Members for the Identity (Runtime)
System Doors Card and PIN
Door Held Open Doors Card Only
Forced Door Doors Card or PIN
Invalid Credential Doors Disable
Valid Credential Doors Grant
Doors PIN Only
Doors Restore
Doors Show Status
Doors Unlock

Identities Photo List Rest (for images in Access Event Viewer)
REST Appliance Status Display
REST Get Doors
REST Get Hardware Status

Communication Configuration

In the integrated system configuration panel, you will find the Communication Settings. The below information is required:

Connection Settings

Network Address The IP address where the server is located.
Network Port The port used to communicate with the server.
Collaboration Port The port that is used to send Events to the external system defined in a Collaboration.
Note: A Collaboration must be set up and point at the data server hosting the driver service.

To set up a Collaboration:

  1. Log in to the server.
  2. Navigate to Setup & Settings > Collaborations.
  3. Select + Add Collaboration.
  4. Complete the required fields:

    • Type: Events – Generic XML

    • Installed: Checked

    • Host and Port Number: Target the machine hosting the IPFusion – Avigilon Unity Access Service

    • Require TCP: Checked

  5. Select Save.
  6. Select Events and complete the remaining fields:

    • Schedule: 24 Hours Active

    • Members: Refer to the chart in the Prerequisites section

  7. Select Save.

Identity

Username The Username of the user within the Avigilon system to log in as.
Password The Password of the user to log in as.
To assign credentials used to login to the API, you must create a Username and Password for an identity:
  1. Log in to the server.
  2. Navigate to Identities > Identities.
  3. Select the desired Identity. (This is the identity you will use to log in from IPFusion.)
  4. Scroll down to Login Details.
  5. Fill out the following:
    • Username
    • Password
    • Confirm Password
  6. Select Save changes.

Assets

System Asset

The System asset is a representation of the connection state of the Avigilon Unity Access system.

View all properties

Supported States

Normal The asset is online and in its default state.
Masked The asset has been masked over its true state.
Fault An issue has been detected in a connected asset.
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.

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.
New Note Adding the New Note Command to your Command Table subscribes this asset to Notes, allowing an operator to attach Notes to this asset in Runtime.
Workflow Trigger Allows users to trigger Workflows to create custom commands.

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

Door Asset

The Door asset is a representation of a door in the Avigilon Unity Access system.

Required Property Grid Fields

Address The number that identifies which door is assigned in the Unity Access system.

View all properties

Supported States

Acknowledged An asset alarm has been acknowledged.
Fault An issue has been detected in a connected asset.
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.
Held Open The door is unlocked and being held open for an extended period of time.
Forced Open The door has been forcibly opened.
Closed The door is closed.
Open The door is open.
Door Mode These states indicate the current behavior of the door:
  • Disabled — The door stops operating and does not allow any access.
  • Unlocked — The door is unlocked.
  • Locked No Access — The door is locked and prevents all access.
  • Facility Code Only — The door only grants access with a valid facility code.
  • Card Only — The door only grants access with a valid card.
  • PIN Only — The door only grants access with a valid PIN.
  • Card and PIN — The door only grants access when both a valid card and PIN are provided.
  • Card or PIN — The door grants access when either a valid card or a valid PIN is provided.

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

Supported Commands
Acknowledge Acknowledge an asset alarm.
Cancel Deselects all selected assets.
Grant Momentarily grants access to the door to permit a single-time entry.
Mask Mask the asset's true state.
New Note Adding the New Note Command to your Command Table subscribes this asset to Notes, allowing an operator to attach Notes to this asset in Runtime.
Reset Resets the asset to its true hardware state.
Restore Restores the Door Mode to its default configuration.
Set Door Mode Sets the mode of the door. Available options include:
  • Disabled — The door stops operating and does not allow any access.
  • Unlocked — The door is unlocked.
  • Locked No Access — The door is locked and prevents all access.
  • Facility Code Only — The door only grants access with a valid facility code.
  • Card Only — The door only grants access with a valid card.
  • PIN Only — The door only grants access with a valid PIN.
  • Card and PIN — The door only grants access when both a valid card and PIN are provided.
  • Card or PIN — The door grants access when either a valid card or a valid PIN is provided.
Workflow Trigger Allows users to trigger Workflows to create custom commands.

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

Workflow Integration

Asset Events

Assets events are events used to trigger Workflow actions on an asset level. For more information about Workflows, see the Workflows section.

Last Access Event

The Last Access Event contains the details regarding the last access to a door. This can be accessed by adding an Access Denied/Granted trigger to a Workflow. Save the project and select the Last Access Event as the triggering item.

Table 1. Properties
Item ID The unique identifier of the item.
Item Type The type of item.
Access Granted Whether access was granted (True) or not (False).
Date/Time The Date and Time of access event.
Name The name of the owner of the card.
User Name The Username of the user that last accessed this asset.

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.