Reports

Ambiance reports provide current and historical data so that you can track, investigate and maintain records for every aspect of your site. Whether you need quick access to a list of keys assigned to a staff member or an overview of all access points on your property, the report data is available.

What do you want to do?

Generate reports

  • Select Access Point Audit Report to view descriptive and event details about a lock.
  • Select Credential/Access Point Assignment Report to view the access points associated with a credential.
  • Select Elevator Configuration Report to view configuration information for an elevator bank. The report shows relay-to-floor mapping for each panel in the bank and lists elevator details.
  • Select Online-Gateway Status Report to display gateway connectivity status.
  • Select Key Expiration Report to identify keys that are approaching expiration.
  • Select Key/User Assignment Report to identify the keys assigned to staff. The report includes a list of all access points encoded on each assigned key.
  • Select Online-Access Point Status Report to display lock connectivity status.
  • Select Online-Paired Access Point Report to display gateway and lock pairing status.
  • Select Operator Report to view a list of operators, their assigned roles, and the rights associated with each role.
  • Select Property Configuration Report to view the access point configuration for your site.
  • Select Roles & Rights Report to view a list of roles defined in the Role Management page and the Ambiance functions to which each role has rights.
  • Select Staff Access Report to view the staff key access point events for staff.
  • Select System Activity Report to view the transaction history for selected operators.

Related tasks

  • From the Home page, click a module tile. You may need to scroll forward in the bottom section to display the tile for a module.
  • From all other pages, select a module from the module selection list in the Ambiance toolbar.

Ambiance modules are accessible no matter where you are in the product. When you first log in, the Home page uses tiles to provide access to modules. The top section is designed to show favorites (the modules that you use most often). The tiles for all other modules are in the bottom section. You may need to scroll forward to display the tile for a module. You can drag and drop tiles from the bottom section to the favorites area to customize your Home page.

From within any module, you can quickly switch to a different module by using the module selection list in the Ambiance toolbar. The first three items in the list show the favorites. All other modules are listed in alphabetic order.

The features and options that display in Ambiance modules depend on the rights associated with the role selected for the Operator.
  1. On the main toolbar, click account user name > Preferences.
  2. Specify options in the following sections:
    • GENERAL INFO
      • Username—Read-only option that displays the operator user name.
      • Password status—Read-only option that displays the expiration details for the Ambiance account password.
      • Preferred language—Select the preferred language for the account holder. The default is to detect and display the UI in the browser language. For Ambiance to detect and display the UI in the browser language, the language setting in both Systems Settings > General and Preferences must both be Automatic Language Detection.
      • Email—Specify an email address to associate with the account.
    • PASSWORD
      • New password / Confirm password—Specify a valid password. To view values, click . Default password requirements: minimum of eight characters that include at least one of the following: uppercase letters, lowercase letters, numerals and special characters.
    • SECURITY QUESTIONS—Select and provide responses to the challenge questions to present when submitting a request to retrieve or reset the password.
  3. Click Save Changes.

This toolbar option is available from the Device Management and Programming & Auditing modules. The Ambiance Client is required to add an encoder or connect to the M-Unit.

  1. Click (Install Ambiance Client) .
  2. Click Download. The download process can take up to one minute.
  3. When the download is complete, click AmbianceClient.exe. The installer opens.
If anti-virus or firewall software is installed on the workstation, you may be prompted to allow the installer to open.
  1. On the Welcome page, click Next (or Repair if the client is already installed). The Setup Status page displays while the Client is installed.
  2. On the Update Complete page, click Finish.

This toolbar option is available from any module where keys are made.

  1. In the Ambiance toolbar, click (Encoder) .
  2. Select an encoder that is online and available to the workstation.
  3. Click Done.

The Ambiance key reader enables you to learn the status of any key and is accessible from the main toolbar. For Guest Keys and Staff Keys, you can also generate aGuest Access Report and Staff Access Report, respectively, after reading the key. This report is only accessible after reading a key (it is not in the Reports module).

Access reports include a maximum of 72 and 408 events for 1k/4k keys respectively. MIFARE mini keys do not retain access tracking data. For VIP guest registrations, the limitations are 36 and 372.
  1. On the main toolbar, click (Read Keys) .
  2. Select an encoder that is online and available to the workstation.
  3. Present a key to the encoder.
  4. Click Read Key.
  • Keycard type—Indicates whether the key is for a guest or staff member.
  • Encoded by—The name of the active operator when the key was made.
  • Encoded on device—The name of the encoder used to make the key.
  • Key mode—Indicates whether the key is a New Key or Additional Key.
  • Created on—The date and time the key was encoded.
  • Check-in—The date and time access is valid.
  • Check out—The data and time access is invalid.
  • Key ID—The unique instance of the key. Other keys encoded with the same credential have different key IDs.
  • Status—The current state of the key: Pre-registered/Active/Expired/Obsolete/Returned.
  • Guest room access—The rooms accessible by the key.
  • Floor access—The floors accessible by the key.
  • Encoded for guest —The name of the guest who was issued the key.

Additional data displays for keys which are encoded with a third-party service in sector 2 (sector 8 for VIP keys).

  • Date Range—The dates and times during which the events included in the report occurred.
  • Access Events—The number of records in the report.
  • Key Holder—The name of the guest or staff member.
  • Access—The access points authorized for the key holder.
  • Check In—The date and time access is valid.
  • Check Out—The data and time access is invalid.
  • Key status—The current state of the key. For physical keys: Pre-registered/Active/Expired/Obsolete/Returned. For mobile keys: Delivering/Delivered/Failed/Canceling/Canceled/Expired/Obsolete.
  • Seq—The order in which an event occurred.
  • Event Date—The date and time the event occurred.
  • Access Point—The access point to which the key was presented.
  • Access Granted—Indicates whether access was granted when the key was presented.
  • Time Set—Indicates whether the lock clock is set properly. If No, then the reported Event Date may be wrong. The most common reason for the lock clock to not be set is replacing a depleted battery. For Online systems, a lock clock syncs with the online system when batteries are replaced. For offline systems, staff members can use an M-Unit to reset a lock clock.
  • Dead Bolted—Indicates whether the deadbolt was engaged at the time of the event.
  • Low Battery—Indicates whether the battery was low at the time of the event.
  • Lock Prob?—Indicates a problem with the lock at the time of the event.
  • Lock Latched—Indicates whether the lock was latched at the time of the event.
  • New Key—Indicates whether the key is New. If the key is not New, it is an Additional Key.
  • Date Range—The dates and times during which the events included in the report occurred.
  • Access Events—The number of records in the report.
  • Credential —The name of the credential and key mode (New or Additional).
  • Shift schedule—The name of any shift schedule assigned to the key.
  • Expiration—The date and time after which access on the key is invalid.
  • Key status—The current state of the key. For physical keys: Pre-registered/Active/Expired/Obsolete/Returned. For mobile keys: Delivering/Delivered/Failed/Canceling/Canceled/Expired/Obsolete.
  • Seq—The order in which an event occurred.
  • Event Date—The date and time the event occurred.
  • Access Point—The access point to which the key was presented.
  • Access Granted—Indicates whether access was granted when the key was presented.
  • Time Set—Indicates whether the lock clock is set properly. If No, then the reported Event Date may be wrong. The most common reason for the lock clock to not be set is replacing a depleted battery. For Online systems, a lock clock syncs with the online system when batteries are replaced. For offline systems, staff members can use an M-Unit to reset a lock clock.
  • Dead Bolted—Indicates whether the deadbolt was engaged at the time of the event.
  • Low Battery—Indicates whether the battery was low at the time of the event.
  • Lock Prob?—Indicates a problem with the lock at the time of the event.
  • Lock Latched—Indicates whether the lock was latched at the time of the event.
  • First Key Use—Indicates whether the key has been used to access a space.

When encoding or reading a key fails, an information box identifies the following problems:

  • When communication between the encoder and workstation fails.
  • When the encoder is offline.
  • When the encoder is busy.
  • When a key is not presented to the encoder within the expected delay.
  • When the key is damaged, corrupt or uses unsupported technology.

This function is not supported when Enhanced Security Mode is enabled. However, high security keys can be re-encoded at the same site using the same Ambiance database.

You can erase any key (guest/staff/system) only directly after the key is read. Erasing a key removes all configuration data encoded on the key.

To erase a key:

  1. After the key is successfully read, click Erase Key.
  2. Click YES to confirm.
  3. When done, click OK.

Keys that are erased show as "Returned" in reports and Monitoring > Keys.

Notifications keep staff members informed about operations and events related to online communication (gateways and paired access points). For example, a notification lets you know when a guest key is used or a door is ajar.

To view recent notifications:

  • On the main toolbar, click (Notifications) .
  • Recent notifications are listed showing the date, time and command result. To delete a recent notification, click (Delete) x.

To view all notifications:

  • Click (Notifications) > VIEW ALL NOTIFICATIONS.

The list of notifications includes events selected in the notification groups to which the current Operator subscribes. The following information is displayed for each notification:

  • Notification—The online event. See below for a list of all notification events.
  • Category—General or Online.
  • Date/Time—The date and time the event occurred.
  • Details—More information about the event, such as the command sent, and if applicable, the names of paired access points.

Use the Notifications toolbar to search notifications and take any of the following actions:

  • Delete notifications—Select one or more notifications, then click (Delete) .
  • Clear notifications from the Recent notifications list—Select one or more notifications, then click (Mark as Read).
  • Filter notifications by notification, category, and date/time—Click (Filter) , select From and To dates, then click Filter. To clear a column filter, click (Filter Applied) , then Clear. To clear all filters, click (Reset Filters) .
  • Refresh the data—Click (Refresh).

Descriptions for General Events

  • Some access points require reprogramming—Notifies when it is necessary to resynchronize Ambiance configuration data for the access points listed in the Details column.

Descriptions for Online Events

  • Access point offline—Notifies that there is no communication between the lock and the gateway.
  • Access point online—Notifies that the lock is online and in communication with the gateway.
  • Access Point Paired—Notifies that an access point was paired to a gateway.
  • 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, 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, for example the time it would take to vacate a room.
  • Door ajar staff long —Notifies a door ajar (long) has been left open by a staff member for a longer time interval, indicating an unusual state, a possible intrusion in progress.
  • Door ajar staff short —The door ajar (short) notifies a door has been left open by a staff member for a short time interval.
  • Door latched—Notifies that a door is closed with the lock engaged.
  • Door open—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.
  • Generic egress—Egress is an open door event.
  • Guest key used—Date and time that a key was used at the access point.
  • Guest key used (first entry)—Notifies a guest has accessed the lock for the first time.
  • Gateway offline—Gateway is currently not communicating with the Ambiance Server.
  • Gateway online—Displays all gateways that are online and visible in the Monitoring module.
  • Low battery—The battery state is low and requires replacement.
  • Low battery clear (battery normal)—The low battery notification has been 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—The specified operation was not successful. 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.
  • Access point programming required—Lock may require resequencing or synchronization with Ambiance configuration data.
  • Staff key used—Notifies that a staff key has accessed the 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 the lock.
  • Wandering intruder—Alert: Possible wandering intruder. Key presented at multiple access points.
  • To go to the Ambiance welcome page, click (Home).
  • To log out of Ambiance, click account user name > Log Out.