Remote lock management

Deployment of online communication involves configuring gateways to work with the Ambiance Server. Gateways are the network devices which are paired to access points for online communication (to perform remote operations and receive access point events). When a gateway is listed in Device Management and the connectivity status is Online, access points can be paired. Multiple gateways can be connected to Ambiance, but an access point can be paired with only one gateway.

After configuration is complete, remote commands can be sent to gateways and paired access points. All command requests and results occur in real-time.

The Device Management, Monitoring, Notification Management and Reports modules all provide ways to stay informed about the devices and communication that support online communication.

Enable and configure online communication in System Settings.

To enable online communication:

  • Go to System Settings > Advanced > Enable online communication and set the soft-switch to YES.

After enabling online communication, the Online Communication category displays.

For Control 4 devices, the only relevant option is to ensure Using dormakaba Gateway I devices is selected.
  1. Go to System Settings > Online Communication
  2. Configure settings in each of the following sections:
    • Online Operations
    • Communication Settings
    • Notifications
    • Rx-Link (if using)
    • INNCOM Communication (if using)
  3. Click (Save) .

Online operations

  • Specify the number of minutes that guest keys remain valid after changes have been made to a guest registration and the keys are updated remotely. For example, if you changed the guest registration for a guest, access to the new room begins as soon as the keys are updated remotely, but access to the original room is not canceled until the number of minutes specified as the grace period is reached. Default: 5.
  • Enable remote guest check-out in common areas and elevators— Set to YES to enable remote check-out of guest common areas and elevators in Guest Registration. Default: NO. When disabled, access (to common areas/elevators) remains valid until the key expiration date/time.
  • Enabling remote guest check-out for guest common areas and elevators may significantly impact the network and online performance.

Communication settings

  • Gateway update status sent every—Specify the frequency to update gateway status. Valid values: 1-255. Default: 1.
  • Access point wake-up interval—Specify the frequency at which access points verify if the paired gateway has received remote operation requests. Default: 2.
  • Select whether to use a server name or static IP address and specify details. The value that you specify overwrites any value specified for IP Server/Server Name when configuring a gateway in Device Management.
  • Select the type of devices used in the deployment:
    • Using: Gateway I; Legacy MFC; Messenger 3rd party—Select this option is using any of the following:
      • Gateway I devices
      • Legacy MFC elevator controller
      • Messenger 3rd Party (INNCOM, Interel, Telkonet, Control4)
    • Using: Gateway II; Rx-Link—Select this option if using any of the following:
      • Gateway II devices
      • Rx-Link
      • The option Using Gateway II; Rx-Link requires using the Zigbee Generation II antenna with minimum firmware version (see the Device Requirements section in the Release Notes) and reprogramming all online access points.
    • RAC5-MFC/XT are supported in both modes.
  • Gateway II and RAC5 MFC/XT devices must be configured in Device Management.
  • Configure gateways to use dynamic IP addresses (DHCP) or static IP addresses. If using dynamic IP addresses, gateways resolve their own IP address. A DHCP server is required for this option. If using static IP addresses, each gateway must be configured with a unique IP address.
  • Select whether a gateway restarts after the Set communication settings command has been sent to the gateway in Device Management > Gateways & Paired Access Points.
  • Select whether to allow gateways to automatically generate the most appropriate ZigBee communication channels or specify a unique extended PAN (Personal Area Network) ID and select the channels for gateway and access point communication. The extended PAN ID must be eight alphanumeric characters. If the extended PAN ID is set to 0 (zero), the ZigBee network automatically generates an ID. Channels 15, 20, and 25 are recommended for minimal WiFi interference.
dormakaba recommends using the default auto-generated feature to allocate the required channels automatically.

Notifications

Set alerts for potential intruders and access point events.

Potential intruders

This section describes the alerts that you can set for potential intruders. The behavior that alerts the system about a potential intruder is the number of failed key attempts within a specified amount of time. The settings to trigger notification can be set for standing and wandering intruders. A standing intruder is when the failed key attempts occur at the same access point; for example, someone acquired several keys and presents each to the same access point. A potential wandering intruder is when the failed key attempts occur at different access points; for example, someone found a key in the parking lot and walks the hallway presenting the key to each access point.

  • Standing intruder
    •  Number of failed key attempts to trigger notification—Specify how many failed key attempts at the same access point (within the specified time lapse) trigger an intruder alert notification. Default: 5. Valid values: 3-10.
    •  Failed key attempts time lapse—Specify the number of minutes within which the number of failed key attempts (at the same access point) must occur before a notification is triggered. Default: 5. Valid values: 1-10.
  • Wandering intruder
    •  Number of failed key attempts to trigger notification—Specify how many failed key attempts at different access points (within the specified time lapse) trigger an intruder alert notification. Default: 5. Valid values: 3-10.
    • Failed key attempts time lapse—Specify the number of minutes within which the number of failed key attempts (at different access points) must occur before a notification is triggered. Default: 5. Valid values: 1-10. 

Access point notifications

Select the access point events for which to receive notification:

  • Access Point Event Notification—Lists access point door parameters which must be set to YES to enable access point status notifications.
  • Egress—Select YES to send a notification about an open door event.
  • Door Secured—Select YES to send a notification that a door is locked securely.
  • Door Ajar - Generic—Select YES to send notifications for all Door Ajar events. If NO is selected, enable or disable each Door Ajar event.
  • Door Ajar - Guest short (minutes)—Select YES to send a notification that a door has been left open by a guest for a short period of time (one minute), for example the time it would take to vacate a room. Specify the number of minutes after which the notification is sent.
  • Door Ajar - Guest long (minutes)—Select YES to send a notification that a door has been left open by a guest for a longer period of time (two minutes), indicating an usual state or potential intrusion. Specify the number of minutes after which the notification is sent.
  • Door Ajar - Staff short (minutes)—Select YES to send a notification that a door has been left open by a staff member for a short period of time (one minute), for example the time it would take to vacate a room. Specify the number of minutes after which the notification is sent.
  • Door Ajar - Staff long (minutes)—Select YES to send a notification that a door has been left open by a staff member for a longer period of time (two minutes), indicating an usual state or potential intrusion. Specify the number of minutes after which the notification is sent.
Default time intervals for access point event notifications should be based on practical best practices with security considerations.

Rx-Link

For complete Rx-Link documentation, refer to AmbianceRx-Link Deployment and Support Manual and Ambiance Rx-Link Partner Integration Specifications.

This section displays when the option Using: Gateway II; RAC5-MFC/XT; Rx-Link is selected.

Select whether to enable Rx-Link.

When you modify this setting (enable or disable) or generate a new third-party ZigBee link key, all access points must be reprogrammed.

If you enable Rx-Link, ZigBee link key information is displayed (the date/time of the most recent key and when the key was synchronized). Click Generate new key to generate a new link key.

Configure Rx-Link authentication options:

  • User— The unique ID provided by the third party for authentication to acquire a token. Valid length: 1-2,0 48 characters. Not required when using the WebSocket protocol.
  • User key—The password provided by the third party that pairs with the User. Valid length: 1-2,048 characters. Not required when using the WebSocket protocol.
  • Audience key—An API key (paired with the Secret key) that is required by a third-party to acquire an authentication token from the dormakaba server. The token eliminates the need to always submit the User/User key settings with each request. Valid value: 9b55561a54b94e2db01e15f337e902bb
  • Secret key—A unique API key (paired with the Audience key) that is required by a third party to acquire an authentication token from the dormakaba server. The token eliminates the need to always submit the User/User key settings with each request. Valid length: 1-2,048 characters. Must be 64 bytes in length.
  • Third-Party URL—Uri of the third-party bridging service to initiate Web requests made by dormakaba to the IoT controller. Represents the endpoint.
  • Third-Party token URL—Third-party Uri to request a token.
    Example: https://vriot.local-mqtt.video54.local/v1/oauth/login.
  • Third-Party refresh token URL—The third-party Uri to refresh the token. Example: https://vriot.local-mqtt.video54.local/v1/oauth/refresh.

INNCOM communication

For integrations with INNCOM, select the enable switch to YES.

If the option to secure communication is enabled, configure the following options:

  • INNCOM username/password—Specify INNCOM account credentiails so that Ambiance can connect to the INNCOM server. Value length per setting:  5-25 characters .
  • Certificate file name/password—Specify the full path to the certificate file name (for example, c:\Program Files\dormakaba\InncomCertificate\Kaba_VHE_Client_cert.pfx) and password on the INNCOM server used to secure communication between Ambiance and INNCOM. Value length: Unlimited (file name), 5-25 characters (password).
  • Certificate server name—Specify the IP address of the INNCOM server. Value length: 5-25 characters. Default: inncom.com.

You an add, configure and delete devices in the Device Management module. All device types can be configured in Device Management. RAC5 MFC/XT devices can also be programmed using the M-Unit (see Programming /Auditing > Programming.

Add online devices

  1. Go to Device Management. > Online Device Configuration.
  1. Click New Device.
  2. Specify a unique name that does not exceed 60 characters. This name displays in the list of devices.
  3. Select the device type: Gateway II, RAC5-MFC or RAC5-XT.
  4. Select the MAC address of the device that you want to configure. The MAC address of the device is automatically detected when the device is connected to the workstation.
  5. Select whether the gateway obtains an IP address automatically. If NO, specify a valid static IP address, port number, subnet mask and default network gateway IP address. (The network gateway is not the dormakaba gateway.)
  6. Select whether the gateway will contact the Ambiance Server using the IP address or server name. If using the server name, you must also specify the IP address or domain name of the local DNS Server.
The Server IP or Server Name value that you specify must refer to the same server specified in System Settings > Online Communication >Communication Settings.
  1. Specify the port number for the gateway to communicate with the Ambiance Server.
  2. Take one of the following actions:
    • When the device is attached to the workstation and the MAC address is populated, click Configure Device. The device configuration is saved to the Ambiance database. Wait 20 seconds or Power OFF/ON the gateway device. When the gateway is commissioned, disconnect the device from the USB cable and connect it to the Ethernet (POE or external power supply).
    • When the intent is to save device configuration settings only, click Save Device Configuration.

Edit device configuration

  1. Select a device.
  2. Modify options.
  3. Click Save Device Configuration.

Delete a device

  1. Select a device.
  2. Click Delete Device.
  3. Click YES to confirm.

RAC5-MFC/XT devices can be programmed using the M-Unit. Gateway II devices are configured/programmed in Device Management > Online Device Configuration. A device must be reprogrammed any time configuration data affecting the device is modified in Ambiance.

Some programming steps are performed on the M-Unit (Maintenance Unit). For official instructions, refer to the documentation distributed with your device. If M-Unit authentication is enabled in System Settings > Security > M-Unit credentials must be configured for at least one Operator in Staff Management.

To program devices:

  1. Go to Programming & Auditing > Programming .
  1. Click Next to Devices.
  1. Select the devices that you want to synchronize with Ambiance configuration data. The selected items display in the Summary section.
  2. Connect the M-Unit to the workstation.
  3. In Ambiance , click Transfer. Messages on the workstation and M-Unit display that the transfer is in progress. Wait until the message on the workstation indicates transfer is complete and that you can unplug the M-Unit.
  4. Click OK.
  5. Disconnect the M-Unit from the workstation.
  6. On the M-Unit menu, select TOOLS / Next Page / Configure RAC5. Device names display in groups of five. Use the PREV, NEXT and SEARCH options to navigate and refine the list of names. Use the UP and DOWN arrow keys to make a selection.
  7. Select the device name, then press ENTER.
  8. Select the type of cable (probe) that you are using to connect the M-Unit to the device.
  9. When prompted, connect the cable to the device. Programming starts immediately. If the device has already been programmed, the M-Unit issues a message requesting confirmation to overwrite the existing programming.
  10. When prompted that programming is complete, click OK.

To work with gateways (and paired access points) that are connected to the Ambiance Server:

  1. Go to Device Management > Registered Gateways & Paired Access Points.

Registered gateways

Gateways and their respective status' are listed by name beneath the metrics section. Color codes reflect the gateway state. Green indicates no attention is required. Yellow indicates the situation may require attention. Red indicates the gateway is offline or not working properly.

Use the Gateways toolbar to issued commands, search gateways (by name, IP and MAC address) and take the following actions:

  • To filter based on connectivity status, click (Filter) and select the status types (Online/Offline) to list.
  • To show/hide columns, click and select the information that you want to display. The following columns can be displayed:
    • All—Select this option to show all columns.
    • Type—The type of gateway.
    • MAC Address—Unique MAC address for each device.
    • IP Address—Unique Ethernet address for each device. The IP address is dynamic if a DHCP is assigned; otherwise, the IP address is static.
    • Antenna—Gateway antenna states (Disabled/Pairing On/Pairing Off).
    • Last offline—The date and time the gateway was most recently offline.
    • Last Communication—The date and time of the most recent and successful communication with the gateway.
    • FW Vers. Gateway—The current firmware version of the gateway device that runs at all times except during a firmware upgrade.
    • FW Ver AVR—The firmware version of the AVR (automatic voltage regulator) that runs at all times except during an upgrade of the AVR firmware.
    • FW Vers Ember—An electronic component on the RF board that runs at all times.
    • FW Vers Boot—The firmware version of the gateway that runs during an upgrade of the Main gateway firmware.
  • To refresh the data, click (Refresh) .

Edit gateway name

  1. Select a gateway.
  2. Click (Edit) .
  3. Modify the name.
  4. Click Save.

Delete gateway/s

You can only delete gateways that are offline.

  1. Select the gateway/s that you want to delete.
  2. Click Delete Gateway(s).
  3. Click YES to confirm.

Issue gateway commands

  1. Select one or more gateway/s.
  2. Select one of the following commands:
    • Clear gateway buffer—Deletes buffer data on all devices connected to the gateway. The buffer is automatically cleared prior to upgrading firmware. (Not supported for C4 devices.)
    • Deactivate Antenna—Disables the selected gateway/s from the network and deactivates the gateway antenna. When the command result is successful, the antenna status is Deactivated (in the Monitoring module). (Not supported for C4 devices.)
    • Get Access Point Status—Requests the connectivity status (Online/Offline) for all paired access points.
    • Get Gateway Firmware Status—Requests the gateway firmware version installed on the gateway. (Not supported for C4 devices.)
    • Get Gateway Status—Requests the gateway connectivity status (Online/Offline).
    • Pairing OFF—Disables Pairing Mode. When the command result is successful, the antenna status is Pairing Off (in the Monitoring module). (Not supported for C4 devices.)
    • Pairing ON—Enables Pairing Mode. When the command result is successful, the antenna status is Pairing On (in the Monitoring module). (Not supported for C4 devices.)
    • Important! To eliminate the risk of binding access points to the wrong gateway, dormakaba strongly recommends that only one gateway be in Pairing Mode at a time. After all access points are paired to a gateway, send the Pairing OFF command to the gateway to disable Pairing Mode. As a precaution, Pairing ON mode changes to Pairing OFF after 15 minutes.
    • Reset Gateway—Performs a soft reset on the selected gateway/s. (Not supported for C4 devices.)
    • Set Clock and Lock Event Mask—Sends the server time and the access point event notification settings (defined in System Settings > Online Communication > Notifications).
    • Set Communications Settings—Sends the communication configuration settings (defined in System Settings > Online Communication > Online Communication Settings > Gateway update status, Access point wake-up, Gateway update status).
    • Unpair all Access Points—Unpairs all access points. (Not supported for C4 devices.)
    • Upgrade firmware—Update the system-level software installed in the gateway. Prior to the upgrade, you must obtain the required file from dormakaba Support. This command applies to Gateway II devices only. (Not supported for C4 devices.)
    • Verify Assignment—Requests connectivity status from paired access points.
  4. Click Send Command.
  5. When notified the command is sent, click OK.

Pair Access Points

Before you can pair access points, you must make an RF Pairing Key in System Keys.

Make RF pairing key

  1. Go to System Keys.
  2. Click Special Function Keys.
  3. Select RF Pairing Key.
  4. Click Make Keys.
  5. Select an encoder that is online, present a key to the encoder, then click Start.
  6. When prompted that the key was made successfully, click Done.

Pair access points

For Control 4 devices, skip directly to step 6.
  1. Go to Device Management > Registered Gateways & Paired Access Point.
  2. Select the gateway where you want to pair access points.
  3. Select the command Pairing ON (to activate the gateway antenna and put the gateway in Pairing Mode).
  4. Click Send Command.
  5. When notified the command is sent, click OK.
  6. Present the RF Pairing Key to every access point that you want to pair to the gateway.
  7. To eliminate the risk of binding access points to the wrong gateway, dormakaba strongly recommends that only one gateway be in Pairing Mode at a time. After all access points are paired to a gateway, send the Pairing OFF command to the gateway to disable Pairing Mode. As a precaution, Pairing ON is automatically changed to Pairing OFF after 15 minutes.
  1. In Ambiance, select the gateway that is in Pairing On mode.
  2. Select the command Pairing OFF (to deactivate the antenna and disable Pairing Mode).
  3. Click Send Command.
  4. When notified the command is sent, click OK.

Paired acces points

To view the access points that are paired to a gateway:

  1. Go to Device Management > Registered Gateways & Paired Access Points.
  2. Select the gateway where the access point/s are paired.
  3. Click Next to access points.

The access points that are paired with the selected gateway and their respective status' are listed by name.

For RAC5 XT devices, you must trigger an event before the access point displays in the list. The simplest way to trigger an event is to present any key (valid or invalid) to the lock.

Use the Access Points toolbar to issue commands, search access points (by name) and take the following actions:

  • Issue one of the following commands:
    • Get Access Point Firmware Status—Requests the current lock firmware version. (Not supported for Control 4 devices.)
    • Get Access Point Status—Gateway requests a full update to access point status.
    • Set UTC Offset and Lock Event Mask—Sends the server time and the access point event notification settings (defined in System Settings > Online Communication > Notifications).
    • Unpair Access Point—Unbind the access point from the gateway. This command is useful during gateway maintenance, when you need to pair an access point to a different gateway. (Not supported for Control 4 devices.)
    • If you want to associate an existing access point with a new room, you need to unpair and delete (or just delete) the existing access point on the Online Access Points page. Then, the “new” access point must be reprogrammed and paired to the gateway.
    • Upgrade firmware—Request firmware upgrade. (Not supported for Control 4 devices.)
    • Verify Assignment—Requests the gateway where access points are paired and the connectivity status.
  • To filter based on connectivity status, click (Filter) and select the connectivity status (Online/Offline) as well as the monitored states (Low Battery/Door Open/Door Ajar/PrivacyEnabled/Unlatched) to list.
  • To show/hide columns, click and select the information that you want to display. The following columns can be displayed:
    • All—Select this option to show all columns.
    • Lock profile—The lock model installed at the access point.
    • Gateway—The gateway to which the access point is paired.
    • Building—The building where the access point is located.
    • Floor—The building level where the access point is located.
    • Low Battery—Indicates whether the lock battery is low (TRUE=YES/FALSE=NO). You can filter the list to show access points with a low battery.
    • RF signal—Indicates whether the signal between the gateway and paired access point is weak or normal.
    • Last offline—The date and time the gateway was most recently offline.
    • Last communication—The date and time of the most recent and successful communication with the gateway.
    • Door Open—Indicates whether the door is open. You can filter the list to show access points with an open door.
    • Door Ajar—Indicates whether the door has been open beyond a predefined threshold. You can filter the list to show access points with a door ajar.
    • Door Ajar by—Indicates the key type that was presented to open the door that is now in Door Ajar status.
    • Door Ajar Since—Indicates the date and time the door became considered ajar (not open).
    • Privacy Enabled—Indicates whether the deadbolt or privacy switch is engaged at the access point. You can filter the list to show access points with privacy enabled.
    • Unlatched—Indicates if the access point is currently in Unlatched Mode (allowing unlimited access without a key). You can filter the list to show access points that are unlatched.
    • Last Entry—The date and time of the most recent entry to the access point.
    • Date/Time Error—Indicates whether the date and time require synchronizing.
    • FW Vers. Lock (Main)—The current firmware version of the lock that runs at all times except during a firmware upgrade.
    • FW Vers. Lock (Boot)—The current firmware version of the lock that runs during a firmware upgrade.
    • FW Vers. AVR (Main)—The firmware version of the AVR (automatic voltage regulator) that runs at all times except during an upgrade of the AVR firmware.
    • FW Vers. AVR (Boot)—The firmware version of the AVR (automatic voltage regulator) that runs during an upgrade of the AVR firmware.
    • FW Vers. Ember—An electronic component on the RF board that runs at all times.
    • FW Vers. Quantum—ZigBee RF board firmware version.
  • To refresh the data, click (Refresh) .

The Monitoring module provides information about all keys made in Ambiance. If you need to know the most recent time that a specific key was used and by whom, the data is readily available without generating a report.When online communication is enabled, the Monitoring module is where you can stay informed about online communication. The Metrics section provides a real-time snapshot of the gateways and access points on site. For example, you can see at a glance whether any locks have a low battery, if any doors are open, and how many access points have the deadbolt or privacy switch enabled. Beneath the metrics summary, detailed listings show remote lock operations and events and the status of all access points paired with gateways. Access to data in the Monitoring module is configured in Role Management. By default, the Administrator and Site Configurator roles have full access.

Online metrics

To view metrics:

In Monitoring:

  • Metrics display by default.

In Device Management:

  • Go to Device Management > Registered Gateways & Paired Access Points.

The Metrics section is expanded for view by default. Color codes reflect the state of the data. Green indicates no attention is required. Yellow indicates the situation may require attention.

  • ONLINE GATEWAYS—Percentage and total number of gateways currently online.
  • ONLINE ACCESS POINTS—Percentage and total number of access points currently online.
  • LOW BATTERY—Percentage and number of access points with a low battery. Zero percent indicates no access points signal a low battery.
  • WEAK RF SIGNAL—Indicates whether the signal between the gateway and paired access point is weak or normal.
  • AJAR DOORS—Percentage and number of access points with an open door.
  • PRIVACY ENABLED—Percentage and number of access points with the deadbolt or privacy switch engaged.
  • DOORS UNLATCHED—Percentage and number of access points with doors that are closed yet there is unlimited access without a key. Zero percent indicates no doors are unlatched, which means a key is required for entry.

At any time, you can expand or collapse the section.

Color codes reflect the state of the data. Green indicates no attention is required. Yellow indicates the situation may require attention.

Online operations

To monitor online operations:

  • Go to Monitoring. Operations are displayed beneath the Metrics section.
Collapse the Metrics section to show only the list of operations.

The following information is reported for each operation:

  • Date/Time—The date and time when the operation occurred. You can filter the list based on date and time.
  • Operation Type—Command sent to gateways and access points (for example, Pairing Off/On/Set Clock/Lock Event Mask). You can filter the list based on operation type.
  • Operator—The full name and user name of the Operator who was logged in when the operation occurred. You can search for commands that were sent when a specific Operator was logged in.
  • Status—Command result (for example, Failed/Successful/Pending/Partially Successful). If the status is Failed, a reason is provided. You can filter the list based on status.
  • Details—More information about the operation.

Customize the display

  • To filter data, click (Filter) in the column heading row, select the information that you want to display, then click Filter. The (Filter Applied) icon indicates that a filter is applied to the column.
  • To clear filters for a column, click (Filter Applied) > Clear.
  • To clear all filters, click (Remove Filters) .
  • Click any column to sort the list.
  • To refresh data, click (Refresh) .

View transaction details

  • Select an operation and click (More) .

In addition to the information in the Operations list, the following transaction details are displayed:

  • Initiated—The date and time the command was issued.
  • Last Update—The date and time the status was updated (either a response or timeout).
  • Transaction—The type of transaction (for example, Key update/ADD KEY/BLOCK KEY/PAIRING ON/PAIRING OFF).
  • Gateway—The gateway name and MAC address.
  • Access Point—If the transaction involves an access point, the access point name; otherwise, the field is blank.
  • Status—Command result (for example, Failed/Successful/Pending/Partially Successful). If the status is Failed, a reason is provided.

Customize the Display

  • Click any column to sort the list. When done, click Close.

Online events

Events related to gateways and paired access points are listed. The list includes events for all key types (guest/staff/system keys) and changes to gateway/access point status.

To monitor events:

  1. Go to Monitoring.
  2. Beneath the Metrics section, click the Events tab.

The following information is reported for each event:

  • Server Date/Time—Date and time when access point events are received by the server. You can sort and filter the list based on date and time.
  • Access Point Date/Time—Date and time when the event occurred in the access point. You can filter the list based on date and time.
  • Access Point—The name of the access point. You can search for events that occurred for a specific access point.
  • Building—The building where the access point is located. This column only displays when multiple buildings are defined.
  • Floor—The building floor on which the access point is located.
  • Event Type—The type of event or type of key used (for example, Door Ajar or System Key Used). You can filter the list based on event type.
  • Key Holder—The name of the key holder. Defaults: Guest 1 (for guests) and Unassigned (for staff or system keys). You can search for events based on the key holder name.
  • Possible Key Holder(s)—The name of one possible key holder. Defaults: Guest 1 (for guests) and Unassigned (for staff or system keys). You can search for events based on the key holder name. In cases where a key ID is reused, the key holder may be one of multiple.
  • Details—More information about the event (for example, Door Ajar / Short ajar - Guest). For all key types, details include the type of key, the credential class and the credential. For and keys, details include whether access was allowed or denied.

Customize the display

  • To filter data, (Filter) in the column heading row, select the information that you want to display, then click Filter. The (Filter Applied) icon indicates that a filter is applied to the column.
  • To clear filters for a column, click (Filter Applied) then Clear.
  • To clear all filters, click (Remove Filters).
  • Click any column to sort the list.
  • To refresh data, click (Refresh) .

Events

The following events are reported:

  • Access point offline—Occurs when there is no communication between the lock and the gateway.
  • Access point online—Occurs when the lock is in communication with the gateway and online.
  • Door ajar clear (door secure)—Occurs when a door previously ajar is closed and secure.
  • Door ajar generic—Occurs when a door is in an open state.
  • Door ajar guest long—Occurs when a door ajar extends beyond the configured threshold. The door ajar (long) event occurs when a door has been left open for a longer time interval (two minutes), indicating an unusual state, a potential intrusion.
  • Door ajar guest short—Occurs when a door has been left open for a short time interval (one minute), for example the time it would take to vacate a room.
  • Door ajar staff long—Occurs when a door ajar extends beyond the configured threshold. The door ajar (long) event occurs when a door has been left open for a longer time interval (two minutes), indicating an unusual state, a potential intrusion.
  • Door ajar staff short—Occurs when a door has been left open for a short time interval (one minute), for example the time it would take to vacate a room.
  • Door latched—Occurs when a door is closed with the lock engaged.
  • Door open—Occurs when the lock's anti-pick mechanism is out. This is the default state of the door.
  • Door unlatched—Occurs when the lock motor has been disengaged and the door can be opened without a key.
  • Fire alarm activated—RAC5 MFC/XT event only. Occurs when the fire alarm for the access point is activated.
  • Fire alarm deactivated—RAC5 MFC/XT event only. Occurs when the fire alarm for the access point is deactivated.
  • Gateway Error Code Updated—Occurs when an error code for a gateway is issued. The update my indicate that the gateway is in a good state (error code=0) or that an error has occurred.
  • Gateway offline—Occurs when a gateway moves into the Offline state. The gateway is not communicating with the Ambiance server.
  • Gateway online—Occurs when a gateway moves into the Online state. The gateway is communicating with the Ambiance server.
  • Generic egress—Occurs when a door opens.
  • Guest key used—Occurs when a guest key is presented to an access point. Details include the date/time that the guest key was presented to the lock.
  • Guest key used (first entry)—Occurs when a guest has accessed the lock for the first time.
  • Low battery—Occurs when the battery moves into the Low battery state. The battery requires replacement. Ambiance sends a single low battery event/notification until batteries are changed. After batteries are changed, Ambiance sends a Low battery clear (battery normal) event/notification.
  • Low battery clear (battery normal)—Occurs when the Low battery state is cleared. The battery was replaced or the problem was resolved.
  • Mechanical key override—Occurs when a lock is accessed with a mechanical key (a lock override).
  • Operation failed—Occurs when an operation is unsuccessful. When available, the reason is indicated.
  • Privacy disabled/deadbolt retracted—Occurs when the privacy switch or deadbolt moves into the disengaged state.
  • Privacy enabled/deadbolt engaged—Occurs when the privacy switch or deadbolt moves into the engaged state.
  • Remote unlock close—RAC5 MFC/XT event only. Occurs when the elevator door/lock that was unlatched remotely is latched.
  • Remote unlock open—RAC5 MFC/XT event only. Occurs when the elevator door/lock is unlatched remotely.
  • Request to exit close—RAC5 MFC/XT event only. Occurs when a request to remotely unlatch the elevator door/lock is completed.
  • Request to exit open—RAC5 MFC/XT event only. Occurs when a request to remotely unlatch the elevator door/lock is issued.
  • Staff key used—Occurs when a Staff key accesses a lock.
  • Standing intruder—Alert: Possible standing intruder. Multiple keys presented at a single access point.
  • System key used—Occurs when a System key is presented to a lock.
  • VIP Access—Occurs when a VIP key is presented to a lock. Details may include: VIP access granted, VIP access denied, Access denied (unknown VIP key), or VIP token not in lock.
  • VIP First Access—Occurs when a VIP key is first presented to a lock.
  • Wandering intruder—Alert: Possible wandering intruder. Key presented at multiple access points.

Paired access point status

To view the status about paired access points:

  1. Go to Monitoring.
  2. Beneath the Metrics section, click the Access Point Status tab.

The following information is reported for each access point:

  • Access Point—Access point name. You can search the list for a specific access point.
  • Status—The status icon indicates the access point connectivity status (green=Online/red=Offline). You can filter the list based on connectivity status.
  • Building—The building where the access point is located.
  • Floor—The building floor where the access point is located.
  • Low Battery—Indicates whether the lock battery is low (TRUE=YES/FALSE=NO). You can filter the list to show access points with a low battery. Ambiance sends a single low battery event/notification until batteries are changed. After batteries are changed, Ambiance sends a Low battery clear (battery normal) event/notification.
  • RF Signal—Indicates whether the signal between the gateway and paired access point is weak or normal.
  • Door Open—Indicates whether the door is open. You can filter the list to show access points with an open door.
  • Door Ajar—Indicates whether the door has been open beyond a predefined threshold. You can filter the list to show access points with a door ajar.
  • Door Ajar by—Displays when Door Ajar event occurs. Indicates the key type that was presented to open the door that is now in Door Ajar status.
  • Door Ajar Since—Displays when Door Ajar event occurs. Indicates the date and time the door became considered ajar (not open).
  • Privacy Enabled—Indicates whether the deadbolt or privacy switch is engaged at the access point. You can filter the list to show access points with privacy enabled.
  • Unlatched—Indicates if the access point is currently in Unlatched Mode (allowing unlimited access without a key). You can filter the list to show access points that are unlatched.
  • Last Entry—The date and time of the most recent entry to the access point.
  • Last Update—The current lock firmware version.

Customize the display

  • To filter data, click (Filter) and select the information that you want to display.
  • Click any column to sort the list.
  • To refresh data, click (Refresh).

Notifications, conveniently accessible from the main Ambiance toolbar, keep staff members informed about online operations and events as well as the status of online access points. For example, a notification lets you know when a guest key is used or a door is ajar. The Notification Management module is where different types of notifications can be grouped and subsequently selected for subscription in staff profiles in Staff Management.

The following notifications are available:

  • Access point offline—Notifies that there is no communication between the lock and the gateway.
  • Access point online—Notifies that the lock is in communication with the gateway and online.
  • Door ajar clear (door secure)—Door previously ajar has now been closed and is secure.
  • Door ajar generic—Notifies that a door is in an open state.
  • Door ajar guest long—Door ajar beyond the configured threshold. The door ajar (long) event notifies a door has been left open for a longer time interval (two minutes), indicating an unusual state, a potential intrusion.
  • Door ajar guest short—Notifies that a door ajar (short) event signaling a door has been left open for a short time interval (one minute), for example the time it would take to vacate a room.
  • Door ajar staff long—Door ajar beyond the configured threshold. The door ajar (long) event notifies a door has been left open for a longer time interval (two minutes), indicating an unusual state, a potential intrusion.
  • Door ajar staff short—Notifies that a door ajar (short) event signaling a door has been left open for a short time interval (one minute), for example the time it would take to vacate a room.
  • Door latched—Notifies that a door is closed with the lock engaged.
  • Door open—Notifies when the lock's anti-pick mechanism is out. This is the default state of the door.
  • Door unlatched—Notifies that the lock motor has been disengaged and the door can be opened without a key.
  • Fire alarm activated—RAC5 MFC/XT notification only. An event that notifies when the fire alarm for the access point is activated.
  • Fire alarm deactivated—RAC5 MFC/XT notification only. An event that notifies when the fire alarm for the access point is deactivated.
  • Gateway error code updated—Notifies that an error code was issued for a gateway. The update my indicate that the gateway is in a good state (error code=0) or that an error has occurred.
  • Gateway offline—Notifies that a gateway is currently not communicating with the Ambiance Server.
  • Gateway online—Notifies that a gateway is communicating with the Ambiance Server.
  • Generic egress—Notifies that a door open event occurred.
  • Guest key used—Notifies that a guest key was presented to a lock. Details include the date/time that the key was presented.
  • Guest key used (first entry)—Notifies a guest key was presented to a lock for the first time.
  • Low battery—Notifies that the battery state is low and requires replacement. Ambiance sends a single low battery event/notification until batteries are changed. After batteries are changed, Ambiance sends a Low battery clear (battery normal) event/notification.
  • Low battery clear (battery normal)—Notifies that the low battery status is cleared. The battery was replaced or the problem resolved.
  • Mechanical key override—Notifies a lock override, accessing a lock with a mechanical key.
  • Operation failed—Notifies the specified operation was unsuccessful. When available, the reason is indicated.
  • Privacy disabled/deadbolt retracted—Notifies the status of the deadbolt as disengaged.
  • Privacy enabled/deadbolt engaged—Notifies that the deadbolt or privacy switch is engaged.
  • Remote unlock close—RAC5 MFC/XT notification only. The elevator door/lock that was unlatched remotely is now latched.
  • Remote unlock open—RAC5 MFC/XT notification only. The elevator door/lock was unlatched remotely.
  • Request to exit close—RAC5 MFC/XT notification only. A request to remotely unlatch the elevator door/lock was closed.
  • Request to exit open—RAC5 MFC/XT notification only. A request to remotely unlatch the elevator door/lock is active.
  • Staff key used—Notifies that a Staff key accessed a lock.
  • Standing intruder—Alert: Possible standing intruder. Multiple keys presented at a single access point.
  • System key used—Notifies that a System key was presented to a lock.
  • VIP access—Notifies that a VIP guest key was presented to a lock. Details include the date/time that the key was presented.
  • VIP first access—Notifies a VIP guest key was presented to a lock for the first time.
  • VIP operation failed—Notifies the specified operation was unsuccessful. When available, the reason is indicated.
  • Wandering intruder—Alert: Possible wandering intruder. Key presented at multiple access points.

Add notification groups

  1. Go to Notification Management.
  1. Click New Notification Group.
  2. Specify a descriptive name for the group.
  3. Select from available notification methods. If you do not select a method, only Operators who have the rights to view notifications will see notifications upon logging in to Ambiance.
    • Email—Send notifications by email. Recommended value: YES. Requires email configuration in System Settings > Email and an email address defined in staff profiles in Staff Management.
    • Web Service—Send notifications through the Web Service using either the SOAP or REST protocol. You must also specify the Web Service URL.
  4. Select the events that you want to include in the notification group. You can select from the General and Online lists. To include all notifications, select the check box adjacent to Notifications.
  5. Click Next to Access Points.
  1. Select the access points for which you want to receive notifications.
  2. Click Save.

Subscriptions to one or more notification groups can be selected in staff profiles in Staff Management.

The following Ambiance reports support online communication:

  • Online Access Point Status Report
  • Online Gateway Status Report
  • Online Paired Access Point Status

To generate a report:

  1. Go to Reports.
  2. Select the report that you want to generate.
  3. Select available options.
    • Connectivity status (online/offline)
    • Status options: All/Low Battery/Door Open/Door Ajar/Privacy Enabled/Unlatched.
    • Firmware versions
  4. Click Generate.