| Table of Contents | ||
|---|---|---|
|
Basic architecture
The NETx Server provides an interface which can be used to integrate information from the hotel management system CharRMS Cloud. Using this interface, information about the check-in/check-out procedure, the hotel guests and the hotel room states can be retrieved. In addition, it is also possible to send dedicated information from the NETx Server to the Char PMS.
The following figure shows how the integration has to be done.
The communication is based on a REST full HTTP web service protocol that is using JSON objects as data payload. The CharPMS RMS Cloud software is the web API client and our NETx Server is the web API server.
...
To start, open the menu Modules > CharPMS > [Live]Driver configuration RMS Cloud > Configuration .... . With the dialog, specify at least the TCP port used for the web API and the security token. Normally, this information is retrieved from the CharPMS integrator. More information about the driver configuration can be found here.
Client ID, the Client Password and the RMS Url.
...
Then, the used properties and areas (hotel rooms) have to be defined. This is done within the " within the menu Modules > CharPMS > [Live] Room RMS Cloud > Property definitions. Each definition line corresponds to one property/area (room. The first column defines the hotel ID – the second column the room number. The hotel ID and the room number must be identically to names used within the CharPMS system. If you do not know them, please ask the CharPMS integrator for the room list. More information about the room definitions can be found here.
).
...
After having defined all rooms, the configured rooms are shown within the item tree. You will find the items under the sub tree NETx\XIO\CharPMSRMS. 
...
The retrieved information from CharPMS the RMS Cloud is stored as Server Items. Here all available Server Items that are available for each room are listed (including their access rights):
Item name | Data type | Access | Notes |
|---|
Description | String | read only | Specified within room Definitions within NETx Server. |
RoomChecked | Boolean | read only | True if at least 1 guest is check in this room – false if all guests are checked out. |
RoomCheckedForecast | Boolean | read only | True if there is a forecast check in for this room – false if all guests are checked out. |
Occupancy status for this room (the following default mapping can be changed here):
- 0: Vacant
- 1: Vacant, guest made checkout today
- 2: Occupied
- 3: Occupied, guest departure is today but checkout was not done yet.
RoomStatus | String | read and write | Room status |
- 0: Clean
- 1: Dirty
- 2: Inspected
This information can also by written by the NETx Server.
GuestName | String | read only | Guest name that is received from RMSCloud. |
GuestTitle | String | read only | Guest |
title that is received |
from RMSCloud. | |||
GuestLanguage | String | read only | Language code that is received from |
RMSCloud. E.g. EN, DE, .. |
. | |||
GuestArrivalDate | DateTime | read only | Arrival data and time of guest. Normally, this is equal to the check-in data and time. |
GuestDepartureDate | DateTime | read only | Scheduled departure data and time of guest. |
Article applies to the following products:
NETx BMS Platform
NETx Multi Protocol Server