Versions Compared

Old Version 1

changes.mady.by.user Wolfgang Granzer

Saved on

compared with

New Version Current

changes.mady.by.user Wolfgang Granzer

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The NETx Server provides an interface which can be used to integrate information from the hotel management system ProtelVHP. 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 Protel VHP system. This interface for the NETx Server is certified by ProtelVHP. 

The following figure shows how the integration has to be done.

Image RemovedImage Added

The communication between the Protel VHP and the NETx Server is based on TCP/IP. In detail, the Protel the VHP side acts as a TCP server and the NETx Server acts a TCP client. The protocol itself is based on a communication standard called FIAS.

...

To start, open the BMS Studio. First, configure the IP address and port number that you have enter within the web service URL.This can be done by selecting "Driver Configuration" within the menu "Modules" -> "ProtelVHP". If this information is not known, please ask the Protel VHP integrator.

Image RemovedImage Added

Info

In addition the IP address and the port number, there are several configuration options which depend on the IFC settings at the Protel VHP side. Normally, you can leave the default options. If the communication is not working correctly, please ask the Protel VHP integrator whether "LRC" or "Use Ack" option have to be used.

Then, the used hotel rooms have to be defined. This is done within the "Room definitions" within the menu "Modules" -> "Protel VHP". Each definition line corresponds to one room. The first column defines the room name. The room name must be unique and must identically be the name that is used within the Protel VHP system. If you do not know them, please ask the Protel VHP integrator for the room list.

The next two columns "Building Name" and "Floor Name" are used to define an optional structure within the item tree. "Description" is used to provide additional information which is stored within the item property "Description".

Image RemovedImage Added

After having defined all rooms, the NETx Server has to be restarted. Afterwards, the configured devices are shown within the item tree. You will find the items under the sub tree "NETx\XIO\ProtelVHP". 

Image RemovedImage Added

The retrieved information from Protel VHP is stored as Server Items. Here all available Server Items that are available for each room are listed (including their access rights):

  • BuildingNumber
    • String, read only
    • Specified within Room Definitions within NETx Server
  • LevelNumber
    • String, read only
    • Specified within Room Definitions within NETx Server
  • RoomNumber
    • String, read only
    • Specified within Room Definitions within NETx Server. Must be identically with the room number used within Protelwithin VHP
  • Description
    • String, read only
    • Specified within Room Definitions within NETx Server
  • GuestsCount
    • UINT8, read only
    • Amount of guest that are checked in for this room
  • GuestName
    • String, read only
    • Guest name that is received from Protelfrom VHP
  • GuestLanguage
    • String, read only
    • Language code that is received from Protel VHP. E.g. de, en, es, ...
  • GuestVIP
    • UINT8, read only
    • VIP status that is received from Protel
  • RoomCheckedForecast (only available if enabled in "Driver configuration...")
    • Boolean, read only
    • True if there is a forecast check in for this room – False if room not
    • from VHP
  • RoomChecked
    • Boolean, read only
    • True if at least 1 guest is check in this room – False if room is free
  • ClassOfService (read only)
    • UINT8, read only
    • Received from Protel from VHP. 0 (Barred/hotel internal only), 1 (local), 2 (national), 3 (no restrictions)
  • DoNotDisturb 
    • Boolean, read only
    • True if DND is received from Protel  – VHP– False otherwise
  • RoomStatus
    • UINT8, read and writable
    • See table below
  • ClearText
    • String, read and writable
  • GuestArrivalDate
    • DateTime, read only
    • Arrival data and time of guest. Normally this is equal to the checkin data and time. Please keep in mind that Protel VHP is not providing an arrival date before the checkin signal
  • GuestDepartureDate
    • DateTime, read only
    • Scheduled depature data and time of guest.
  • PrinterPort
    • UINT8, read only
  • MessageCount
    • UINT8, read only
    • Amount of messages that are available for this room
  • NextMessage
    • Boolean, write only
    • If set to true, the next message that is queued within the server is shown within the server item "MessageText"
  • MessageText
    • String, read only
    • Last message that was received from Protelfrom VHP
  • GetMessage 
    • Boolean, write only
    • If set to true, all available messages are fetched from Protel VHP and stored within the server. Using the item "NextMessage", these messages can be shown within the item "MessageText"
  • SendMessage 
    • String, read and writable
    • Used to send a message to Protel VHP for this room
  • MessageLightStatus
    • Boolean, write only

Note that this list of data points is fixed by Protel  – VHP– not by the server.

The room status is a very important information which can also be changed from the server side. Protel VHP specifies the following predefined values:

...

These are the predefined room states that are available within Protel VHP. However, it is possible to specify additional room states for additional functionality. For example, further states for "Do not disturb" or "Make up room" can be defined. Using this additional room states, it is possible  to send additional information from the BMS to the Protel the VHP system. A typical use case is to add a KNX switch for DND that sends a user-defined room status (e.g. 7 "DND) to the Protel VHP system. These additional room states have to configured within Protel VHP by the Protel integrator.

Forecast check in

Protel provides the possibility to get the check-in signal before the hotel guest does the real check-in at the hotel reception. If the time interval for this so called "forecast check-in" is set to, for example, 6 hours, this "forecast check in" can be used to enable the HVAC system for the dedicated room in advance. This has the advantage that there is already a comfort room temperature when the guest arrives at his or her room.

In order to use this functionality, the "forecast check-in" has to be enabled within the Protel software. For more information, please contact the Protel technical team.

If the "forecast check in" is enabled at the Protel side, you can enable it with the NETx Server, too. To do so, open the driver configuration menu within the studio and set the option "Enable forecast check-in" to true.

After having restarted the server, you will get for each room two check-in/check-out server items:

  • RoomCheckedForecast: this item changes from false to true, when a "forecast check-in" signal is received from Protel. The time interval for sending it before the real check-in can be set within the Protel system (not within the NETx Server). Obviously, a forecast check-in is only received if there is reservation within Protel. During a check-out, the item changes from true to false.
  • RoomChecked: when there is a real check-in e.g. the hotel guest arrives at the hotel reception for check-in, this item changes from false to true. During a check-out, the item changes from true to false.

VHP integrator.

Adding control functionality

After having configured the Protel VHP interface, the provided data points can be linked to other data points within the server. You can use V-Links, Server Tasks, LUA script or XLogic commands for providing this functionality.

A typical use case would be the mapping of the RoomCheck item from Protel VHP to a data point like the set point or the mode of the room's climate control. For implementing this use case, a predefined XLogic command called "HotelCheckInCheckOut" is already included within the server. Open the XCommand Event Definitions (BMS Studio --> Extensions) and add a new definition line. Give the logic a name (e.g. Room101), select "ON_VALUE_CHANGE" as type and select the XLogic "Hotel.CheckInCheckOut". Within the configuration dialog, select the input item (e.g. NETx\XIO\ProtelVHP\PartA\Floor1\101\RoomChecked) and as output the data point that shall be controlled by the checkin/checkout signal (e.g. KNX group address of the set point of the room). The following screenshot shows an example:

Image RemovedImage Added

Repeat these steps for a hotel rooms. After having finished all definitions, restart the server.

...

  • NETx BMS Platform
  • NETx Multi Protocol ServerNETx BMS Server 2.0