Ambiance services

The Windows services that Ambiance installs are set to run at all times regardless of whether the functionality is being used. Ambiance services are organized into the following categories:

  • Core services support basic operations.
  • PMS services support the Ambiance integration with property management systems deployed at the property.
  • Remote lock management services are required for sites that enable online communication.
  • Perimeter access control services support Ambiance integration with Keyscan Aurora and MATRIX.

Core services

The following table describes Ambiance core services.

[Core services]

Name

Port

 Description Impact when not running

Ambiance Server

49999

Manages core operations and coordinates interactions between all services.

Acts as a container service that runs Bus services as parallel tasks. To monitor these services, Ambiance opens a port that has a Web API endpoint.

 Impacts all system functionality.
Ambiance Client

40100

Manages RFID key encoding and reading with USB-connected encoders and Maintenance Unit communication.

Communicates to encoder devices through USB and establishes Web Socket to the Server for communication. Provides two endpoints (Web API and SignalR gateway) to communicate with the user interface and Maintenance Unit devices.

 No RFID encoding and reading using IP connected encoders.
Ambiance API

26265 (HTTP)

443 (HTTPS)

 API gateway to receive messages from the user interface or field gateway services such as DokaClient and HubManagerGateway. Impacts all system functionality.
Ambiance Database Engine

5040?

Manages the storage, retrieval, and organization of data in a structured database format. Impacts all system functionality.
Ambiance Encoder Service

28000 (HTTP, on-premise)

28001 (HTTPS, on-premise)

1883 (cloud)

Handles RFID key encoding and reading operations for IP-connected encoders.

Communicates to encoder devices through TCP/IP and establishes a Web Socket to the Ambiance Server for communication.

 No RFID encoding and reading using IP connected encoders.
MSSQL$AMBIANCE

???

Serves as the database engine supporting the Ambiance database. Impacts all system functionality.
SQLAgent$AMBIANCE

???

Windows service supporting SQL Server. Optional. Disabled by default.
Ambiance MobileKeyDeliveryService

8299?

 Handles Mobile BLE and Apple Wallet key issuance operations initiated via the user interface, LGS SOAP API, LGS REST API, and KF1 and KF2 PMS interfaces. No mobile BLE and Apple Wallet key issuance.
RabbitMQ

5672 (on-premise)

5671 (cloud)

 Principal message broker framework for relaying internal Ambiance Server communication. Impacts all system functionality.
Redis

6379

Data store used to improve internal message broker performance. Impacts all system functionality.
Ambiance Watchdog 9097? Monitors and ensures the proper functioning of all services. No service health monitoring.

PMS services

The following table describes the Ambiance services used to integrate with supported property management systems. Unless otherwise stated, all ports are inbound.

[PMS services]

Name Port Description Impact when not running
Ambiance PMS Agent

9595

9596?

Manages all PMS guest registration and key issuance operations, excluding IRS and PRS.

Serves as WebAPI endpoint and delivers messages from socket service to the Bus.

 No guest registration and key issuance through PMS, excluding IRS and PRS.

Ambiance PMS WS

80 (HTTP, on-premise)
443 (HTTPS, on-premise)

8883 (HTTPS, cloud)

Manages dormakaba LGS SOAP API PMS guest registration and key issuance operations.

TCP listener and provides SOAP for PMS applications.

No guest registration and key issuance through dormakaba LGS SOAP API PMS.
Ambiance PMS LGS REST

5120 for HTTP

5121 for HTTPS

 Manages dormakaba LGS REST API PMS guest registration and key issuance processes. No guest registration and key issuance through dormakaba LGS REST API PMS.
Ambiance PMS REST API 9090 Manages dormakaba LGS REST API (KF2) PMS guest registration and key issuance tasks. No guest registration and key issuance through dormakaba LGS REST API (KF2) PMS
Ambiance PMS BART 9898 Manages dormakaba BART PMS guest registration and key issuance tasks. No guest registration and key issuance through dormakaba BART PMS
Ambiance PMS Skytouch

5020 for HTTP

5021 for HTTPS

 Manages Skytouch PMS guest registration and key issuance processes. No guest registration and key issuance through SkyTouch PMS,
Ambiance PMS IRS PRS Agent 9696

Manages dormakaba IRS and PRS PMS guest registration and key issuance tasks.

Serves as WebAPI endpoint and delivers messages from socket service to the Bus.

 No guest registration or key issuance through dormakaba IRS and PRS PMS.
Ambiance PMS IRS PRS 8264

Manages dormakaba IRS and PRS PMS guest registration and key issuance tasks.

Service has TCP listener to receive messages from PMS applications. Communicates with PMS applications by using RS232 standard.

 No guest registration and key issuance through dormakaba IRS and PRS PMS.
Ambiance PMS FIAS

8265 (HTTP, on-premise)

8883 (HTTPS, cloud)

Manages Oracle FIAS PMS guest registration and key issuance processes.

TCP listener to receive messages from PMS applications.

 No guest registration and key issuance through Oracle FIAS PMS.

Remote lock management services

The following table describes the services that Ambiance uses to support online communication.

[Remote lock management services]

Name Port Description Impact when not running
Ambiance VHE

  • 6099-Web API endpoint to create SignalR proxy gateway.

  • 6007-Endpoint for SOAP for IRMS.

  • 6006/5020-Receives messages from HubGateway.

Manages remote lock management communication through INNCOM, INTEREL, and Telkonet interfaces.

Communicates with the HubGateway service to receive commands from the Ambiance Server. Opens a socket and acts as a proxy for different devices. Serves as Web API endpoint to create SignalR proxy gateway (for monitoring). Serves as endpoint and provides SOAP for IRMS. Opens TCP ports to receive messages from HubGateway.

 No remote lock management communication with INNCOM, Telkonet and INTEREL online backbones.
Ambiance Hub Gateway

27700 or 27000

27701 (outbound)

Manages remote lock management communication for GWYI, GWYII, Control4, and VHE online devices and interfaces.

Gateway I, Control 4 (27701 is the listening port on the hardware) Opens a Web Socket to receive commands from the Ambiance Web API. Opens a TCP port to receive messages from Gateway devices and the VHE service.

No remote lock management with GWYI, GWYII, Control4, INNCOM, Telkonet and INTEREL online backbones.
Ambiance Hub Gateway

28002

Manages remote lock management communication for GWYII and RAC5-MFC/XT.

 No remote lock management with GWYII, RAC5-MFC/XT
Ambiance HubManager 9000

Manages remote lock management communication across all online devices and interfaces.

Manages Gateway devices. Serves as Web API endpoint to receive queries from HubManager gateways. The HubManager service also opens a Web Socket to Ambiance Web API to transfer commands to the HubManager Gateway.

 No remote lock management with all online backbones.
INNCOM 23211 (outbound) Listening port on the INNCOM server.  
MongoDB 27017 A database that stores online-related data. Impacts all online functionality.

Perimeter access control services

The following table describes the Ambiance services used to integrate with dormakaba Keyscan Aurora and MATRIX.

[Third-party software services]

Name Port Description Impact when not running
Ambiance AuroraSync ??? Synchronizes guest and staff credentials with the dormakaba Keyscan Aurora Server to enable perimeter access at Keyscan access points. No credentials synchronized to Aurora impacting guest and staff access on all Keyscan access points.
Ambiance MatrixSync 5030 Synchronizes guest and staff credentials with the dormakaba MATRIX Server to enable perimeter access at MATRIX access points. No credentials synchronized to MATRIX server impacting guest and staff access on all MATRIX access points.