Ambiance Release Notes

Ambiance 2.9

Welcome
Ambiance™ is a web-based state-of-the-art access management software for access control management.
Ambiance is dormakaba’s latest software entry into the access control market. Described as the next-generation
software solution to manage the hospitality access control market. Ambiance has been developed to provide users
with enhanced flexibility and system control.
The application integrates seamlessly into any hotel IT infrastructure and provides hotels with a user friendly and
efficient method of managing and controlling access and collecting both system and lock data. Ambiance is an
integrated and configurable access management system with full audit reporting, capable of managing guest
rooms, access points and common areas in a secured and controlled environment.

Security advisory
As a leader in the access control industry, dormakaba recognizes the continuously evolving nature of security
technology. We strive to make ongoing improvements in our products, and we encourage our customers to
implement enhanced authentication and encryption protocols.
To reduce the potential risk for our customers, dormakaba suggests the following actions:
n For guest credentials
Select the more secure credentials MIFARE Ultralight C which have security features that offer additional
protection against cloning.
n For staff credentials
Our recommendation is to also use Ultralight C. This will offer an additional layer of security for the access
management software presently installed at your property. Our implementation of the MIFARE Plus credential was
designed to provide compatibility with legacy solutions, specifically MIFARE Classic. As a result, for this particular
application MIFARE Plus will not provide the same level of security as Ultralight C.

See "What's changed" for important information about the change to default RFID key type settings.

What's new
Ambiance announces the following new features:

PMS
Ambiance introduces the LGS PMS REST API to securely perform the following offline PMS guest operations:
n Encode new, additional and modified RFID keys for unique or grouped reservations.
n Issue new, additional and modified mobile BLE keys for unique or grouped reservations.
n Issue new, additional and modified Apple wallet keys for unique or grouped reservations.
n Early check-out for unique and group reservations.
n Get active keys for unique reservations.

Rx-Link
n Online communication is now supported over multiple Rx-Link IoT controllers.
n Online communication is now supported for combined Rx-Link and INNCOM deployments.

Programming
n RAC5 XT and RAC5 MFC devices can now be programmed with the Maintenance Unit. Devices must first be
configured in Device Management/Online Device Configuration.

Folio
n New ANSI/ISO BCD folio format (2) is now supported and configurable in System Settings > Folio. (SD-2016)

2/3/2023 Ambiance 1
Release Notes What's changed

What's changed
Ambiance 2.9 includes the following change:

Key security
n For fresh installations, MIFARE Ultralight C is now the default system setting for RFID key type. For upgrades,
key type settings persist; however, dormakaba strongly recommends using Ultralight C. Using Ultralight C
introduces the following limitations:
n Kiosk support is scheduled for an upcoming version of Ambiance later in 2023.
n Sector II / folio support is scheduled for an upcoming version of Ambiance later in 2023.
n Staff access tracking is not available due to the limited Ultralight C card storage capacity.
n The maximum number of variable access points (access points that are added at key-making time) is six (6).

The affected access point types are: guest rooms, suite common and inner doors, foyer doors, meeting rooms,
and restricted areas.
By proceeding with the default RFID key type setting, locks will not accept MIFARE Plus or MIFARE Classic
keys. To select RFID key types, go to System Settings > Advanced Settings > RFID key types.

Corrected issues
This section lists the corrected issues. An internal reference number follows the fix description.

Infrastructure
n Overall performance is optimized to improve system resiliency for very large offline and online deployments.
(SD-1816/39777/39682/39714/39865)

Login/password change
n The values specified when changing the operator password and specifying answers to the security questions
are now saved. (SD-1767/38399)

PMS
n LGS REST API (KF2). Certificate can now be generated without PMS operator credentials. (SD-1789/39345)
n IRS/PRS. Guest keys can now be encoded for guest and suite rooms associated with foyer door access points.
(SD-1980/SD-1999/41457)
n IRS. Requests with the optional common area/pass number 0 is now supported. (SD-1942/40903)
n VIP guest registrations now support shared-with access. (SD-1972/41339)
n Web Service BART. The proper encoding status error is now returned in the KabaRequestEncoderStatus
response when no key is presented to the encoder. (SD-2008/41891)

System Settings
n Database Backup & Archiving. SQL Server database backup files are now deleted according to the Backups to
keep setting. (SD-1925/40846)
n Database Backup & Archiving. The MongoDB database is now backed up according to backup settings.
(SD-1926/40845)

Property Builder
n Can now select the Text format when creating access points on a single floor after previously selecting multiple
floors. (SD-1723/38812)
n Selected restricted area access points now display in the Summary section. (SD-1908/40649)

Credential Management
n Access points assigned to a credential are listed in the Summary section according to the correct floor.
(SD-1830/39748)

Device Management
n Registered Gateways & Paired Access Points. Online metrics now display as expected.
(SD-1944/SD-1734/38863/40347)
n Registered Gateways & Paired Access Points. Can now select all gateways at once. (SD-1982/40133)

2/3/2023 Ambiance 2
Release Notes Known issues

Programming
n The configuration data for all access points selected for programming can now be transferred
to the Maintenance Unit. (SD-1856/39881)

Guest Registration
n Can now modify and encode guest keys for a guest registration that was recently checked out. (SD-1965/41175)
n Upon modifying a guest registration, the associated mobile keys now display the correct status. (SD-1963/41156)
n Can now issue guest mobile keys after replacement RFID guest keys are encoded. (SD-1961/41155)

Staff Management
n Staff members can now be imported without adding the header row in the source file. (34650)
n Assigned Keys. The correct access information for Toggle Latch/Unlatch, Latch and Unlatch keys now displays.
(SD-1622/37952)

System Keys
n All system keys can now be encoded when sector II (folio) is pre-encoded with third-party data. (SD-1876/40412)
n Failsafe keys now give access to foyer doors as expected. (SD-1899/40562)
n Credentials now load when canceling a key remotely or making an RFID Cancel key. (SD-1997/41797)

Reports
n Access Point Audit Report. An issue causing some reports to fail generation is resolved. (SD-1986/SD-1954/SD-
1914/41519/40703)
n Key/User Assignment Report. All credential classes for which keys have been made are now selectable. The
report includes all selected credential classes. (SD-1623/37954)
n Credential/Access Point Assignment Report. Reports exported to .csv format now display correct information.
(SD-1930/40843)
n Credential/Access Point Assignment Report. The maximum number of report pages is no longer limited to 500.
(40000)
n Key Expiration Report. All credentials are now selectable. (40068)

Monitoring
n Keys. Upon modifying a guest registration, the correct status displays for the associated guest keys.
(SD-1963/41158)

Read Key
n The error when reading some guest keys is now resolved. (SD-1855/40390)
n Reading failsafe keys now displays the correct expiration information. (SD-1782/39325)

Online communication
n The RT+ lock Zigbee firmware can now be upgraded remotely. (40262)
n INTEREL/Telkonet. Remote operation details are now correctly reported for Block, Unblock, Cancel, and
Resequence remote operations in Monitoring/Online/Operations. (37694)

Online help
n The context help can now be scrolled. (SD-1847/39933)

Known issues
This section lists known issues and provides detailed work-around instructions. An internal reference number may
follow the issue description.

Internationalization
n Some strings may appear in English.
n Reports. Upon printing or downloading a report in Chinese, some characters are not displayed correctly.
(34627)

2/3/2023 Ambiance 3
Release Notes Known issues

PMS
n PMS SkyTouch. Key monitoring for additional mobile keys issued through SkyTouch interface display key holder
as “Unknown”. (34790)
View key holder guest name assigned to mobile key in Guest Registration.

System Settings
n Advanced Settings/RFID key types. MIFARE DESFire keys are accepted by access points regardless of the
selected settings. (38314)

Device Management
n There is currently no warning flag displayed when the current Main RAC5 firmware version differs from the
reference version to upgrade. (40278)
Proceed with the remote firmware upgrade.
n Remote firmware upgrade is currently not supported for the RAC5 NFC wall reader. (40276)
Upgrade the RAC5 NFC wall reader with the Maintenance Unit.

n Encoders communicating via TCP/IP takes up to one minute to appear as online after connected/reconnected.
(32936)
n Registered Gateways & Paired Access Points. The registered Saffire DX locks currently display as Saffire LX
locks on the Access Points page. (38741)

Monitoring
n Keys. The operator name is currently not displayed for LGS SOAP API (PMS Web Service) AddSharedGuest
requests. (30784)

Read key
n Upon reading a MIFARE Mini or Ultralight C key, the View Guest Access Report and View Staff Access Report
buttons are available in the Read Key dialog even though these key technologies do not support the guest and
staff access tracking functionality. (35043)
n When the preferred language is Chinese or Japanese, guest key read back lists access points in the Room
access field as date/time format. (SD-2039/42378)
Select an alternate language in Preferences, then read the guest key.

Online communication
n The RAC5-MFC/XT device firmware cannot be upgraded remotely. (40276)
Upgrade device firmware with the Maintenance Unit.
n INNCOM. Upon upgrading Ambiance, the INNCOM proxy server IP address value defined in the VHE
configuration file does not persist. (SD-1610/37861)
1) Stop the VHE Service using the Windows Services Manager.
2) In the \VHE Service\ folder, open the file VHEService.exe.config.
3) Modify the following configuration file key to specify the INNCOM server IP address:
<addkey="ProxyServerIPAddress"value="INNCOM_IP_SERVER"/>
4) Start the VHE Service using the Windows Services Manager.
n Control4. If the LUA driver that commissioned the gateway in Ambiance is deleted, commands to the gateway
sent from Ambiance no longer work. (34961)
Delete the gateway in Device Management/Registered Gateways & Paired Access Points/
Gateways and recommission the Control4 controller.

2/3/2023 Ambiance 4
Release Notes Known issues

n Rx-Link. The “Unpair all access points” and “Unpair access point” commands in Device Management/Registered
Gateways & Paired Access Points /Gateways and Access Points are currently not supported for Rx-Link.
(34900)
To unpair access points, use the “Pairing OFF” key in access points.
n Registered Gateways & Paired Access Points. The Verify Assignment command is currently not supported from
the Gateways page. (32987)
Perform the Verify Assignment command on the desired access points from the Access Points
page.
n Online Access Points Status Report. The report currently displays an error when no access points have yet been
paired. (34012)
Pair at least one access point then generate the report.

Keyscan Aurora and MATRIX

n Remote guest registration modifications in regards to Guest Common Areas are not synchronized to the
Aurora server or MATRIX server. (29933)
Create guest keys to synchronize new Guest Common Area access to the Aurora server or
MATRIX server.

2/3/2023 Ambiance 5
Release Notes Requirements

Requirements
This section lists minimum system, network, device and interface requirements for installing and using Ambiance.
Additional resources may be required based on site configuration and usage.

System requirements
Minimum requirements for the Ambiance server are based on the number of access points. Additional notes are
listed at the end of the table. 1
Ambiance requires a dedicated server.

Server Workstation
Small Medium Large not applicable
≤ 500 access points 500-3k access points ≥ 3k access points

CPU 2GHz/64-bit/4 core 2GHz/64-bit/8 core 2GHz/64-bit/16 core 2GHz/64-bit/dual core

RAM 16 GB or more 16 GB or more 32 GB or more 8GB

Disk Drive 30GB 60GB 100GB 50MB

Free Space 2

Network Gigabit Ethernet - 1Gb/second Gigabit Ethernet - 1Gb/second Gigabit Ethernet - 1Gb/second Gigabit Ethernet -
1Gb/second
Controller

USB 2.0 Required to connect encoder Required to connect encoder Required to connect encoder Required to connect
encoder
Port

Operating n Microsoft Windows Server n Microsoft Windows Server n Microsoft Windows Server n Microsoft Windows
2022/2019/2016 2022/2019/2016 2022/2019/2016 8.1 Pro/Enterprise
System 3 n Microsoft Windows 10 n Microsoft Windows
Pro/Enterprise 4 10 Pro/Enterprise
n Microsoft Windows 11 n Microsoft Windows
Pro/Enterprise 5 11 Pro/Enterprise 5

Database 6 n SQL Server Express n SQL Server Express n SQL Server Express not applicable
2014/2017 /2019 2014/2017/2019 2014/2017 /2019
n SQL Server 2014/2016/2019 n SQL Server 2014/2016/2019 n SQL Server 2014/2016/2019
(recommended) (recommended)

Web Browser 7 n Google Chrome (latest) n Google Chrome (latest) n Google Chrome (latest) n Google Chrome
n Microsoft Edge (latest) n Microsoft Edge (latest) n Microsoft Edge (latest) (latest)
n Microsoft Edge
(latest)

1 Additional recommended hardware for the server includes: UPS Backup, Integrated HD Graphics Card, Keyboard/Mouse.
2 Additional free space may be required depending on database backup and archiving settings.
3 Ambiance is localized for all supported operating systems. Languages: English, German, Spanish, French, Italian, Japanese, Polish,Brazilian
Portuguese, Russian, and Chinese.
4 Windows 10 Pro/Enterprise does not support Online Communication.
5 a) Windows 11 Pro/Enterprise does not support Online Communication. b) TPM (Trusted Platform Module) 2.0 is required to run Windows 11.
6 a) IMPORTANT: Due to SQL Server Express limitatimedium and large deployments. For details, consult Microsoft documentation. b) Microsoft
reports issues that prevent SQL Seons, dormakaba recommends SQL Server Standard for rver from installing successfully on a Domain Controller.
Avoid installing SQL Server on a Domain Controller.
7 Recommended Web browser resolution: 1366 x 768 or greater.

Network requirements
The Property IT is responsible for establishing and maintaining a secure network (Ethernet or WiFi) environment on
which the Ambiance server, workstations, and integrated interfaces are deployed and used.

Deployment on virtual machine

If deploying Ambiance on a cloud VM (virtual machine), a VPN (virtual private network) is required to secure the
communication between the site and cloud VM.

2/3/2023 Ambiance 6
Release Notes Requirements

Communication ports
The following table lists the default Ambiance Server port settings. If you have a firewall, configuration changes
may be required to make ports accessible to the Ambiance Server.

Port Protocol Description

80 HTTP Ambiance Web User Interface

8083/443 HTTPS Ambiance Web User Interface

28000 TCP ENCODER – KABA RFID (TCP/IP)

5120/5121 HTTP/S PMS – LGS REST API (5120 for HTTP/5121 for HTTPS)

8265 TCP PMS – Oracle FIAS

80/443 HTTP/S PMS – LGS SOAP API (80 for HTT P/443 for HTTPS)

9898 HTTP PMS – BART (configurable in PMS.BART.Service.Host.exe.Config)

8264 TCP PMS – SAFLOK IRS

9090 HTTP PMS – LGS REST API (KF2)

5020/5021 TCP PMS – SkyTouch (5020 for HTTP/5021 for HTTPS)

27700 27701 TCP ONLINE – Gateway I, Control 4

28002 TCP ONLINE – Gateway II, RAC5-MFC/XT

23211 TCP ONLINE – INNCOM

Device requirements
This section lists the embedded devices required to use Ambiance and the latest supported firmware versions.
Ambiance is backward compatible with all previous firmware versions.

Encoders
The following table shows the encoders that Ambiance supports and the latest supported firmware version.

KABA RFID 1.012

DORMAKABA RFID ENCODER - GEN II 2.009

Maintenance units
The following table shows the M-Units that Ambiance supports and the latest supported firmware version.
HH6 2.38

2/3/2023 Ambiance 7
Release Notes Requirements

Locks
The following table shows the locks that Ambiance supports and the latest supported firmware versions.

Boot Main Quantum BLE Zigbee AVR

Pixel 08.03.21.4 08.03.21.4 02.06.19.1 1.2.2.0 1.10x/5.13x/6.05x

Quantum 10.14.20.4 10.14.20.4 02.06.19.1 1.2.2.0 1.10x/5.13x/6.05x

MT4 08.03.21.4 08.03.21.4 02.06.19.1 1.2.2.0 1.10x/5.13x/6.05x

Secure Wall 11.05.21.1 11.05.21.1 N/A 1.2.2.0 N/A

Reader
NFC Wall Reader 02.17.21.3 02.17.21.3 N/A 1.2.2.0 N/A

RCU4 08.03.21.4 08.03.21.4 02.06.19.1 1.2.2.0 1.10x/5.13x/6.05x

RT 06.14.18.2 06.14.18.2 N/A 1.2.2.0 1.10x/5.13x

RT+ 02.23.22.4 02.23.22.4 N/A 1.2.2.0 1.10x/5.13x / 6.050

Saffire LX 02.23.22.4 02.23.22.4 N/A 1.2.2.0 5.13x / 6.050

Confidant 09.03.19.2 09.03.19.2 N/A 1.2.2.0 1.10x/5.13x

Confidant NFC 02.23.22.4 02.23.22.4 N/A 1.2.2.0 1.10x/5.13x / 6.050

RAC5 XT/Lite 03.31.21.4 03.31.21.4 N/A 1.2.2.0 N/A

Elevator controllers
The following table shows the elevator controllers that Ambiance supports and the latest supported firmware
versions.

Boot Main Quantum BLE Zigbee

Legacy MFC N/A 0.017 N/A N/A N/A

EMCC N/A 20090929 N/A N/A N/A

MCC 8/12 N/A 0.031398 N/A N/A N/A

ECU/RCU4 08.03.21.4 08.03.21.4 02.06.19.1 1.2.2.0 1.10x

RAC5-MFC 03.31.21.4 03.31.21.4 N/A 1.2.2.0 N/A

Zigbee gateways
The following table shows the Zigbee gateways that Ambiance supports and the latest supported firmware
versions.
Boot Main Quantum BLE Zigbee
Gateway I 0.221 0.221 N/A N/A 1.10x/5.13x

Gateway II 0.019 0.019 N/A N/A 6.05x

Interface requirements
Ambiance supports the following:
n Aurora SDK—v1.0.19 to v1.0.22
n Aurora software—v1.0.19 to v1.0.22
n MATRIX—v3.6.1

2/3/2023 Ambiance 8
Release Notes Requirements

Online communication interfaces and devices

The following table shows the online gateway combinations that Ambiance supports. For example, the Gateway I
device is compatible with other Gateway I devices, RAC5 and MFC elevator controllers, and one third-party
interface.

Gateway I Device Gateway II Device Rx-Link supported RAC5-MFC/XT

supported with supported with with supported with

Gateway I Device ü Not Supported Not Supported ü

Gateway II Device Not Supported ü ü ü
Rx-Link Not Supported ü ü ü
RAC5-MFC ü ü ü ü
RAC5 XT ü ü ü ü
Legacy MFC ü Not Supported Not Supported Not Supported

Third-Party Interfaces (mutually exclusive)

      INNCOM® ü ü ü ü
      INTEREL® ü Not Supported Not Supported Not Supported

      Telkonet® ü Not Supported Not Supported Not Supported

      Control4® ü Not Supported Not Supported Not Supported

Online communication lock support

The following table shows the locks support for online communication.

Gateway II / Rx-Link
Gateway I / Legacy 3rd-Party
Zigbee Gen II Zigbee Gen II
Interfaces (Zigbee Gen I)
Phase 1 Phase 2
Pixel ü ü ü
MT4 ü ü ü
RCU4 ü ü ü
RT ü ü Not Supported

RT+ ü ü ü
Saffire LX ü ü ü
Confidant ü ü Not Supported
Confidant NFC ü ü ü

General Data Protection Regulation (GDPR)

dormakaba’s privacy policy statement can be found on the server at the following location: \Ambiance
Server\GDPR. Clients are encouraged to print a copy of the statement and have it available at your business
premises for reference.

2/3/2023 Ambiance 9
Release Notes Ambiance upgrades

Ambiance upgrades
The following upgrade paths are supported:
n 1.4 and above to 2.9. See item 1 in the pre-upgrade checklist.

Pre-upgrade checklist
1 ¨ IMPORTANT! Server. Check the version of Ambiance. If you are upgrading from version 2.7.1: 
n If 2.7.1 was a fresh (initial) installation, proceed to install 2.9 as usual.
n If 2.7.1 was an upgrade from any previous version, see Upgrades from Ambiance 2.7.1.

2 ¨ IMPORTANT! Server/Client. Verify that all Windows updates are installed.

3 ¨ Server. Take a backup of the database before performing an upgrade. For online systems,
take backups of SQL Server and MongoDB databases.

4 ¨ Server/Client. Perform the installation as a Local Administrator.

5 ¨ Server. Make sure antivirus software is disabled before proceeding with server installation.

6 ¨ Server. If possible, disable Windows Defender for the duration of the installation.

Upgrade process
The upgrade is installed with the same options selected during the initial install.
1. In the dormakaba/Ambiance folder, open the SERVER folder.
2. Double-click AmbianceServer.exe. The installation wizard opens and prepares for setup.
3. On the Welcome page, click Next.
4. On the License Agreement page, accept the terms of the license agreement, then click Next. You can optionally
print the agreement. The upgrade process starts.
5. When prompted, select whether to restart the server. Restart is required to complete the upgrade.

Post-upgrade checklist
1 ¨ Restart the Ambiance Server.
2 ¨ Server. Re-enable antivirus software.
3 ¨ Server. If necessary, re-enable Windows Defender.
4 ¨ Upgrade the Ambiance Client installed on workstations. The server and client versions must
be the same.

Upgrades from version 2.7.1 ...

Use the following procedure to upgrade from version 2.7.1 when 2.7.1 was an upgrade from any previous version: 
1. Uninstall current Ambiance server 2.7.1.10.
2. Uninstall RabbitErlang v3.9.9 or v3.7.14.
3. Open a command prompt as Admin and run the command:
taskkill /F /IM epmd.exe
4. Launch Registry Editor.
a. Go to HKLM\Software\Microsoft\Windows\CurrentVersion\Uninstall, search for "RabbitErlang", and
delete the related registry key.
b. Go to HKLM\Software\Classes\Installer\Products, search for "RabbitErlang", and delete the related
registry key.
5. Delete C:\Program Files\RabbitErlang\*.*.
6. Install Ambiance v2.9.

2/3/2023 Ambiance 10
Release Notes Amendments to Context Help

Amendments to Context Help

RFID key type MIFARE Ultralight C
The maximum supported variable access points for MIFARE Ultralight C is 6 (not zero).

Documentation
These release notes support Ambiance 2.9. The information in these release notes supersedes all other
documentation supporting this release.
The following core documents support this release:
n Ambiance Installation Guide 290-0 PK3701
n Ambiance User Guide 290-0 PK3722

CONFIDENTIAL: This document is proprietary and confidential. No part of this document may be disclosed in any
manner to a third party without the prior written consent of dormakaba.
© dormakaba Canada, 2022, All rights reserved. dormakaba and Ambiance are trademarks of dormakaba Canada.
All other trademarks are property of their respective owners. MIFARE, MIFARE Classic, MIFARE Plus, and MIFARE
Ultralight are registered trademarks of NXP B.V.
Version 290-0 PK3702

2/3/2023 Ambiance 11